| Alphare |
| hg-reviewers |
Since we require Python 3 now, we can assume we always use absolute
imports and the modern import checker should be used.
| No Linters Available |
| No Unit Test Coverage |
| Path | Packages | |||
|---|---|---|---|---|
| M | contrib/import-checker.py (59 lines) |
| Commit | Parents | Author | Summary | Date |
|---|---|---|---|---|
| eb2f67a4a207 | 3658919226f7 | Gregory Szorc | Feb 20 2022, 3:43 PM |
| # Modules that must be aliased because they are commonly confused with | # Modules that must be aliased because they are commonly confused with | ||||
| # common variables and can create aliasing and readability issues. | # common variables and can create aliasing and readability issues. | ||||
| requirealias = { | requirealias = { | ||||
| 'ui': 'uimod', | 'ui': 'uimod', | ||||
| } | } | ||||
| def usingabsolute(root): | |||||
| """Whether absolute imports are being used.""" | |||||
| if sys.version_info[0] >= 3: | |||||
| return True | |||||
| for node in ast.walk(root): | |||||
| if isinstance(node, ast.ImportFrom): | |||||
| if node.module == '__future__': | |||||
| for n in node.names: | |||||
| if n.name == 'absolute_import': | |||||
| return True | |||||
| return False | |||||
| def walklocal(root): | def walklocal(root): | ||||
| """Recursively yield all descendant nodes but not in a different scope""" | """Recursively yield all descendant nodes but not in a different scope""" | ||||
| todo = collections.deque(ast.iter_child_nodes(root)) | todo = collections.deque(ast.iter_child_nodes(root)) | ||||
| yield root, False | yield root, False | ||||
| while todo: | while todo: | ||||
| node = todo.popleft() | node = todo.popleft() | ||||
| newscope = isinstance(node, ast.FunctionDef) | newscope = isinstance(node, ast.FunctionDef) | ||||
| if not newscope: | if not newscope: | ||||
| if modnotfound and dottedpath != modulename: | if modnotfound and dottedpath != modulename: | ||||
| # "dottedpath" is a package, but imported because of non-module | # "dottedpath" is a package, but imported because of non-module | ||||
| # lookup | # lookup | ||||
| # specifically allow "from . import foo" from __init__.py | # specifically allow "from . import foo" from __init__.py | ||||
| yield dottedpath | yield dottedpath | ||||
| def verify_import_convention(module, source, localmods): | def verify_import_convention(module, source, localmods): | ||||
| """Verify imports match our established coding convention. | """Verify imports match our established coding convention.""" | ||||
| We have 2 conventions: legacy and modern. The modern convention is in | |||||
| effect when using absolute imports. | |||||
| The legacy convention only looks for mixed imports. The modern convention | |||||
| is much more thorough. | |||||
| """ | |||||
| root = ast.parse(source) | root = ast.parse(source) | ||||
| absolute = usingabsolute(root) | |||||
| if absolute: | |||||
| return verify_modern_convention(module, root, localmods) | return verify_modern_convention(module, root, localmods) | ||||
| else: | |||||
| return verify_stdlib_on_own_line(root) | |||||
| def verify_modern_convention(module, root, localmods, root_col_offset=0): | def verify_modern_convention(module, root, localmods, root_col_offset=0): | ||||
| """Verify a file conforms to the modern import convention rules. | """Verify a file conforms to the modern import convention rules. | ||||
| The rules of the modern convention are: | The rules of the modern convention are: | ||||
| * Ordering is stdlib followed by local imports. Each group is lexically | * Ordering is stdlib followed by local imports. Each group is lexically | ||||
| yield msg( | yield msg( | ||||
| '%s from %s must be "as" aliased to %s', | '%s from %s must be "as" aliased to %s', | ||||
| n.name, | n.name, | ||||
| fullname, | fullname, | ||||
| requirealias[n.name], | requirealias[n.name], | ||||
| ) | ) | ||||
| def verify_stdlib_on_own_line(root): | |||||
| """Given some python source, verify that stdlib imports are done | |||||
| in separate statements from relative local module imports. | |||||
| >>> list(verify_stdlib_on_own_line(ast.parse('import sys, foo'))) | |||||
| [('mixed imports\\n stdlib: sys\\n relative: foo', 1)] | |||||
| >>> list(verify_stdlib_on_own_line(ast.parse('import sys, os'))) | |||||
| [] | |||||
| >>> list(verify_stdlib_on_own_line(ast.parse('import foo, bar'))) | |||||
| [] | |||||
| """ | |||||
| for node in ast.walk(root): | |||||
| if isinstance(node, ast.Import): | |||||
| from_stdlib = {False: [], True: []} | |||||
| for n in node.names: | |||||
| from_stdlib[n.name in stdlib_modules].append(n.name) | |||||
| if from_stdlib[True] and from_stdlib[False]: | |||||
| yield ( | |||||
| 'mixed imports\n stdlib: %s\n relative: %s' | |||||
| % ( | |||||
| ', '.join(sorted(from_stdlib[True])), | |||||
| ', '.join(sorted(from_stdlib[False])), | |||||
| ), | |||||
| node.lineno, | |||||
| ) | |||||
| class CircularImport(Exception): | class CircularImport(Exception): | ||||
| pass | pass | ||||
| def checkmod(mod, imports): | def checkmod(mod, imports): | ||||
| shortest = {} | shortest = {} | ||||
| visit = [[mod]] | visit = [[mod]] | ||||
| while visit: | while visit: | ||||