Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

👌 IMPROVE: Directive option parsing #796

Merged
merged 1 commit into from
Nov 27, 2023
Merged

Conversation

chrisjsewell
Copy link
Member

@chrisjsewell chrisjsewell commented Jul 27, 2023

Previously, directive options blocks have been parsed using a "full" YAML parser.
This is unnecessary, and problematic since only a mapping of string key to string value is required,
not any of the other YAML constructs; sequences, flow style, anchors, aliases, tags, ...,
It required addition handling of non-string values (failing or converting back to strings),
and could also cause confusion when values were not parsed as strings (see e.g. #712).

This commit, introduces a new "restricted" YAML parser (adapted from pyyaml),
which will maintain back-compatibilty with existing options blocks, but will only parse mappings of string keys to string values (including multi-line strings and comment parsing).
Parsing errors are also improved, by reporting the exact line on which the error occured.

closes #382

@codecov
Copy link

codecov bot commented Jul 27, 2023

Codecov Report

Attention: 46 lines in your changes are missing coverage. Please review.

Comparison is base (1f61fa0) 90.26% compared to head (86dc085) 90.08%.

Files Patch % Lines
myst_parser/parsers/options.py 89.57% 39 Missing ⚠️
myst_parser/parsers/directives.py 88.67% 6 Missing ⚠️
myst_parser/mocking.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #796      +/-   ##
==========================================
- Coverage   90.26%   90.08%   -0.19%     
==========================================
  Files          23       24       +1     
  Lines        2970     3360     +390     
==========================================
+ Hits         2681     3027     +346     
- Misses        289      333      +44     
Flag Coverage Δ
pytests 90.08% <89.27%> (-0.19%) ⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@chrisjsewell chrisjsewell changed the title 👌 Directive option parsing 👌 IMPROVE: Directive option parsing Jul 27, 2023
@chrisjsewell chrisjsewell merged commit e4dddb3 into master Nov 27, 2023
21 checks passed
@chrisjsewell chrisjsewell deleted the option-parsing branch November 27, 2023 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect "line 1, column 1" in an "Invalid options YAML: while parsing a block mapping" error
1 participant