[red-knot] Ignore surrounding whitespace when looking for <!-- snapshot-diagnostics --> directives in mdtests
#16380
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…hot-diagnostics -->` directives in mdtests
AlexWaygood
added
testing
AlexWaygood
requested review from
carljm,
MichaReiser and
sharkdp
as code owners
|
BurntSushi
approved these changes
Feb 25, 2025
|
|
||
| while let Some(first) = self.cursor.bump() { | ||
| match first { | ||
| '<' => { | ||
| self.explicit_path = None; | ||
| self.preceding_blank_lines = 0; |
There was a problem hiding this comment.
Hmmm, should these have been removed? I think so, because now when this branch is taken, we either successfully parse an HTML comment (in which case, the previous state should probably be retained) or we report an error. It might be worth an added unit test for this? Although I wonder if it's actually impossible to observe. I'm thinking about something where you have
`some/file/path.py`:
<!-- snapshot-diagnostics -->
```py
print("frob")
```
There was a problem hiding this comment.
Hmm yeah, good question. I think you're right, I think removing these is probably best?
I'm not entirely sure how to easily add a useful unit test for this (and doesn't seem worth spending a lot of time on), but happy to add one as a followup if you can think of something 😄
dcreager
added a commit
that referenced
this pull request
Feb 28, 2025
* main: [red-knot] Switch to a handwritten parser for mdtest error assertions (#16422) [red-knot] Disallow more invalid type expressions (#16427) Bump version to Ruff 0.9.9 (#16434) Check `LinterSettings::preview` for version-related syntax errors (#16429) Avoid caching files with unsupported syntax errors (#16425) Prioritize "bug" label for changelog sections (#16433) [`flake8-copyright`] Add links to applicable options (`CPY001`) (#16421) Fix string-length limit in documentation for PYI054 (#16432) Show version-related syntax errors in the playground (#16419) Allow passing `ParseOptions` to inline tests (#16357) Bump version to 0.9.8 (#16414) [red-knot] Ignore surrounding whitespace when looking for `<!-- snapshot-diagnostics -->` directives in mdtests (#16380) Notify users for invalid client settings (#16361) Avoid indexing the project if `configurationPreference` is `editorOnly` (#16381)
dcreager
added a commit
that referenced
this pull request
Feb 28, 2025
* dcreager/alist-type: Remove unneeded shear override Update property test CI Move alist into red_knot_python_semantic [red-knot] Switch to a handwritten parser for mdtest error assertions (#16422) [red-knot] Disallow more invalid type expressions (#16427) Bump version to Ruff 0.9.9 (#16434) Check `LinterSettings::preview` for version-related syntax errors (#16429) Avoid caching files with unsupported syntax errors (#16425) Prioritize "bug" label for changelog sections (#16433) [`flake8-copyright`] Add links to applicable options (`CPY001`) (#16421) Fix string-length limit in documentation for PYI054 (#16432) Show version-related syntax errors in the playground (#16419) Allow passing `ParseOptions` to inline tests (#16357) Bump version to 0.9.8 (#16414) [red-knot] Ignore surrounding whitespace when looking for `<!-- snapshot-diagnostics -->` directives in mdtests (#16380) Notify users for invalid client settings (#16361) Avoid indexing the project if `configurationPreference` is `editorOnly` (#16381)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Something unfortunate that happened while I was working on #16321 was that I initially added an HMTL comment like this:
...and I failed to notice for quite a while that there where no snapshots being tested for that specific test. (The directive was missing a whitespace between the
<!--opener and the word "snapshot", meaning that mdtest wasn't recognising it as a directive.)This PR changes the parsing of these directives so that whitespace surrounding the phrase "snapshot-diagnostics" is ignored inside HTML comments.
Test Plan
I added a unit test to the
red_knot_testcrate. I also manually verified that if you apply this diff, runningcargo test -p red_knot_python_semanticcreates a new snapshot for you: