Updates find_examples to support alternate docstring style.
#7
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
Now supports docstrings without a line break directly after the triple quotes.
donovandicks
changed the title
find_examples to support alternate docstring style.
samuelcolvin
reviewed
Apr 3, 2023
pytest_examples/find_examples.py
Outdated
| @@ -140,7 +140,7 @@ def find_examples(*paths: str | Path, skip: bool = False) -> Iterable[CodeExampl | |||
| group = uuid4() | |||
| if path.suffix == '.py': | |||
| code = path.read_text('utf-8') | |||
| for m_docstring in re.finditer(r'(^ *)(r?"""\n)(.+?)\1"""', code, flags=re.M | re.S): | |||
| for m_docstring in re.finditer(r'(^ *)(r?"""[^\r\n]*\n)(.+?)\1"""', code, flags=re.M | re.S): | |||
There was a problem hiding this comment.
Suggested change
| for m_docstring in re.finditer(r'(^ *)(r?"""[^\r\n]*\n)(.+?)\1"""', code, flags=re.M | re.S): | |
| for m_docstring in re.finditer(r'(^ *)(r?""".*?\n)(.+?)\1"""', code, flags=re.M | re.S): |
Should work the same.
There was a problem hiding this comment.
Thanks! Updated in 85681d7
Change [\r\n]* to .*?
|
great, thanks. I'll try to do a new release soon. |
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.
Adds support for docstrings without a line break directly after the triple quotes.
I found this plugin and wanted to use it for my own projects but noticed an issue with example discovery when the docstrings have text on the first line following the initial triple quotes like this:
This PR updates the regex in
find_examplesto capture this style of docstring as well as the original. Included updates to tests to capture the change.