👌 IMPROVE: Make Token.attrs a List[Tuple[str, Any]]

[hukkin]

No description provided.

[codecov]

Codecov Report

Merging #102 (1c27822) into master (00a28a6) will increase coverage by 0.12%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #102      +/-   ##
==========================================
+ Coverage   96.38%   96.50%   +0.12%     
==========================================
  Files          72       72              
  Lines        3205     3202       -3     
==========================================
+ Hits         3089     3090       +1     
+ Misses        116      112       -4     

Flag	Coverage Δ
pytests	96.50% <100.00%> (+0.12%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
markdown_it/renderer.py	100.00% <100.00%> (+1.80%)	⬆️
markdown_it/rules_block/list.py	98.84% <100.00%> (ø)
markdown_it/rules_block/table.py	100.00% <100.00%> (ø)
markdown_it/rules_core/linkify.py	98.87% <100.00%> (ø)
markdown_it/rules_inline/autolink.py	96.22% <100.00%> (ø)
markdown_it/rules_inline/image.py	98.86% <100.00%> (ø)
markdown_it/rules_inline/link.py	98.83% <100.00%> (ø)
markdown_it/token.py	94.31% <100.00%> (+2.36%)	⬆️
markdown_it/tree.py	92.98% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 00a28a6...1c27822. Read the comment docs.

[hukkin]

These changes do not break compatibility with mdit-py-plugins, but tests will need to be updated there.

[hukkin]

executablebooks/mdit-py-plugins#6 will fix mdit-py-plugins tests if this is merged.

[hukkin]

This line actually seems to have a bug that we're fixing by using the immutable tuple 😄 Mutating tmpAttrs[i] here will also mutate token.attrs[i] because tmpAttrs is a copy, not a deep copy, of token.attrs.

[hukkin]

Here's the fix in JS markdown-it markdown-it/markdown-it@c9949dd

If we don't end up merging this PR, we should do the same change.

[hukkin]

This fix is now in merged in master of markdown-it-py btw

[hukkin]

In fact, if we want to make Token.attrs even better, we could use a Dict[str, Any] as the underlying structure. Why markdown-it doesn't use an object is exlained here markdown-it/markdown-it#142 (comment) :

Because ordering makes sence for testing, and no needs to care about hacks like "proto" name and so on.

A Python 3.6 OrderedDict or Python 3.7+ dict doesn't suffer from any of the issues why the custom list structure was used for a mapping. Using a dict would likely result in a small performance increase.

[chrisjsewell]

Superseded by #144