Cleanup the regex used for doc preprocessing #36648
Merged
Conversation
This file contains hidden or 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
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
Rocketknight1
force-pushed
the
fix-doc-preprocess
branch
2 times, most recently
from
fd58c65 to
1e2d691
Compare
Rocketknight1
force-pushed
the
fix-doc-preprocess
branch
from
1e2d691 to
d42dc0a
Compare
Rocketknight1
requested review from
ydshieh
and removed request for
ArthurZucker
Member
Author
|
cc @ydshieh for review as the original author (I think!) of the function |
ydshieh
approved these changes
Mar 13, 2025
Collaborator
ydshieh
left a comment
ydshieh
left a comment
There was a problem hiding this comment.
Thanks a lot. My brain is broken every time I see such regex ....
(I'm not the author of this, my previous PR just reverted a previously reverted PR)
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.
We had an overly-complex regex designed to capture docstrings, and as a result it has potentially exponential runtime for malicious inputs. This PR makes the following simplifying changes:
re.compilewithout saving the compiled object are removed - these only hurt performance (see note)re.MULTILINEwas removed because this only affects the behaviour of^and$characters, which are not used in this regexre.DOTALLallows.*?to go through newlinescc @Michellehbn!