Remove rST-specific code in snippets_test.py #7085
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
A regex in this file (on line 143) triggered a code scan security warning:(https://github.com/quantumlib/Cirq/security/code-scanning/97): ```python def find_rst_code_snippets(content: str) -> List[Tuple[str, int]]: snippets = find_code_snippets( r'\n.. code-block:: python\n(?:\s+:.*?\n)*\n(.*?)(?:\n\S|\Z)', content ``` > This part of the regular expression may cause exponential > backtracking on strings starting with '\naa code-block:: python\n :' > and containing many repetitions of '\n :'. This was in code for testing reStructuredText files. Since we no longer have any `.rst` files in the code base, it seemed more sensible to remove all the rST-specific code in here. Not only does that resolve the code scan warning; it also reduces the maintenance burden going forward.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7085 +/- ##
==========================================
- Coverage 98.18% 98.17% -0.01%
==========================================
Files 1089 1089
Lines 95237 95210 -27
==========================================
- Hits 93508 93474 -34
- Misses 1729 1736 +7 ☔ View full report in Codecov by Sentry. |
BichengYing
pushed a commit
to BichengYing/Cirq
that referenced
this pull request
Jun 20, 2025
A regex in this file (on line 143) triggered a code scan security warning:(https://github.com/quantumlib/Cirq/security/code-scanning/97): ```python def find_rst_code_snippets(content: str) -> List[Tuple[str, int]]: snippets = find_code_snippets( r'\n.. code-block:: python\n(?:\s+:.*?\n)*\n(.*?)(?:\n\S|\Z)', content ``` > This part of the regular expression may cause exponential > backtracking on strings starting with '\naa code-block:: python\n :' > and containing many repetitions of '\n :'. This was in code for testing reStructuredText files. Since we no longer have any `.rst` files in the code base, it seemed more sensible to remove all the rST-specific code in here. Not only does that resolve the code scan warning; it also reduces the maintenance burden going forward.
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.
A regex in this file (on line 143) triggered a code scan security warning:(https://github.com/quantumlib/Cirq/security/code-scanning/97):
This was in code for testing reStructuredText files. Since we no longer have any
.rstfiles in the code base, it seemed more sensible to remove all the rST-specific code in here. Doing that not only resolves the code scan warning – it also reduces the maintenance burden going forward.