Merge branch 'master' into sync-12.2.0

Author: chrisjsewell

MANIFEST.in

@@ -14,6 +14,7 @@ exclude .circleci
 exclude .circleci/config.yml
 exclude codecov.yml
 exclude .mypy.ini
+exclude profiler.py
 
 include LICENSE
 include LICENSE.markdown-it

docs/other.md

@@ -38,31 +38,29 @@ So, if you decide to use plugins that add extended class syntax or autogeneratin
 
 # Performance
 
-markdown-it-py is the fastest _**CommonMark compliant**_ parser written in python!
-
 You can view our continuous integration benchmarking analysis at: <https://executablebooks.github.io/markdown-it-py/dev/bench/>,
 or you can run it for yourself within the repository:
 
 ```console
 $ tox -e py38-bench-packages -- --benchmark-columns mean,stddev
 
-Name (time in ms)               Mean              StdDev
------------------------------------------------------------------
-test_mistune                 82.0024 (1.0)       10.7779 (1.61)
-test_markdown_it_py         190.9571 (2.33)       6.6946 (1.0)
-test_mistletoe              247.1633 (3.01)      16.3956 (2.45)
-test_commonmark_py          482.6411 (5.89)      67.8219 (10.13)
-test_panflute             1,043.0018 (12.72)    229.1034 (34.22)
-test_pymarkdown             964.6831 (11.76)     77.2787 (11.54)
-test_pymarkdown_extra     1,051.8680 (12.83)     32.2971 (4.82)
------------------------------------------------------------------
+Name (time in ms)             Mean             StdDev
+---------------------------------------------------------------
+test_mistune               70.3272 (1.0)       0.7978 (1.0)
+test_mistletoe            116.0919 (1.65)      6.2870 (7.88)
+test_markdown_it_py       152.9022 (2.17)      4.2988 (5.39)
+test_commonmark_py        326.9506 (4.65)     15.8084 (19.81)
+test_pymarkdown           368.2712 (5.24)      7.5906 (9.51)
+test_pymarkdown_extra     640.4913 (9.11)     15.1769 (19.02)
+test_panflute             678.3547 (9.65)      9.4622 (11.86)
+---------------------------------------------------------------
 ```
 
 As you can see, `markdown-it-py` doesn't pay with speed for it's flexibility.
 
 ```{note}
 `mistune` is not CommonMark compliant, which is what allows for its
 faster parsing, at the expense of issues, for example, with nested inline parsing.
-See [mistletoes's explanation](https://github.com/miyuchina/mistletoe#performance)
+See [mistletoes's explanation](https://github.com/miyuchina/mistletoe/blob/master/performance.md)
 for further details.
 ```

profiler.py

@@ -0,0 +1,19 @@
+"""A script for profiling.
+
+To generate and read results:
+  - `tox -e profile`
+  - `firefox .tox/prof/output.svg`
+"""
+from pathlib import Path
+
+from markdown_it import MarkdownIt
+
+commonmark_spec = (
+    (Path(__file__).parent / "tests" / "test_cmark_spec" / "spec.md")
+    .read_bytes()
+    .decode()
+)
+
+# Run this a few times to emphasize over imports and other overhead above
+for _ in range(10):
+    MarkdownIt().render(commonmark_spec)

setup.cfg

@@ -46,10 +46,10 @@ code_style =
     pre-commit==2.6
 compare =
     commonmark~=0.9.1
-    markdown~=3.2.2
-    mistletoe-ebp~=0.10.0
-    mistune~=0.8.4
-    panflute~=1.12
+    markdown~=3.3.6
+    mistletoe~=0.8.1
+    mistune~=2.0.2
+    panflute~=2.1.3
 linkify =
     linkify-it-py~=1.0
 plugins =
@@ -70,6 +70,8 @@ benchmarking =
     psutil
     pytest
     pytest-benchmark~=3.2
+profiling =
+    gprof2dot
 
 [options.packages.find]
 exclude =

tox.ini

@@ -43,3 +43,16 @@ setenv =
 commands =
     clean: rm -rf docs/_build
     sphinx-build -nW --keep-going -b {posargs:html} docs/ docs/_build/{posargs:html}
+
+[testenv:profile]
+description = run profiler (use e.g. `firefox .tox/prof/output.svg` to open)
+extras = profiling
+allowlist_externals =
+    mkdir
+    dot
+commands =
+    mkdir -p "{toxworkdir}/prof"
+    python -m cProfile -o "{toxworkdir}/prof/output.pstats" profiler.py
+    gprof2dot -f pstats -o "{toxworkdir}/prof/output.dot" "{toxworkdir}/prof/output.pstats"
+    dot -Tsvg -o "{toxworkdir}/prof/output.svg" "{toxworkdir}/prof/output.dot"
+    python -c 'import pathlib; print("profiler svg output under file://\{0\}".format(pathlib.Path(r"{toxworkdir}") / "prof" / "output.svg"))'