-
Notifications
You must be signed in to change notification settings - Fork 80
Add check_escape.py quality checker for issue #149. #193
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dliu04
wants to merge
3
commits into
JabRef:main
Choose a base branch
from
dliu04:issue-149-escape
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
Review hint: Does this PR update existing fetched lists? If yes: Discuss alternatives (no failing PR, just report -> workflow summary; plus report to upstream list provider) |
subhramit
reviewed
Aug 14, 2025
Comment on lines
+35
to
+62
for file in fileNames: | ||
if (file.endswith(".csv")): | ||
# For each .csv file in the folder, open in read mode | ||
with open(PATH_TO_JOURNALS + file, "r", encoding='utf-8', errors='ignore') as f: | ||
for i, line in enumerate(f): | ||
# Look for specific problematic patterns | ||
problematic_patterns = [ | ||
(r'\\c(?![primeyrd])', 'incomplete LaTeX command - should be \\cyr or \\cprime'), | ||
(r'\\p(?!olhk)', 'incomplete LaTeX command - should be \\polhk'), | ||
(r'\\l(?!dots|asp)', 'incomplete LaTeX command'), | ||
(r'\\"[^,"]', 'improper quote escaping'), | ||
(r'\\(?![\\"/nrt$&-]|sp|rm|circledR|cprime|cyr|polhk|cdprime|ldots|lasp)[a-zA-Z]+', 'unknown escape sequence'), | ||
] | ||
|
||
for pattern, description in problematic_patterns: | ||
matches = re.finditer(pattern, line) | ||
for match in matches: | ||
# Skip if we're inside a mathematical expression (between $ signs) | ||
line_before_match = line[:match.start()] | ||
line_after_match = line[match.end():] | ||
dollar_count_before = line_before_match.count('$') | ||
dollar_count_after = line_after_match.count('$') | ||
|
||
# If we have an odd number of $ before and after, we're inside math - allow it | ||
if (dollar_count_before % 2 == 1) and (dollar_count_after % 2 == 1): | ||
continue | ||
|
||
errFileNames.append(file) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
for file in fileNames: | |
if (file.endswith(".csv")): | |
# For each .csv file in the folder, open in read mode | |
with open(PATH_TO_JOURNALS + file, "r", encoding='utf-8', errors='ignore') as f: | |
for i, line in enumerate(f): | |
# Look for specific problematic patterns | |
problematic_patterns = [ | |
(r'\\c(?![primeyrd])', 'incomplete LaTeX command - should be \\cyr or \\cprime'), | |
(r'\\p(?!olhk)', 'incomplete LaTeX command - should be \\polhk'), | |
(r'\\l(?!dots|asp)', 'incomplete LaTeX command'), | |
(r'\\"[^,"]', 'improper quote escaping'), | |
(r'\\(?![\\"/nrt$&-]|sp|rm|circledR|cprime|cyr|polhk|cdprime|ldots|lasp)[a-zA-Z]+', 'unknown escape sequence'), | |
] | |
for pattern, description in problematic_patterns: | |
matches = re.finditer(pattern, line) | |
for match in matches: | |
# Skip if we're inside a mathematical expression (between $ signs) | |
line_before_match = line[:match.start()] | |
line_after_match = line[match.end():] | |
dollar_count_before = line_before_match.count('$') | |
dollar_count_after = line_after_match.count('$') | |
# If we have an odd number of $ before and after, we're inside math - allow it | |
if (dollar_count_before % 2 == 1) and (dollar_count_after % 2 == 1): | |
continue | |
errFileNames.append(file) | |
for fileName in fileNames: | |
if (fileName.endswith(".csv")): | |
# For each .csv file in the folder, open in read mode | |
with open(PATH_TO_JOURNALS + fileName, "r", encoding='utf-8', errors='ignore') as f: | |
for i, line in enumerate(f): | |
# Look for specific problematic patterns | |
problematic_patterns = [ | |
(r'\\c(?![primeyrd])', 'incomplete LaTeX command - should be \\cyr or \\cprime'), | |
(r'\\p(?!olhk)', 'incomplete LaTeX command - should be \\polhk'), | |
(r'\\l(?!dots|asp)', 'incomplete LaTeX command'), | |
(r'\\"[^,"]', 'improper quote escaping'), | |
(r'\\(?![\\"/nrt$&-]|sp|rm|circledR|cprime|cyr|polhk|cdprime|ldots|lasp)[a-zA-Z]+', 'unknown escape sequence'), | |
] | |
for pattern, description in problematic_patterns: | |
matches = re.finditer(pattern, line) | |
for match in matches: | |
# Skip if we're inside a mathematical expression (between $ signs) | |
line_before_match = line[:match.start()] | |
line_after_match = line[match.end():] | |
dollar_count_before = line_before_match.count('$') | |
dollar_count_after = line_after_match.count('$') | |
# If we have an odd number of $ before and after, we're inside math - allow it | |
if (dollar_count_before % 2 == 1) and (dollar_count_after % 2 == 1): | |
continue | |
errFileNames.append(fileName) |
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.
Implements check_escape.py script to detect "Wrong escape" issues as specified in GitHub issue #149. The script identifies: