You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

306 lines
18 KiB

5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
  1. #!/usr/bin/env node
  2. // Usage: node test.js
  3. // Script that creates index.html out of web/template.html and README.md.
  4. // It is written in JS because this code used to be executed on the client side.
  5. // To install dependencies run:
  6. // $ npm install -g jsdom jquery showdown highlightjs
  7. // If running on mac and modules cant be found after instalation add:
  8. // export NODE_PATH=/usr/local/lib/node_modules
  9. // to the ~/.bash_profile or ~/.bashrc file and run '$ bash'.
  10. const fs = require('fs');
  11. const jsdom = require('jsdom');
  12. const showdown = require('showdown');
  13. const hljs = require('highlightjs');
  14. const TOC =
  15. '<br>' +
  16. '<h2 id="toc">Contents</h2>\n' +
  17. '<pre><code class="hljs bash"><strong>ToC</strong> = {\n' +
  18. ' <strong><span class="hljs-string">\'1. Collections\'</span></strong>: [<a href="#list">List</a>, <a href="#dictionary">Dictionary</a>, <a href="#set">Set</a>, <a href="#tuple">Tuple</a>, <a href="#range">Range</a>, <a href="#enumerate">Enumerate</a>, <a href="#iterator">Iterator</a>, <a href="#generator">Generator</a>],\n' +
  19. ' <strong><span class="hljs-string">\'2. Types\'</span></strong>: [<a href="#type">Type</a>, <a href="#string">String</a>, <a href="#regex">Regular_Exp</a>, <a href="#format">Format</a>, <a href="#numbers">Numbers</a>, <a href="#combinatorics">Combinatorics</a>, <a href="#datetime">Datetime</a>],\n' +
  20. ' <strong><span class="hljs-string">\'3. Syntax\'</span></strong>: [<a href="#arguments">Args</a>, <a href="#inline">Inline</a>, <a href="#closure">Closure</a>, <a href="#decorator">Decorator</a>, <a href="#class">Class</a>, <a href="#ducktypes">Duck_Types</a>, <a href="#enum">Enum</a>, <a href="#exceptions">Exceptions</a>],\n' +
  21. ' <strong><span class="hljs-string">\'4. System\'</span></strong>: [<a href="#print">Print</a>, <a href="#input">Input</a>, <a href="#commandlinearguments">Command_Line_Arguments</a>, <a href="#open">Open</a>, <a href="#path">Path</a>, <a href="#commandexecution">Command_Execution</a>],\n' +
  22. ' <strong><span class="hljs-string">\'5. Data\'</span></strong>: [<a href="#csv">CSV</a>, <a href="#json">JSON</a>, <a href="#pickle">Pickle</a>, <a href="#sqlite">SQLite</a>, <a href="#bytes">Bytes</a>, <a href="#struct">Struct</a>, <a href="#array">Array</a>, <a href="#memoryview">MemoryView</a>, <a href="#deque">Deque</a>],\n' +
  23. ' <strong><span class="hljs-string">\'6. Advanced\'</span></strong>: [<a href="#threading">Threading</a>, <a href="#introspection">Introspection</a>, <a href="#metaprograming">Metaprograming</a>, <a href="#operator">Operator</a>, <a href="#eval">Eval</a>, <a href="#coroutine">Coroutine</a>],\n' +
  24. ' <strong><span class="hljs-string">\'7. Libraries\'</span></strong>: [<a href="#progressbar">Progress_Bar</a>, <a href="#plot">Plot</a>, <a href="#table">Table</a>, <a href="#curses">Curses</a>, <a href="#logging">Logging</a>, <a href="#scraping">Scraping</a>, <a href="#web">Web</a>, <a href="#profile">Profile</a>,\n' +
  25. ' <a href="#numpy">NumPy</a>, <a href="#image">Image</a>, <a href="#audio">Audio</a>]\n' +
  26. '}\n' +
  27. '</code></pre>\n';
  28. const DIAGRAM_1_A =
  29. '+---------+-------------+\n' +
  30. '| Classes | Metaclasses |\n' +
  31. '+---------+-------------|\n' +
  32. '| MyClass > MyMetaClass |\n' +
  33. '| | v |\n' +
  34. '| object ---> type <+ |\n' +
  35. '| | ^ +---+ |\n' +
  36. '| str -------+ |\n' +
  37. '+---------+-------------+\n';
  38. const DIAGRAM_1_B =
  39. '┏━━━━━━━━━┯━━━━━━━━━━━━━┓\n' +
  40. '┃ Classes │ Metaclasses ┃\n' +
  41. '┠─────────┼─────────────┨\n' +
  42. '┃ MyClass → MyMetaClass ┃\n' +
  43. '┃ │ ↓ ┃\n' +
  44. '┃ object ───→ type ←╮ ┃\n' +
  45. '┃ │ ↑ ╰───╯ ┃\n' +
  46. '┃ str ───────╯ ┃\n' +
  47. '┗━━━━━━━━━┷━━━━━━━━━━━━━┛\n';
  48. const DIAGRAM_2_A =
  49. '+---------+-------------+\n' +
  50. '| Classes | Metaclasses |\n' +
  51. '+---------+-------------|\n' +
  52. '| MyClass | MyMetaClass |\n' +
  53. '| v | v |\n' +
  54. '| object <--- type |\n' +
  55. '| ^ | |\n' +
  56. '| str | |\n' +
  57. '+---------+-------------+\n';
  58. const DIAGRAM_2_B =
  59. '┏━━━━━━━━━┯━━━━━━━━━━━━━┓\n' +
  60. '┃ Classes │ Metaclasses ┃\n' +
  61. '┠─────────┼─────────────┨\n' +
  62. '┃ MyClass │ MyMetaClass ┃\n' +
  63. '┃ ↓ │ ↓ ┃\n' +
  64. '┃ object ←─── type ┃\n' +
  65. '┃ ↑ │ ┃\n' +
  66. '┃ str │ ┃\n' +
  67. '┗━━━━━━━━━┷━━━━━━━━━━━━━┛\n';
  68. const DIAGRAM_3_A =
  69. '+------------------+----------+------------+----------+\n' +
  70. '| | Sequence | Collection | Iterable |\n' +
  71. '+------------------+----------+------------+----------+\n' +
  72. '| list, range, str | yes | yes | yes |\n' +
  73. '| dict, set | | yes | yes |\n' +
  74. '| iter | | | yes |\n' +
  75. '+------------------+----------+------------+----------+\n';
  76. const DIAGRAM_3_B =
  77. '┏━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━┓\n' +
  78. '┃ │ Sequence │ Collection │ Iterable ┃\n' +
  79. '┠──────────────────┼──────────┼────────────┼──────────┨\n' +
  80. '┃ list, range, str │ ✓ │ ✓ │ ✓ ┃\n' +
  81. '┃ dict, set │ │ ✓ │ ✓ ┃\n' +
  82. '┃ iter │ │ │ ✓ ┃\n' +
  83. '┗━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━┛\n';
  84. const DIAGRAM_4_A =
  85. '+--------------------+----------+----------+------+---------+--------+\n' +
  86. '| | Integral | Rational | Real | Complex | Number |\n' +
  87. '+--------------------+----------+----------+------+---------+--------+\n' +
  88. '| int | yes | yes | yes | yes | yes |\n' +
  89. '| fractions.Fraction | | yes | yes | yes | yes |\n' +
  90. '| float | | | yes | yes | yes |\n' +
  91. '| complex | | | | yes | yes |\n' +
  92. '+--------------------+----------+----------+------+---------+--------+\n';
  93. const DIAGRAM_4_B =
  94. '┏━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━┯━━━━━━━━━┯━━━━━━━━┓\n' +
  95. '┃ │ Integral │ Rational │ Real │ Complex │ Number ┃\n' +
  96. '┠────────────────────┼──────────┼──────────┼──────┼─────────┼────────┨\n' +
  97. '┃ int │ ✓ │ ✓ │ ✓ │ ✓ │ ✓ ┃\n' +
  98. '┃ fractions.Fraction │ │ ✓ │ ✓ │ ✓ │ ✓ ┃\n' +
  99. '┃ float │ │ │ ✓ │ ✓ │ ✓ ┃\n' +
  100. '┃ complex │ │ │ │ ✓ │ ✓ ┃\n' +
  101. '┗━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━┷━━━━━━━━━┷━━━━━━━━┛\n';
  102. const DIAGRAM_5_A =
  103. "+----------------+----------------+---------------+----------------+-----------------+\n" +
  104. "| | {<float>} | {<float>:f} | {<float>:e} | {<float>:%} |\n" +
  105. "+----------------+----------------+---------------+----------------+-----------------+\n" +
  106. "| 0.000056789 | '5.6789e-05' | '0.000057' | '5.678900e-05' | '0.005679%' |\n" +
  107. "| 0.00056789 | '0.00056789' | '0.000568' | '5.678900e-04' | '0.056789%' |\n" +
  108. "| 0.0056789 | '0.0056789' | '0.005679' | '5.678900e-03' | '0.567890%' |\n" +
  109. "| 0.056789 | '0.056789' | '0.056789' | '5.678900e-02' | '5.678900%' |\n" +
  110. "| 0.56789 | '0.56789' | '0.567890' | '5.678900e-01' | '56.789000%' |\n" +
  111. "| 5.6789 | '5.6789' | '5.678900' | '5.678900e+00' | '567.890000%' |\n" +
  112. "| 56.789 | '56.789' | '56.789000' | '5.678900e+01' | '5678.900000%' |\n" +
  113. "| 567.89 | '567.89' | '567.890000' | '5.678900e+02' | '56789.000000%' |\n" +
  114. "+----------------+----------------+---------------+----------------+-----------------+\n";
  115. const DIAGRAM_5_B =
  116. "┏━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━┓\n" +
  117. "┃ │ {<float>} │ {<float>:f} │ {<float>:e} │ {<float>:%} ┃\n" +
  118. "┠────────────────┼────────────────┼───────────────┼────────────────┼─────────────────┨\n" +
  119. "┃ 0.000056789 │ '5.6789e-05' │ '0.000057' │ '5.678900e-05' │ '0.005679%' ┃\n" +
  120. "┃ 0.00056789 │ '0.00056789' │ '0.000568' │ '5.678900e-04' │ '0.056789%' ┃\n" +
  121. "┃ 0.0056789 │ '0.0056789' │ '0.005679' │ '5.678900e-03' │ '0.567890%' ┃\n" +
  122. "┃ 0.056789 │ '0.056789' │ '0.056789' │ '5.678900e-02' │ '5.678900%' ┃\n" +
  123. "┃ 0.56789 │ '0.56789' │ '0.567890' │ '5.678900e-01' │ '56.789000%' ┃\n" +
  124. "┃ 5.6789 │ '5.6789' │ '5.678900' │ '5.678900e+00' │ '567.890000%' ┃\n" +
  125. "┃ 56.789 │ '56.789' │ '56.789000' │ '5.678900e+01' │ '5678.900000%' ┃\n" +
  126. "┃ 567.89 │ '567.89' │ '567.890000' │ '5.678900e+02' │ '56789.000000%' ┃\n" +
  127. "┗━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━┛\n";
  128. const DIAGRAM_6_A =
  129. "+----------------+----------------+---------------+----------------+-----------------+\n" +
  130. "| | {<float>:.2} | {<float>:.2f} | {<float>:.2e} | {<float>:.2%} |\n" +
  131. "+----------------+----------------+---------------+----------------+-----------------+\n" +
  132. "| 0.000056789 | '5.7e-05' | '0.00' | '5.68e-05' | '0.01%' |\n" +
  133. "| 0.00056789 | '0.00057' | '0.00' | '5.68e-04' | '0.06%' |\n" +
  134. "| 0.0056789 | '0.0057' | '0.01' | '5.68e-03' | '0.57%' |\n" +
  135. "| 0.056789 | '0.057' | '0.06' | '5.68e-02' | '5.68%' |\n" +
  136. "| 0.56789 | '0.57' | '0.57' | '5.68e-01' | '56.79%' |\n" +
  137. "| 5.6789 | '5.7' | '5.68' | '5.68e+00' | '567.89%' |\n" +
  138. "| 56.789 | '5.7e+01' | '56.79' | '5.68e+01' | '5678.90%' |\n" +
  139. "| 567.89 | '5.7e+02' | '567.89' | '5.68e+02' | '56789.00%' |\n" +
  140. "+----------------+----------------+---------------+----------------+-----------------+\n";
  141. const DIAGRAM_6_B =
  142. "┏━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━┓\n" +
  143. "┃ │ {<float>:.2} │ {<float>:.2f} │ {<float>:.2e} │ {<float>:.2%} ┃\n" +
  144. "┠────────────────┼────────────────┼───────────────┼────────────────┼─────────────────┨\n" +
  145. "┃ 0.000056789 │ '5.7e-05' │ '0.00' │ '5.68e-05' │ '0.01%' ┃\n" +
  146. "┃ 0.00056789 │ '0.00057' │ '0.00' │ '5.68e-04' │ '0.06%' ┃\n" +
  147. "┃ 0.0056789 │ '0.0057' │ '0.01' │ '5.68e-03' │ '0.57%' ┃\n" +
  148. "┃ 0.056789 │ '0.057' │ '0.06' │ '5.68e-02' │ '5.68%' ┃\n" +
  149. "┃ 0.56789 │ '0.57' │ '0.57' │ '5.68e-01' │ '56.79%' ┃\n" +
  150. "┃ 5.6789 │ '5.7' │ '5.68' │ '5.68e+00' │ '567.89%' ┃\n" +
  151. "┃ 56.789 │ '5.7e+01' │ '56.79' │ '5.68e+01' │ '5678.90%' ┃\n" +
  152. "┃ 567.89 │ '5.7e+02' │ '567.89' │ '5.68e+02' │ '56789.00%' ┃\n" +
  153. "┗━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━┛\n";
  154. const DIAGRAM_7_A =
  155. '+------------+----------+------------+----------+--------------+\n' +
  156. '| | Iterable | Collection | Sequence | abc.Sequence |\n' +
  157. '+------------+----------+------------+----------+--------------+\n' +
  158. '| iter() | REQ | REQ | yes | yes |\n' +
  159. '| contains() | yes | yes | yes | yes |\n' +
  160. '| len() | | REQ | REQ | REQ |\n' +
  161. '| getitem() | | | REQ | REQ |\n' +
  162. '| reversed() | | | yes | yes |\n' +
  163. '| index() | | | | yes |\n' +
  164. '| count() | | | | yes |\n' +
  165. '+------------+----------+------------+----------+--------------+\n';
  166. const DIAGRAM_7_B =
  167. '┏━━━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━━━━━┓\n' +
  168. '┃ │ Iterable │ Collection │ Sequence │ abc.Sequence ┃\n' +
  169. '┠────────────┼──────────┼────────────┼──────────┼──────────────┨\n' +
  170. '┃ iter() │ ! │ ! │ ✓ │ ✓ ┃\n' +
  171. '┃ contains() │ ✓ │ ✓ │ ✓ │ ✓ ┃\n' +
  172. '┃ len() │ │ ! │ ! │ ! ┃\n' +
  173. '┃ getitem() │ │ │ ! │ ! ┃\n' +
  174. '┃ reversed() │ │ │ ✓ │ ✓ ┃\n' +
  175. '┃ index() │ │ │ │ ✓ ┃\n' +
  176. '┃ count() │ │ │ │ ✓ ┃\n' +
  177. '┗━━━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━━━━━┛\n';
  178. function main() {
  179. const html = getMd();
  180. initDom(html);
  181. modifyPage();
  182. const template = readFile('web/template.html');
  183. const tokens = template.split('<div id=main_container></div>');
  184. const text = `${tokens[0]} ${document.body.innerHTML} ${tokens[1]}`;
  185. writeToFile('index.html', text);
  186. }
  187. function initDom(html) {
  188. const { JSDOM } = jsdom;
  189. const dom = new JSDOM(html);
  190. const $ = (require('jquery'))(dom.window);
  191. global.$ = $;
  192. global.document = dom.window.document;
  193. }
  194. function getMd() {
  195. var readme = readFile('README.md');
  196. // readme = switchClassDiagrams(readme);
  197. const converter = new showdown.Converter();
  198. return converter.makeHtml(readme);
  199. }
  200. function switchClassDiagrams(readme) {
  201. readme = readme.replace(DIAGRAM_1_A, DIAGRAM_1_B);
  202. readme = readme.replace(DIAGRAM_2_A, DIAGRAM_2_B);
  203. readme = readme.replace(DIAGRAM_3_A, DIAGRAM_3_B);
  204. readme = readme.replace(DIAGRAM_4_A, DIAGRAM_4_B);
  205. readme = readme.replace(DIAGRAM_5_A, DIAGRAM_5_B);
  206. readme = readme.replace(DIAGRAM_6_A, DIAGRAM_6_B);
  207. readme = readme.replace(DIAGRAM_7_A, DIAGRAM_7_B);
  208. return readme
  209. }
  210. function modifyPage() {
  211. removeOrigToc();
  212. addToc();
  213. insertLinks();
  214. unindentBanner();
  215. highlightCode();
  216. }
  217. function removeOrigToc() {
  218. const headerContents = $('#contents');
  219. const contentsList = headerContents.next();
  220. headerContents.remove();
  221. contentsList.remove();
  222. }
  223. function addToc() {
  224. const nodes = $.parseHTML(TOC);
  225. $('#main').before(nodes);
  226. }
  227. function insertLinks() {
  228. $('h2').each(function() {
  229. const aId = $(this).attr('id');
  230. const text = $(this).text();
  231. const line = `<a href="#${aId}" name="${aId}">#</a>${text}`;
  232. $(this).html(line);
  233. });
  234. }
  235. function unindentBanner() {
  236. const montyImg = $('img').first();
  237. montyImg.parent().addClass('banner');
  238. const downloadPraragrapth = $('p').first();
  239. downloadPraragrapth.addClass('banner');
  240. }
  241. function highlightCode() {
  242. setApaches(['<D>', '<T>', '<DT>', '<TD>', '<a>', '<n>']);
  243. $('code').not('.python').not('.text').not('.bash').not('.apache').addClass('python');
  244. $('code').each(function(index) {
  245. hljs.highlightBlock(this);
  246. });
  247. fixClasses()
  248. }
  249. function setApaches(elements) {
  250. for (el of elements) {
  251. $(`code:contains(${el})`).addClass('apache');
  252. }
  253. }
  254. function fixClasses() {
  255. // Changes class="hljs-keyword" to class="hljs-title" of 'class' keyword.
  256. $('.hljs-class').filter(':contains(class \')').find(':first-child').removeClass('hljs-keyword').addClass('hljs-title')
  257. }
  258. function readFile(filename) {
  259. try {
  260. return fs.readFileSync(filename, 'utf8');
  261. } catch(e) {
  262. console.error('Error:', e.stack);
  263. }
  264. }
  265. function writeToFile(filename, text) {
  266. try {
  267. return fs.writeFileSync(filename, text, 'utf8');
  268. } catch(e) {
  269. console.error('Error:', e.stack);
  270. }
  271. }
  272. main();