Skip to content

reduce "module_imports_on_top_of_file" execution time by ~20% #1292

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

reduce "module_imports_on_top_of_file" execution time by ~20% #1292

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 21 additions & 14 deletions pycodestyle.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1160,6 +1160,22 @@ def imports_on_separate_lines(logical_line):
yield found, "E401 multiple imports on one line"


_STRING_PREFIXES = frozenset(('u', 'U', 'b', 'B', 'r', 'R'))


def _is_string_literal(line):
if line:
first_char = line[0]
if first_char in _STRING_PREFIXES:
first_char = line[1]
return first_char == '"' or first_char == "'"
return False


_ALLOWED_KEYWORDS_IN_IMPORTS = frozenset([
'try', 'except', 'else', 'finally', 'with', 'if', 'elif'])


@register_check
def module_imports_on_top_of_file(
logical_line, indent_level, checker_state, noqa):
Expand All @@ -1178,33 +1194,24 @@ def module_imports_on_top_of_file(

Okay: if x:\n import os
""" # noqa
def is_string_literal(line):
if line[0] in 'uUbB':
line = line[1:]
if line and line[0] in 'rR':
line = line[1:]
return line and (line[0] == '"' or line[0] == "'")

allowed_keywords = (
'try', 'except', 'else', 'finally', 'with', 'if', 'elif')

if indent_level: # Allow imports in conditional statement/function
return
if not logical_line: # Allow empty lines or comments
return
if noqa:
return
line = logical_line
if line.startswith('import ') or line.startswith('from '):
if logical_line.startswith('import ') or logical_line.startswith('from '):
if checker_state.get('seen_non_imports', False):
yield 0, "E402 module level import not at top of file"
elif re.match(DUNDER_REGEX, line):
elif re.match(DUNDER_REGEX, logical_line):
return
elif any(line.startswith(kw) for kw in allowed_keywords):
elif any(logical_line.startswith(kw)
for kw in _ALLOWED_KEYWORDS_IN_IMPORTS):
# Allow certain keywords intermixed with imports in order to
# support conditional or filtered importing
return
elif is_string_literal(line):
elif _is_string_literal(logical_line):
# The first literal is a docstring, allow it. Otherwise, report
# error.
if checker_state.get('seen_docstring', False):
Expand Down