1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
# Copyright 2021 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
"""Inclusive language presubmit check."""
import dataclasses
from pathlib import Path
import re
from typing import Dict, List, Union
from . import presubmit, presubmit_context
# List borrowed from Android:
# https://source.android.com/setup/contribute/respectful-code
# inclusive-language: disable
NON_INCLUSIVE_WORDS = [
r'master',
r'slave',
r'red[-\s]?line',
r'(white|gr[ae]y|black)[-\s]*(list|hat)',
r'craz(y|ie)',
r'insane',
r'crip+led?',
r'sanity',
r'sane',
r'dummy',
r'grandfather',
r's?he',
r'his',
r'her',
r'm[ae]n[-\s]*in[-\s]*the[-\s]*middle',
r'mitm',
r'first[-\s]?class[-\s]?citizen',
]
# inclusive-language: enable
# Test: master # inclusive-language: ignore
# Test: master
def _process_inclusive_language(*words):
"""Turn word list into one big regex with common inflections."""
if not words:
words = tuple(NON_INCLUSIVE_WORDS)
all_words = []
for entry in words:
if isinstance(entry, str):
all_words.append(entry)
elif isinstance(entry, (list, tuple)):
all_words.extend(entry)
all_words.extend(x for x in words)
all_words = tuple(all_words)
# Confirm each individual word compiles as a valid regex.
for word in all_words:
_ = re.compile(word)
word_boundary = (
r'(\b|_|(?<=[a-z])(?=[A-Z])|(?<=[0-9])(?=\w)|(?<=\w)(?=[0-9]))'
)
return re.compile(
r"({b})(?i:{w})(e?[sd]{b}|{b})".format(
w='|'.join(all_words), b=word_boundary
),
)
NON_INCLUSIVE_WORDS_REGEX = _process_inclusive_language()
# If seen, ignore this line and the next.
_IGNORE = 'inclusive-language: ignore'
# Ignore a whole section. Please do not change the order of these lines.
_DISABLE = 'inclusive-language: disable'
_ENABLE = 'inclusive-language: enable'
@dataclasses.dataclass
class PathMatch:
word: str
def __repr__(self):
return f'Found non-inclusive word "{self.word}" in file path'
@dataclasses.dataclass
class LineMatch:
line: int
word: str
def __repr__(self):
return f'Found non-inclusive word "{self.word}" on line {self.line}'
@presubmit.check(name='inclusive_language')
def presubmit_check(
ctx: presubmit_context.PresubmitContext,
words_regex=NON_INCLUSIVE_WORDS_REGEX,
):
"""Presubmit check that ensures files do not contain banned words."""
# No subprocesses are run for inclusive_language so don't perform this check
# if dry_run is on.
if ctx.dry_run:
return
found_words: Dict[Path, List[Union[PathMatch, LineMatch]]] = {}
ctx.paths = presubmit_context.apply_exclusions(ctx)
for path in ctx.paths:
match = words_regex.search(str(path.relative_to(ctx.root)))
if match:
found_words.setdefault(path, [])
found_words[path].append(PathMatch(match.group(0)))
if path.is_symlink() or path.is_dir():
continue
try:
with open(path, 'r') as ins:
enabled = True
prev = ''
for i, line in enumerate(ins, start=1):
if _DISABLE in line:
enabled = False
if _ENABLE in line:
enabled = True
# If we see the ignore line on this or the previous line we
# ignore any bad words on this line.
ignored = _IGNORE in prev or _IGNORE in line
if enabled and not ignored:
match = words_regex.search(line)
if match:
found_words.setdefault(path, [])
found_words[path].append(
LineMatch(i, match.group(0))
)
# Not using 'continue' so this line always executes.
prev = line
except UnicodeDecodeError:
# File is not text, like a gif.
pass
if found_words:
with open(ctx.failure_summary_log, 'w') as outs:
for i, (path, matches) in enumerate(found_words.items()):
if i:
print('=' * 40, file=outs)
print(path, file=outs)
for match in matches:
print(match, file=outs)
print(ctx.failure_summary_log.read_text(), end=None)
print()
print(
"""
Individual lines can be ignored with "inclusive-language: ignore". Blocks can be
ignored with "inclusive-language: disable" and reenabled with
"inclusive-language: enable".
""".strip()
)
# Re-enable just in case: inclusive-language: enable.
raise presubmit_context.PresubmitFailure
def inclusive_language_checker(*words):
"""Create banned words checker for the given list of banned words."""
regex = _process_inclusive_language(*words)
def inclusive_language( # pylint: disable=redefined-outer-name
ctx: presubmit_context.PresubmitContext,
):
globals()['inclusive_language'](ctx, regex)
return inclusive_language
|
