mirror of https://github.com/zulip/zulip.git
linter: Move custom_check_file to global namespace.
This is needed in order to mock the method when testing `custom_check.py`. The diff for this commit is a bit broken; all it really does is moving the method out of `build_custom_checkers`.
This commit is contained in:
Robert Hönig
Tim Abbott
parent
7a2234dfa2
commit
b5cf31efdc
|
|
@ -14,95 +14,95 @@ from typing import cast, Any, Callable, Dict, List, Optional, Tuple
|
|||
RuleList = List[Dict[str, Any]] # mypy currently requires Aliases at global scope
|
||||
# https://github.com/python/mypy/issues/3145
|
||||
|
||||
def custom_check_file(fn, identifier, rules, color, skip_rules=None, max_length=None):
|
||||
# type: (str, str, RuleList, str, Optional[Any], Optional[int]) -> bool
|
||||
failed = False
|
||||
|
||||
line_tups = []
|
||||
for i, line in enumerate(open(fn)):
|
||||
line_newline_stripped = line.strip('\n')
|
||||
line_fully_stripped = line_newline_stripped.strip()
|
||||
skip = False
|
||||
for rule in skip_rules or []:
|
||||
if re.match(rule, line):
|
||||
skip = True
|
||||
if line_fully_stripped.endswith(' # nolint'):
|
||||
continue
|
||||
if skip:
|
||||
continue
|
||||
tup = (i, line, line_newline_stripped, line_fully_stripped)
|
||||
line_tups.append(tup)
|
||||
|
||||
rules_to_apply = []
|
||||
fn_dirname = os.path.dirname(fn)
|
||||
for rule in rules:
|
||||
exclude_list = rule.get('exclude', set())
|
||||
if fn in exclude_list or fn_dirname in exclude_list:
|
||||
continue
|
||||
if rule.get("include_only"):
|
||||
found = False
|
||||
for item in rule.get("include_only", set()):
|
||||
if item in fn:
|
||||
found = True
|
||||
if not found:
|
||||
continue
|
||||
rules_to_apply.append(rule)
|
||||
|
||||
for rule in rules_to_apply:
|
||||
exclude_lines = {
|
||||
line for
|
||||
(exclude_fn, line) in rule.get('exclude_line', set())
|
||||
if exclude_fn == fn
|
||||
}
|
||||
|
||||
pattern = rule['pattern']
|
||||
for (i, line, line_newline_stripped, line_fully_stripped) in line_tups:
|
||||
if line_fully_stripped in exclude_lines:
|
||||
exclude_lines.remove(line_fully_stripped)
|
||||
continue
|
||||
try:
|
||||
line_to_check = line_fully_stripped
|
||||
if rule.get('strip') is not None:
|
||||
if rule['strip'] == '\n':
|
||||
line_to_check = line_newline_stripped
|
||||
else:
|
||||
raise Exception("Invalid strip rule")
|
||||
if re.search(pattern, line_to_check):
|
||||
print_err(identifier, color, '{} at {} line {}:'.format(
|
||||
rule['description'], fn, i+1))
|
||||
print_err(identifier, color, line)
|
||||
failed = True
|
||||
except Exception:
|
||||
print("Exception with %s at %s line %s" % (rule['pattern'], fn, i+1))
|
||||
traceback.print_exc()
|
||||
|
||||
if exclude_lines:
|
||||
print('Please remove exclusions for file %s: %s' % (fn, exclude_lines))
|
||||
|
||||
lastLine = None
|
||||
for (i, line, line_newline_stripped, line_fully_stripped) in line_tups:
|
||||
if isinstance(line, bytes):
|
||||
line_length = len(line.decode("utf-8"))
|
||||
else:
|
||||
line_length = len(line)
|
||||
if (max_length is not None and line_length > max_length and
|
||||
'# type' not in line and 'test' not in fn and 'example' not in fn and
|
||||
not re.match("\[[ A-Za-z0-9_:,&()-]*\]: http.*", line) and
|
||||
not re.match("`\{\{ external_api_uri_subdomain \}\}[^`]+`", line) and
|
||||
"#ignorelongline" not in line and 'migrations' not in fn):
|
||||
print("Line too long (%s) at %s line %s: %s" % (len(line), fn, i+1, line_newline_stripped))
|
||||
failed = True
|
||||
lastLine = line
|
||||
|
||||
if lastLine and ('\n' not in lastLine):
|
||||
print("No newline at the end of file. Fix with `sed -i '$a\\' %s`" % (fn,))
|
||||
failed = True
|
||||
|
||||
return failed
|
||||
|
||||
def build_custom_checkers(by_lang):
|
||||
# type: (Dict[str, List[str]]) -> Tuple[Callable[[], bool], Callable[[], bool]]
|
||||
|
||||
def custom_check_file(fn, identifier, rules, color, skip_rules=None, max_length=None):
|
||||
# type: (str, str, RuleList, str, Optional[Any], Optional[int]) -> bool
|
||||
failed = False
|
||||
|
||||
line_tups = []
|
||||
for i, line in enumerate(open(fn)):
|
||||
line_newline_stripped = line.strip('\n')
|
||||
line_fully_stripped = line_newline_stripped.strip()
|
||||
skip = False
|
||||
for rule in skip_rules or []:
|
||||
if re.match(rule, line):
|
||||
skip = True
|
||||
if line_fully_stripped.endswith(' # nolint'):
|
||||
continue
|
||||
if skip:
|
||||
continue
|
||||
tup = (i, line, line_newline_stripped, line_fully_stripped)
|
||||
line_tups.append(tup)
|
||||
|
||||
rules_to_apply = []
|
||||
fn_dirname = os.path.dirname(fn)
|
||||
for rule in rules:
|
||||
exclude_list = rule.get('exclude', set())
|
||||
if fn in exclude_list or fn_dirname in exclude_list:
|
||||
continue
|
||||
if rule.get("include_only"):
|
||||
found = False
|
||||
for item in rule.get("include_only", set()):
|
||||
if item in fn:
|
||||
found = True
|
||||
if not found:
|
||||
continue
|
||||
rules_to_apply.append(rule)
|
||||
|
||||
for rule in rules_to_apply:
|
||||
exclude_lines = {
|
||||
line for
|
||||
(exclude_fn, line) in rule.get('exclude_line', set())
|
||||
if exclude_fn == fn
|
||||
}
|
||||
|
||||
pattern = rule['pattern']
|
||||
for (i, line, line_newline_stripped, line_fully_stripped) in line_tups:
|
||||
if line_fully_stripped in exclude_lines:
|
||||
exclude_lines.remove(line_fully_stripped)
|
||||
continue
|
||||
try:
|
||||
line_to_check = line_fully_stripped
|
||||
if rule.get('strip') is not None:
|
||||
if rule['strip'] == '\n':
|
||||
line_to_check = line_newline_stripped
|
||||
else:
|
||||
raise Exception("Invalid strip rule")
|
||||
if re.search(pattern, line_to_check):
|
||||
print_err(identifier, color, '{} at {} line {}:'.format(
|
||||
rule['description'], fn, i+1))
|
||||
print_err(identifier, color, line)
|
||||
failed = True
|
||||
except Exception:
|
||||
print("Exception with %s at %s line %s" % (rule['pattern'], fn, i+1))
|
||||
traceback.print_exc()
|
||||
|
||||
if exclude_lines:
|
||||
print('Please remove exclusions for file %s: %s' % (fn, exclude_lines))
|
||||
|
||||
lastLine = None
|
||||
for (i, line, line_newline_stripped, line_fully_stripped) in line_tups:
|
||||
if isinstance(line, bytes):
|
||||
line_length = len(line.decode("utf-8"))
|
||||
else:
|
||||
line_length = len(line)
|
||||
if (max_length is not None and line_length > max_length and
|
||||
'# type' not in line and 'test' not in fn and 'example' not in fn and
|
||||
not re.match("\[[ A-Za-z0-9_:,&()-]*\]: http.*", line) and
|
||||
not re.match("`\{\{ external_api_uri_subdomain \}\}[^`]+`", line) and
|
||||
"#ignorelongline" not in line and 'migrations' not in fn):
|
||||
print("Line too long (%s) at %s line %s: %s" % (len(line), fn, i+1, line_newline_stripped))
|
||||
failed = True
|
||||
lastLine = line
|
||||
|
||||
if lastLine and ('\n' not in lastLine):
|
||||
print("No newline at the end of file. Fix with `sed -i '$a\\' %s`" % (fn,))
|
||||
failed = True
|
||||
|
||||
return failed
|
||||
|
||||
# By default, a rule applies to all files within the extension for which it is specified (e.g. all .py files)
|
||||
# There are three operators we can use to manually include or exclude files from linting for a rule:
|
||||
# 'exclude': 'set([<path>, ...])' - if <path> is a filename, excludes that file.
|
||||
|
|
|
|||
Loading…
Reference in New Issue