Use regex to match overlay annotations #19871
Merged
+3
−3
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
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the detection of overlay[...] annotations by replacing a hard-coded list with a regex-based approach.
- Import and compile a regex pattern to match any
overlay[...]annotation. - Update
has_overlay_annotationsto use the compiled pattern instead of explicit string checks.
Comments suppressed due to low confidence (1)
config/add-overlay-annotations.py:25
- The new regex logic for matching annotations isn’t covered by existing tests. Add unit tests for cases like
overlay[local],overlay[caller?], and lines without annotations to ensure correct behavior.
def has_overlay_annotations(lines):
config/add-overlay-annotations.py
Outdated
| from difflib import context_diff | ||
|
|
||
| OVERLAY_PATTERN = re.compile(r'overlay\[[a-zA-Z0-9?_\\-]+\]') |
There was a problem hiding this comment.
[nitpick] The character class includes an escaped backslash (\\) which isn't needed for matching overlay annotations. Consider simplifying to something like r'overlay\[[A-Za-z0-9?-]+\]' to make the intent clearer.
Suggested change
| OVERLAY_PATTERN = re.compile(r'overlay\[[a-zA-Z0-9?_\\-]+\]') | |
| OVERLAY_PATTERN = re.compile(r'overlay\[[A-Za-z0-9?-]+\]') |
Copilot uses AI. Check for mistakes.
881e465 to
869ba0d
Compare
ginsbach
approved these changes
Jun 25, 2025
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.
No description provided.