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.

575 lines
41 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
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 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
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
4 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 can't be found after installation 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_Type</a>, <a href="#enum">Enum</a>, <a href="#exceptions">Exception</a>],\n' +
  21. ' <strong><span class="hljs-string">\'4. System\'</span></strong>: [<a href="#exit">Exit</a>, <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="#oscommands">OS_Commands</a>],\n' +
  22. ' <strong><span class="hljs-string">\'5. Data\'</span></strong>: [<a href="#json">JSON</a>, <a href="#pickle">Pickle</a>, <a href="#csv">CSV</a>, <a href="#sqlite">SQLite</a>, <a href="#bytes">Bytes</a>, <a href="#struct">Struct</a>, <a href="#array">Array</a>, <a href="#memoryview">Memory_View</a>, <a href="#deque">Deque</a>],\n' +
  23. ' <strong><span class="hljs-string">\'6. Advanced\'</span></strong>: [<a href="#threading">Threading</a>, <a href="#operator">Operator</a>, <a href="#introspection">Introspection</a>, <a href="#metaprograming">Metaprograming</a>, <a href="#eval">Eval</a>, <a href="#coroutines">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="#profiling">Profile</a>,\n' +
  25. ' <a href="#numpy">NumPy</a>, <a href="#image">Image</a>, <a href="#audio">Audio</a>, <a href="#pygame">Games</a>, <a href="#pandas">Data</a>, <a href="#pysimplegui">GUI</a>]\n' +
  26. '}\n' +
  27. '</code></pre>\n';
  28. const OS_RENAME =
  29. 'os.rename(from, to) <span class="hljs-comment"># Renames/moves the file or directory.</span>\n' +
  30. 'os.replace(from, to) <span class="hljs-comment"># Same, but overwrites \'to\' if it exists.</span>\n';
  31. const SHUTIL_COPY =
  32. 'shutil.copy(from, to) <span class="hljs-comment"># Copies the file. \'to\' can exist or be a dir.</span>\n' +
  33. 'shutil.copytree(from, to) <span class="hljs-comment"># Copies the directory. \'to\' must not exist.</span>\n';
  34. const EVAL =
  35. '<span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> ast <span class="hljs-keyword">import</span> literal_eval\n' +
  36. '<span class="hljs-meta">&gt;&gt;&gt; </span>literal_eval(<span class="hljs-string">\'1 + 2\'</span>)\n' +
  37. '<span class="hljs-number">3</span>\n' +
  38. '<span class="hljs-meta">&gt;&gt;&gt; </span>literal_eval(<span class="hljs-string">\'[1, 2, 3]\'</span>)\n' +
  39. '[<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>]\n' +
  40. '<span class="hljs-meta">&gt;&gt;&gt; </span>literal_eval(<span class="hljs-string">\'abs(1)\'</span>)\n' +
  41. 'ValueError: malformed node or string\n';
  42. const LRU_CACHE =
  43. '<span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> lru_cache\n' +
  44. '\n' +
  45. '<span class="hljs-meta">@lru_cache(maxsize=None)</span>\n' +
  46. '<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">fib</span><span class="hljs-params">(n)</span>:</span>\n' +
  47. ' <span class="hljs-keyword">return</span> n <span class="hljs-keyword">if</span> n &lt; <span class="hljs-number">2</span> <span class="hljs-keyword">else</span> fib(n-<span class="hljs-number">2</span>) + fib(n-<span class="hljs-number">1</span>)\n';
  48. const TYPE =
  49. '<code class="python language-python hljs">&lt;class&gt; = type(<span class="hljs-string">\'&lt;class_name&gt;\'</span>, &lt;parents_tuple&gt;, &lt;attributes_dict&gt;)</code>';
  50. const DATACLASS =
  51. '<code class="python language-python hljs"><span class="hljs-keyword">from</span> dataclasses <span class="hljs-keyword">import</span> make_dataclass\n' +
  52. '&lt;class&gt; = make_dataclass(<span class="hljs-string">\'&lt;class_name&gt;\'</span>, &lt;coll_of_attribute_names&gt;)\n' +
  53. '&lt;class&gt; = make_dataclass(<span class="hljs-string">\'&lt;class_name&gt;\'</span>, &lt;coll_of_tuples&gt;)\n' +
  54. '&lt;tuple&gt; = (<span class="hljs-string">\'&lt;attr_name&gt;\'</span>, &lt;type&gt; [, &lt;default_value&gt;])</code>';
  55. const DATETIME =
  56. '<code class="python language-python hljs"><span class="hljs-string">\'&lt;DT&gt; = resolve_imaginary(&lt;DT&gt;)\'</span></code>';
  57. const PYINSTALLER =
  58. '<code class="bash language-bash hljs">$ pip3 install pyinstaller\n' +
  59. '$ pyinstaller script.py <span class="hljs-comment"># Compiles into \'./dist/script\' directory.</span>\n' +
  60. '$ pyinstaller script.py --onefile <span class="hljs-comment"># Compiles into \'./dist/script\' console app.</span>\n' +
  61. '$ pyinstaller script.py --windowed <span class="hljs-comment"># Compiles into \'./dist/script\' windowed app.</span>\n' +
  62. '$ pyinstaller script.py --add-data \'&lt;path&gt;:.\' <span class="hljs-comment"># Adds file to the root of the executable.</span>\n' +
  63. '</code>'
  64. const DIAGRAM_1_A =
  65. '+------------------+------------+------------+------------+\n' +
  66. '| | Sequence | Collection | Iterable |\n' +
  67. '+------------------+------------+------------+------------+\n';
  68. const DIAGRAM_1_B =
  69. '┏━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━┓\n' +
  70. '┃ │ Sequence │ Collection │ Iterable ┃\n' +
  71. '┠──────────────────┼────────────┼────────────┼────────────┨\n' +
  72. '┃ list, range, str │ ✓ │ ✓ │ ✓ ┃\n' +
  73. '┃ dict, set │ │ ✓ │ ✓ ┃\n' +
  74. '┃ iter │ │ │ ✓ ┃\n' +
  75. '┗━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━┛\n';
  76. const DIAGRAM_2_A =
  77. '+--------------------+----------+----------+----------+----------+----------+\n' +
  78. '| | Integral | Rational | Real | Complex | Number |\n' +
  79. '+--------------------+----------+----------+----------+----------+----------+\n';
  80. const DIAGRAM_2_B =
  81. '┏━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━┓\n' +
  82. '┃ │ Integral │ Rational │ Real │ Complex │ Number ┃\n' +
  83. '┠────────────────────┼──────────┼──────────┼──────────┼──────────┼──────────┨\n' +
  84. '┃ int │ ✓ │ ✓ │ ✓ │ ✓ │ ✓ ┃\n' +
  85. '┃ fractions.Fraction │ │ ✓ │ ✓ │ ✓ │ ✓ ┃\n' +
  86. '┃ float │ │ │ ✓ │ ✓ │ ✓ ┃\n' +
  87. '┃ complex │ │ │ │ ✓ │ ✓ ┃\n' +
  88. '┃ decimal.Decimal │ │ │ │ │ ✓ ┃\n' +
  89. '┗━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━┛\n';
  90. const DIAGRAM_3_A =
  91. '+---------------+----------+----------+----------+----------+----------+\n';
  92. const DIAGRAM_3_B =
  93. '┏━━━━━━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━┓\n' +
  94. '┃ │ [ !#$%…] │ [a-zA-Z] │ [¼½¾] │ [²³¹] │ [0-9] ┃\n' +
  95. '┠───────────────┼──────────┼──────────┼──────────┼──────────┼──────────┨\n' +
  96. '┃ isprintable() │ ✓ │ ✓ │ ✓ │ ✓ │ ✓ ┃\n' +
  97. '┃ isalnum() │ │ ✓ │ ✓ │ ✓ │ ✓ ┃\n' +
  98. '┃ isnumeric() │ │ │ ✓ │ ✓ │ ✓ ┃\n' +
  99. '┃ isdigit() │ │ │ │ ✓ │ ✓ ┃\n' +
  100. '┃ isdecimal() │ │ │ │ │ ✓ ┃\n' +
  101. '┗━━━━━━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━┛\n';
  102. const DIAGRAM_4_A =
  103. "+---------------+-----------------+-----------------+-----------------+-----------------+\n" +
  104. "| | {<float>} | {<float>:f} | {<float>:e} | {<float>:%} |\n" +
  105. "+---------------+-----------------+-----------------+-----------------+-----------------+\n";
  106. const DIAGRAM_4_B =
  107. "┏━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━┓\n" +
  108. "┃ │ {&lt;float&gt;} │ {&lt;float&gt;:f} │ {&lt;float&gt;:e} │ {&lt;float&gt;:%} ┃\n" +
  109. "┠───────────────┼─────────────────┼─────────────────┼─────────────────┼─────────────────┨\n" +
  110. "┃ 0.000056789 │ '5.6789e-05' │ '0.000057' │ '5.678900e-05' │ '0.005679%' ┃\n" +
  111. "┃ 0.00056789 │ '0.00056789' │ '0.000568' │ '5.678900e-04' │ '0.056789%' ┃\n" +
  112. "┃ 0.0056789 │ '0.0056789' │ '0.005679' │ '5.678900e-03' │ '0.567890%' ┃\n" +
  113. "┃ 0.056789 │ '0.056789' │ '0.056789' │ '5.678900e-02' │ '5.678900%' ┃\n" +
  114. "┃ 0.56789 │ '0.56789' │ '0.567890' │ '5.678900e-01' │ '56.789000%' ┃\n" +
  115. "┃ 5.6789 │ '5.6789' │ '5.678900' │ '5.678900e+00' │ '567.890000%' ┃\n" +
  116. "┃ 56.789 │ '56.789' │ '56.789000' │ '5.678900e+01' │ '5678.900000%' ┃\n" +
  117. "┃ 567.89 │ '567.89' │ '567.890000' │ '5.678900e+02' │ '56789.000000%' ┃\n" +
  118. "┗━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━┛\n";
  119. const DIAGRAM_5_A =
  120. "+---------------+-----------------+-----------------+-----------------+-----------------+\n" +
  121. "| | {<float>:.2} | {<float>:.2f} | {<float>:.2e} | {<float>:.2%} |\n" +
  122. "+---------------+-----------------+-----------------+-----------------+-----------------+\n";
  123. const DIAGRAM_5_B =
  124. "┏━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━┓\n" +
  125. "┃ │ {&lt;float&gt;:.2} │ {&lt;float&gt;:.2f} │ {&lt;float&gt;:.2e} │ {&lt;float&gt;:.2%} ┃\n" +
  126. "┠───────────────┼─────────────────┼─────────────────┼─────────────────┼─────────────────┨\n" +
  127. "┃ 0.000056789 │ '5.7e-05' │ '0.00' │ '5.68e-05' │ '0.01%' ┃\n" +
  128. "┃ 0.00056789 │ '0.00057' │ '0.00' │ '5.68e-04' │ '0.06%' ┃\n" +
  129. "┃ 0.0056789 │ '0.0057' │ '0.01' │ '5.68e-03' │ '0.57%' ┃\n" +
  130. "┃ 0.056789 │ '0.057' │ '0.06' │ '5.68e-02' │ '5.68%' ┃\n" +
  131. "┃ 0.56789 │ '0.57' │ '0.57' │ '5.68e-01' │ '56.79%' ┃\n" +
  132. "┃ 5.6789 │ '5.7' │ '5.68' │ '5.68e+00' │ '567.89%' ┃\n" +
  133. "┃ 56.789 │ '5.7e+01' │ '56.79' │ '5.68e+01' │ '5678.90%' ┃\n" +
  134. "┃ 567.89 │ '5.7e+02' │ '567.89' │ '5.68e+02' │ '56789.00%' ┃\n" +
  135. "┗━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━┛\n";
  136. const DIAGRAM_6_A =
  137. '+------------+------------+------------+------------+--------------+\n' +
  138. '| | Iterable | Collection | Sequence | abc.Sequence |\n' +
  139. '+------------+------------+------------+------------+--------------+\n';
  140. const DIAGRAM_6_B =
  141. '┏━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━━━┓\n' +
  142. '┃ │ Iterable │ Collection │ Sequence │ abc.Sequence ┃\n' +
  143. '┠────────────┼────────────┼────────────┼────────────┼──────────────┨\n' +
  144. '┃ iter() │ ! │ ! │ ✓ │ ✓ ┃\n' +
  145. '┃ contains() │ ✓ │ ✓ │ ✓ │ ✓ ┃\n' +
  146. '┃ len() │ │ ! │ ! │ ! ┃\n' +
  147. '┃ getitem() │ │ │ ! │ ! ┃\n' +
  148. '┃ reversed() │ │ │ ✓ │ ✓ ┃\n' +
  149. '┃ index() │ │ │ │ ✓ ┃\n' +
  150. '┃ count() │ │ │ │ ✓ ┃\n' +
  151. '┗━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━━━┛\n';
  152. const DIAGRAM_7_A =
  153. 'BaseException\n' +
  154. ' +-- SystemExit';
  155. const DIAGRAM_7_B =
  156. "BaseException\n" +
  157. " ├── SystemExit <span class='hljs-comment'># Raised by the sys.exit() function.</span>\n" +
  158. " ├── KeyboardInterrupt <span class='hljs-comment'># Raised when the user hits the interrupt key (ctrl-c).</span>\n" +
  159. " └── Exception <span class='hljs-comment'># User-defined exceptions should be derived from this class.</span>\n" +
  160. " ├── ArithmeticError <span class='hljs-comment'># Base class for arithmetic errors.</span>\n" +
  161. " │ └── ZeroDivisionError <span class='hljs-comment'># Raised when dividing by zero.</span>\n" +
  162. " ├── AttributeError <span class='hljs-comment'># Raised when an attribute is missing.</span>\n" +
  163. " ├── EOFError <span class='hljs-comment'># Raised by input() when it hits end-of-file condition.</span>\n" +
  164. " ├── LookupError <span class='hljs-comment'># Raised when a look-up on a collection fails.</span>\n" +
  165. " │ ├── IndexError <span class='hljs-comment'># Raised when a sequence index is out of range.</span>\n" +
  166. " │ └── KeyError <span class='hljs-comment'># Raised when a dictionary key or set element is not found.</span>\n" +
  167. " ├── NameError <span class='hljs-comment'># Raised when a variable name is not found.</span>\n" +
  168. " ├── OSError <span class='hljs-comment'># Failures such as “file not found” or “disk full”.</span>\n" +
  169. " │ └── FileNotFoundError <span class='hljs-comment'># When a file or directory is requested but doesn't exist.</span>\n" +
  170. " ├── RuntimeError <span class='hljs-comment'># Raised by errors that don't fall in other categories.</span>\n" +
  171. " │ └── RecursionError <span class='hljs-comment'># Raised when the maximum recursion depth is exceeded.</span>\n" +
  172. " ├── StopIteration <span class='hljs-comment'># Raised by next() when run on an empty iterator.</span>\n" +
  173. " ├── TypeError <span class='hljs-comment'># Raised when an argument is of wrong type.</span>\n" +
  174. " └── ValueError <span class='hljs-comment'># When an argument is of right type but inappropriate value.</span>\n" +
  175. " └── UnicodeError <span class='hljs-comment'># Raised when encoding/decoding strings to/from bytes fails.</span>\n";
  176. const DIAGRAM_8_A =
  177. '+-----------+------------+------------+------------+\n' +
  178. '| | list | dict | set |\n' +
  179. '+-----------+------------+------------+------------+\n';
  180. const DIAGRAM_8_B =
  181. '┏━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━┓\n' +
  182. '┃ │ list │ dict │ set ┃\n' +
  183. '┠───────────┼────────────┼────────────┼────────────┨\n' +
  184. '┃ getitem() │ IndexError │ KeyError │ ┃\n' +
  185. '┃ pop() │ IndexError │ KeyError │ KeyError ┃\n' +
  186. '┃ remove() │ ValueError │ │ KeyError ┃\n' +
  187. '┃ index() │ ValueError │ │ ┃\n' +
  188. '┗━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━┛\n';
  189. const DIAGRAM_9_A =
  190. '+------------------+--------------+--------------+--------------+\n' +
  191. '| | excel | excel-tab | unix |\n' +
  192. '+------------------+--------------+--------------+--------------+\n';
  193. const DIAGRAM_9_B =
  194. "┏━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━┓\n" +
  195. "┃ │ excel │ excel-tab │ unix ┃\n" +
  196. "┠──────────────────┼──────────────┼──────────────┼──────────────┨\n" +
  197. "┃ delimiter │ ',' │ '\\t' │ ',' ┃\n" +
  198. "┃ quotechar │ '\"' │ '\"' │ '\"' ┃\n" +
  199. "┃ doublequote │ True │ True │ True ┃\n" +
  200. "┃ skipinitialspace │ False │ False │ False ┃\n" +
  201. "┃ lineterminator │ '\\r\\n' │ '\\r\\n' │ '\\n' ┃\n" +
  202. "┃ quoting │ 0 │ 0 │ 1 ┃\n" +
  203. "┃ escapechar │ None │ None │ None ┃\n" +
  204. "┗━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━┛\n";
  205. const DIAGRAM_10_A =
  206. '+-------------+-------------+\n' +
  207. '| Classes | Metaclasses |\n' +
  208. '+-------------+-------------|\n' +
  209. '| MyClass --> MyMetaClass |\n';
  210. const DIAGRAM_10_B =
  211. '┏━━━━━━━━━━━━━┯━━━━━━━━━━━━━┓\n' +
  212. '┃ Classes │ Metaclasses ┃\n' +
  213. '┠─────────────┼─────────────┨\n' +
  214. '┃ MyClass ──→ MyMetaClass ┃\n' +
  215. '┃ │ ↓ ┃\n' +
  216. '┃ object ─────→ type ←╮ ┃\n' +
  217. '┃ │ ↑ ╰──╯ ┃\n' +
  218. '┃ str ──────────╯ ┃\n' +
  219. '┗━━━━━━━━━━━━━┷━━━━━━━━━━━━━┛\n';
  220. const DIAGRAM_11_A =
  221. '+-------------+-------------+\n' +
  222. '| Classes | Metaclasses |\n' +
  223. '+-------------+-------------|\n' +
  224. '| MyClass | MyMetaClass |\n';
  225. const DIAGRAM_11_B =
  226. '┏━━━━━━━━━━━━━┯━━━━━━━━━━━━━┓\n' +
  227. '┃ Classes │ Metaclasses ┃\n' +
  228. '┠─────────────┼─────────────┨\n' +
  229. '┃ MyClass │ MyMetaClass ┃\n' +
  230. '┃ ↓ │ ↓ ┃\n' +
  231. '┃ object ←───── type ┃\n' +
  232. '┃ ↑ │ ┃\n' +
  233. '┃ str │ ┃\n' +
  234. '┗━━━━━━━━━━━━━┷━━━━━━━━━━━━━┛\n';
  235. const DIAGRAM_12_A =
  236. '+-----------+-------------+------+-------------+\n' +
  237. '| sampwidth | min | zero | max |\n' +
  238. '+-----------+-------------+------+-------------+\n';
  239. const DIAGRAM_12_B =
  240. '┏━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━┯━━━━━━━━━━━━━┓\n' +
  241. '┃ sampwidth │ min │ zero │ max ┃\n' +
  242. '┠───────────┼─────────────┼──────┼─────────────┨\n' +
  243. '┃ 1 │ 0 │ 128 │ 255 ┃\n' +
  244. '┃ 2 │ -32768 │ 0 │ 32767 ┃\n' +
  245. '┃ 3 │ -8388608 │ 0 │ 8388607 ┃\n' +
  246. '┃ 4 │ -2147483648 │ 0 │ 2147483647 ┃\n' +
  247. '┗━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━┷━━━━━━━━━━━━━┛\n';
  248. const DIAGRAM_13_A =
  249. '| sr.apply(…) | 3 | sum 3 | s 3 |';
  250. const DIAGRAM_13_B =
  251. "┏━━━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┓\n" +
  252. "┃ │ 'sum' │ ['sum'] │ {'s': 'sum'} ┃\n" +
  253. "┠─────────────┼─────────────┼─────────────┼───────────────┨\n" +
  254. "┃ sr.apply(…) │ 3 │ sum 3 │ s 3 ┃\n" +
  255. "┃ sr.agg(…) │ │ │ ┃\n" +
  256. "┗━━━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┛\n";
  257. const DIAGRAM_14_A =
  258. '| sr.apply(…) | | rank | |';
  259. const DIAGRAM_14_B =
  260. "┏━━━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┓\n" +
  261. "┃ │ 'rank' │ ['rank'] │ {'r': 'rank'} ┃\n" +
  262. "┠─────────────┼─────────────┼─────────────┼───────────────┨\n" +
  263. "┃ sr.apply(…) │ │ rank │ ┃\n" +
  264. "┃ sr.agg(…) │ x 1 │ x 1 │ r x 1 ┃\n" +
  265. "┃ sr.trans(…) │ y 2 │ y 2 │ y 2 ┃\n" +
  266. "┗━━━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┛\n";
  267. const DIAGRAM_15_A =
  268. '+------------------------+---------------+------------+------------+--------------------------+';
  269. const DIAGRAM_15_B =
  270. "┏━━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━┓\n" +
  271. "┃ │ 'outer' │ 'inner' │ 'left' │ Description ┃\n" +
  272. "┠────────────────────────┼───────────────┼────────────┼────────────┼──────────────────────────┨\n" +
  273. "┃ l.merge(r, on='y', │ x y z │ x y z │ x y z │ Joins/merges on column. ┃\n" +
  274. "┃ how=…) │ 0 1 2 . │ 3 4 5 │ 1 2 . │ Also accepts left_on and ┃\n" +
  275. "┃ │ 1 3 4 5 │ │ 3 4 5 │ right_on parameters. ┃\n" +
  276. "┃ │ 2 . 6 7 │ │ │ Uses 'inner' by default. ┃\n" +
  277. "┠────────────────────────┼───────────────┼────────────┼────────────┼──────────────────────────┨\n" +
  278. "┃ l.join(r, lsuffix='l', │ x yl yr z │ │ x yl yr z │ Joins/merges on row keys.┃\n" +
  279. "┃ rsuffix='r', │ a 1 2 . . │ x yl yr z │ 1 2 . . │ Uses 'left' by default. ┃\n" +
  280. "┃ how=…) │ b 3 4 4 5 │ 3 4 4 5 │ 3 4 4 5 │ ┃\n" +
  281. "┃ │ c . . 6 7 │ │ │ ┃\n" +
  282. "┠────────────────────────┼───────────────┼────────────┼────────────┼──────────────────────────┨\n" +
  283. "┃ pd.concat([l, r], │ x y z │ y │ │ Adds rows at the bottom. ┃\n" +
  284. "┃ axis=0, │ a 1 2 . │ 2 │ │ Uses 'outer' by default. ┃\n" +
  285. "┃ join=…) │ b 3 4 . │ 4 │ │ By default works the ┃\n" +
  286. "┃ │ b . 4 5 │ 4 │ │ same as `l.append(r)`. ┃\n" +
  287. "┃ │ c . 6 7 │ 6 │ │ ┃\n" +
  288. "┠────────────────────────┼───────────────┼────────────┼────────────┼──────────────────────────┨\n" +
  289. "┃ pd.concat([l, r], │ x y y z │ │ │ Adds columns at the ┃\n" +
  290. "┃ axis=1, │ a 1 2 . . │ x y y z │ │ right end. ┃\n" +
  291. "┃ join=…) │ b 3 4 4 5 │ 3 4 4 5 │ │ Uses 'outer' by default. ┃\n" +
  292. "┃ │ c . . 6 7 │ │ │ ┃\n" +
  293. "┠────────────────────────┼───────────────┼────────────┼────────────┼──────────────────────────┨\n" +
  294. "┃ l.combine_first(r) │ x y z │ │ │ Adds missing rows and ┃\n" +
  295. "┃ │ a 1 2 . │ │ │ columns. ┃\n" +
  296. "┃ │ b 3 4 5 │ │ │ ┃\n" +
  297. "┃ │ c . 6 7 │ │ │ ┃\n" +
  298. "┗━━━━━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━┛\n";
  299. const DIAGRAM_16_A =
  300. '| df.apply(…) | | x y | |';
  301. const DIAGRAM_16_B =
  302. "┏━━━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┓\n" +
  303. "┃ │ 'sum' │ ['sum'] │ {'x': 'sum'} ┃\n" +
  304. "┠─────────────┼─────────────┼─────────────┼───────────────┨\n" +
  305. "┃ df.apply(…) │ │ x y │ ┃\n" +
  306. "┃ df.agg(…) │ x 4 │ sum 4 6 │ x 4 ┃\n" +
  307. "┃ │ y 6 │ │ ┃\n" +
  308. "┗━━━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┛\n";
  309. const DIAGRAM_17_A =
  310. '| df.apply(…) | x y | x y | x |';
  311. const DIAGRAM_17_B =
  312. "┏━━━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┓\n" +
  313. "┃ │ 'rank' │ ['rank'] │ {'x': 'rank'} ┃\n" +
  314. "┠─────────────┼─────────────┼─────────────┼───────────────┨\n" +
  315. "┃ df.apply(…) │ x y │ x y │ x ┃\n" +
  316. "┃ df.agg(…) │ a 1 1 │ rank rank │ a 1 ┃\n" +
  317. "┃ df.trans(…) │ b 2 2 │ a 1 1 │ b 2 ┃\n" +
  318. "┃ │ │ b 2 2 │ ┃\n" +
  319. "┗━━━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┛\n";
  320. const DIAGRAM_18_A =
  321. '| gb.agg(…) | x y | x y | x y | x |';
  322. const DIAGRAM_18_B =
  323. "┏━━━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┓\n" +
  324. "┃ │ 'sum' │ 'rank' │ ['rank'] │ {'x': 'rank'} ┃\n" +
  325. "┠─────────────┼─────────────┼─────────────┼─────────────┼───────────────┨\n" +
  326. "┃ gb.agg(…) │ x y │ x y │ x y │ x ┃\n" +
  327. "┃ │ z │ a 1 1 │ rank rank │ a 1 ┃\n" +
  328. "┃ │ 3 1 2 │ b 1 1 │ a 1 1 │ b 1 ┃\n" +
  329. "┃ │ 6 11 13 │ c 2 2 │ b 1 1 │ c 2 ┃\n" +
  330. "┃ │ │ │ c 2 2 │ ┃\n" +
  331. "┠─────────────┼─────────────┼─────────────┼─────────────┼───────────────┨\n" +
  332. "┃ gb.trans(…) │ x y │ x y │ │ ┃\n" +
  333. "┃ │ a 1 2 │ a 1 1 │ │ ┃\n" +
  334. "┃ │ b 11 13 │ b 1 1 │ │ ┃\n" +
  335. "┃ │ c 11 13 │ c 1 1 │ │ ┃\n" +
  336. "┗━━━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┛\n";
  337. function main() {
  338. const html = getMd();
  339. initDom(html);
  340. modifyPage();
  341. const template = readFile('web/template.html');
  342. const tokens = template.split('<div id=main_container></div>');
  343. const text = `${tokens[0]} ${document.body.innerHTML} ${tokens[1]}`;
  344. writeToFile('index.html', text);
  345. }
  346. function getMd() {
  347. var readme = readFile('README.md');
  348. var readme = readme.replace("#semaphore-event-barrier", "#semaphoreeventbarrier");
  349. const converter = new showdown.Converter();
  350. return converter.makeHtml(readme);
  351. }
  352. function initDom(html) {
  353. const { JSDOM } = jsdom;
  354. const dom = new JSDOM(html);
  355. const $ = (require('jquery'))(dom.window);
  356. global.$ = $;
  357. global.document = dom.window.document;
  358. }
  359. function modifyPage() {
  360. removeOrigToc();
  361. addToc();
  362. insertLinks();
  363. unindentBanner();
  364. updateDiagrams();
  365. highlightCode();
  366. fixPandasDiagram();
  367. removePlotImages();
  368. }
  369. function removeOrigToc() {
  370. const headerContents = $('#contents');
  371. const contentsList = headerContents.next();
  372. headerContents.remove();
  373. contentsList.remove();
  374. }
  375. function addToc() {
  376. const nodes = $.parseHTML(TOC);
  377. $('#main').before(nodes);
  378. }
  379. function insertLinks() {
  380. $('h2').each(function() {
  381. const aId = $(this).attr('id');
  382. const text = $(this).text();
  383. const line = `<a href="#${aId}" name="${aId}">#</a>${text}`;
  384. $(this).html(line);
  385. });
  386. }
  387. function unindentBanner() {
  388. const montyImg = $('img').first();
  389. montyImg.parent().addClass('banner');
  390. const downloadPraragrapth = $('p').first();
  391. downloadPraragrapth.addClass('banner');
  392. }
  393. function updateDiagrams() {
  394. $(`code:contains(${DIAGRAM_1_A})`).html(DIAGRAM_1_B);
  395. $(`code:contains(${DIAGRAM_2_A})`).html(DIAGRAM_2_B);
  396. $(`code:contains(${DIAGRAM_3_A})`).html(DIAGRAM_3_B);
  397. $(`code:contains(${DIAGRAM_4_A})`).html(DIAGRAM_4_B);
  398. $(`code:contains(${DIAGRAM_5_A})`).html(DIAGRAM_5_B);
  399. $(`code:contains(${DIAGRAM_6_A})`).html(DIAGRAM_6_B);
  400. $(`code:contains(${DIAGRAM_7_A})`).html(DIAGRAM_7_B);
  401. $(`code:contains(${DIAGRAM_8_A})`).html(DIAGRAM_8_B);
  402. $(`code:contains(${DIAGRAM_9_A})`).html(DIAGRAM_9_B);
  403. $(`code:contains(${DIAGRAM_10_A})`).html(DIAGRAM_10_B);
  404. $(`code:contains(${DIAGRAM_11_A})`).html(DIAGRAM_11_B);
  405. $(`code:contains(${DIAGRAM_12_A})`).html(DIAGRAM_12_B).removeClass("text").removeClass("language-text").addClass("python");
  406. $(`code:contains(${DIAGRAM_13_A})`).html(DIAGRAM_13_B).removeClass("text").removeClass("language-text").addClass("python");
  407. $(`code:contains(${DIAGRAM_14_A})`).html(DIAGRAM_14_B).removeClass("text").removeClass("language-text").addClass("python");
  408. $(`code:contains(${DIAGRAM_15_A})`).html(DIAGRAM_15_B).removeClass("text").removeClass("language-text").addClass("python");
  409. $(`code:contains(${DIAGRAM_16_A})`).html(DIAGRAM_16_B).removeClass("text").removeClass("language-text").addClass("python");
  410. $(`code:contains(${DIAGRAM_17_A})`).html(DIAGRAM_17_B).removeClass("text").removeClass("language-text").addClass("python");
  411. $(`code:contains(${DIAGRAM_18_A})`).html(DIAGRAM_18_B).removeClass("text").removeClass("language-text").addClass("python");
  412. }
  413. function highlightCode() {
  414. setApaches(['<D>', '<T>', '<DT>', '<TD>', '<a>', '<n>']);
  415. $('code').not('.python').not('.text').not('.bash').not('.apache').addClass('python');
  416. $('code').each(function(index) {
  417. hljs.highlightBlock(this);
  418. });
  419. fixClasses();
  420. fixHighlights();
  421. preventPageBreaks();
  422. fixPageBreaksFile();
  423. fixPageBreaksStruct();
  424. insertPageBreaks();
  425. }
  426. function setApaches(elements) {
  427. for (el of elements) {
  428. $(`code:contains(${el})`).addClass('apache');
  429. }
  430. }
  431. function fixClasses() {
  432. // Changes class="hljs-keyword" to class="hljs-title" of 'class' keyword.
  433. $('.hljs-class').filter(':contains(class \')').find(':first-child').removeClass('hljs-keyword').addClass('hljs-title')
  434. }
  435. function fixHighlights() {
  436. $(`code:contains(os.rename)`).html(OS_RENAME);
  437. $(`code:contains(shutil.copy)`).html(SHUTIL_COPY);
  438. $(`code:contains(ValueError: malformed node)`).html(EVAL);
  439. $(`code:contains(@lru_cache(maxsize=None))`).html(LRU_CACHE);
  440. $(`code:contains(\'<class_name>\', <parents_tuple>, <attributes_dict>)`).html(TYPE);
  441. $(`code:contains(make_dataclass(\'<class_name>\')`).html(DATACLASS);
  442. $(`code:contains((<DT>))`).html(DATETIME);
  443. $(`code:contains(pip3 install pyinstaller)`).html(PYINSTALLER);
  444. }
  445. function preventPageBreaks() {
  446. $(':header').each(function(index) {
  447. var el = $(this)
  448. var untilPre = el.nextUntil('pre')
  449. var untilH2 = el.nextUntil('h2')
  450. if ((untilPre.length < untilH2.length) || el.prop('tagName') === 'H1') {
  451. untilPre.add(el).next().add(el).wrapAll("<div></div>");
  452. } else {
  453. untilH2.add(el).wrapAll("<div></div>");
  454. }
  455. });
  456. }
  457. function fixPageBreaksFile() {
  458. const modesDiv = $('#file').parent().parent().parent()
  459. move(modesDiv, 'file')
  460. move(modesDiv, 'exceptions-1')
  461. }
  462. function fixPageBreaksStruct() {
  463. const formatDiv = $('#floatingpointtypes').parent().parent().parent().parent()
  464. move(formatDiv, 'floatingpointtypes')
  465. move(formatDiv, 'integertypesuseacapitalletterforunsignedtypeminimumandstandardsizesareinbrackets')
  466. move(formatDiv, 'forstandardsizesstartformatstringwith')
  467. }
  468. function move(anchor_el, el_id) {
  469. const el = $('#'+el_id).parent()
  470. anchor_el.after(el)
  471. }
  472. function insertPageBreaks() {
  473. insertPageBreakBefore('#print')
  474. }
  475. function insertPageBreakBefore(an_id) {
  476. $('<div class="pagebreak"></div>').insertBefore($(an_id).parent())
  477. }
  478. function fixPandasDiagram() {
  479. const diagram_15 = '┏━━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━┓';
  480. $(`code:contains(${diagram_15})`).find(".hljs-keyword:contains(and)").after("and");
  481. $(`code:contains(${diagram_15})`).find(".hljs-keyword:contains(as)").after("as");
  482. $(`code:contains(${diagram_15})`).find(".hljs-keyword").remove();
  483. }
  484. function removePlotImages() {
  485. $('img[alt="Covid Deaths"]').remove();
  486. $('img[alt="Covid Cases"]').remove();
  487. }
  488. function readFile(filename) {
  489. try {
  490. return fs.readFileSync(filename, 'utf8');
  491. } catch(e) {
  492. console.error('Error:', e.stack);
  493. }
  494. }
  495. function writeToFile(filename, text) {
  496. try {
  497. return fs.writeFileSync(filename, text, 'utf8');
  498. } catch(e) {
  499. console.error('Error:', e.stack);
  500. }
  501. }
  502. main();