fix: suppress SyntaxWarnings for invalid escape sequences in docstrings#409
Open
danishashko wants to merge 3 commits intoeliasdabbas:masterfrom
Open
fix: suppress SyntaxWarnings for invalid escape sequences in docstrings#409danishashko wants to merge 3 commits intoeliasdabbas:masterfrom
danishashko wants to merge 3 commits intoeliasdabbas:masterfrom
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #397
Python 3.12 introduced stricter handling of invalid escape sequences in string literals, now emitting
SyntaxWarningfor patterns like\*and\_in docstrings.This PR fixes the three affected files:
robotstxt.py: 8 occurrences of\*in RST table examples showingUser-agent: *wildcard syntaxcrawlytics.py: 6 occurrences of\_in RST bullet list column name prefixes + one\\dcorrected to\dyoutube.py: 2 occurrences of\_in the topic ID reference tableThe fix doubles the backslash in each case (
\*→\*,\_→\_) so the rendered string value stays the same while suppressing the warning.Tested by importing the module under Python 3.12 with
-W error::SyntaxWarning-- no warnings raised after this patch.