Skip to content
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.

Sign up for GitHub

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

Update test_enforce_style.py #596

Merged
merged 2 commits into from
Feb 15, 2024
Merged

Update test_enforce_style.py #596

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f021598
Update test_enforce_style.py
bittlingmayer Jan 13, 2024
f0ed9d2
Update test_enforce_style.py
bittlingmayer Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions .github/tests/test_enforce_style.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

from .find_missing_links import walk_directory

# Checks that we use UK spellings for words that differ between the UK and US
# Permits US spellings for proper nouns.

# Load the English language model for Spacy
NLP = spacy.load("en_core_web_sm")
Expand Down Expand Up @@ -53,17 +55,20 @@ def check_spellings(file_path):
# Extract only the letters
raw_word = re.sub(r'^[^a-zA-Z\'-]*|[^a-zA-Z\'-]*$', '', word)

if raw_word:
# Skip words that have the same spelling in both US and UK English or are wrong for both
if ((us.check(raw_word) == uk.check(raw_word)) or (uk.check(raw_word) and not us.check(raw_word))):
continue
# Skip CamelCase and all-uppercase words
if is_camel_case(raw_word) or raw_word.isupper():
continue
# Check if the word is a proper noun in context
assert is_proper_noun_in_context(_line, raw_word), \
f'US-specific spelling: "{raw_word}" in {file_path} \n\n\t at the line: {line} \n\n\tsuggestions: {uk.suggest(raw_word)} \n'
# Skip non-alpha, ALLCAPS and camelCase/CamelCase
if not raw_word or raw_word.isupper() or is_camel_case(raw_word):
continue

# If a US word but not a UK word
if us.check(raw_word) and not uk.check(raw_word):

# Check if the word is a proper noun in context
# This is a relatively expensive check.
assert is_proper_noun_in_context(_line, raw_word), f'''US-specific spelling:
"{ raw_word }" in { file_path }
line: { line }
suggestions: { uk.suggest(raw_word) }
'''

EXCLUDE_DIRS = ['vendor']
EXCLUDE_FILES = ['README.md', 'CHANGELOG.md']
Expand Down