👌 IMPROVE: Fail gracefully on non-dict front-matter

[chrisjsewell]

No description provided.

[codecov]

Codecov Report

Merging #409 (674ab82) into master (5fd4c51) will increase coverage by 0.02%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #409      +/-   ##
==========================================
+ Coverage   90.65%   90.67%   +0.02%     
==========================================
  Files          14       14              
  Lines        1851     1855       +4     
==========================================
+ Hits         1678     1682       +4     
  Misses        173      173              

Flag	Coverage Δ
pytests	90.67% <100.00%> (+0.02%)	⬆️

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

Impacted Files	Coverage Δ
myst_parser/docutils_renderer.py	92.73% <100.00%> (+0.01%)	⬆️
myst_parser/sphinx_renderer.py	93.08% <100.00%> (+0.13%)	⬆️

---

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 5fd4c51...674ab82. Read the comment docs.

[cpitclaudel]

Is this patch actually safe? assert isn't guaranteed to run.

[chrisjsewell]

Yeh that’s why it’s caught by the try/except

[cpitclaudel]

No, I mean assert isn't guaranteed to run (I don't mean to succeed; I mean that Python can skip it entirely if you run MyST with -O). Maybe I'm misunderstanding the point of that test.

[chrisjsewell]

run MyST with -O

can you explain further what you mean by this, and when this would be the case thanks?

[cpitclaudel]

If you run Python with the -O flag, it skips all assertions. This is why AFAIK it's usually not recommended to put stateful code in assertions or to depend on assertions for control flow.

[chrisjsewell]

Thanks for the explanation BTW @cpitclaudel; I'd "heard" that you should not use assert, and usually try to follow that, but didn't actually know why lol.
Out of interest, is there some concrete use-case where one would want to use the -O flag?

[cpitclaudel]

Not too many AFAIK ^^

[chrisjsewell]

ok cheers