facebook/sapling
1
1
Fork 0
mirror of https://github.com/facebook/sapling.git synced 2024-10-06 23:07:18 +03:00
Code Issues Projects Releases Wiki Activity

import-checker: allow relative import a module being checked

Browse Source 
This would make the checker more friendly for 3rd-party code. For example,

In remotefilelog/x.py, it may have:

    from . import shallowutils

That could trigger "relative import of stdlib module" if
"remotefilelog" was installed in the system. If the module being checked
conflicts with the system module, it makes sense to not treat that module as
system module. This patch makes it so.

Differential Revision: https://phab.mercurial-scm.org/D552
This commit is contained in:
Jun Wu 2017-08-28 13:43:25 -07:00
parent 630437a97b
commit 56e365cc2f
2 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
contrib/import-checker.py
View File

@ -411,7 +411,8 @@ def verify_modern_convention(module, root, localmods, root_col_offset=0):
assign the symbol to a module-level variable. In addition, these imports
must be performed before other local imports. This rule only
applies to import statements outside of any blocks.
* Relative imports from the standard library are not allowed.
* Relative imports from the standard library are not allowed, unless that
library is also a local module.
* Certain modules must be aliased to alternate names to avoid aliasing
and readability problems. See `requirealias`.
"""
@ -493,7 +494,10 @@ def verify_modern_convention(module, root, localmods, root_col_offset=0):
# __future__ is special since it needs to come first and use
# symbol import.
if fullname != '__future__':
if not fullname or fullname in stdlib_modules:
if not fullname or (
fullname in stdlib_modules
and fullname not in localmods
and fullname + '.__init__' not in localmods):
yield msg('relative import of stdlib module')
else:
seenlocal = fullname

14
tests/test-imports-checker.t
View File

@ -125,7 +125,19 @@ Run additional tests for the import checker
> from mercurial.node import hex
> EOF
$ $PYTHON "$import_checker" testpackage*/*.py testpackage/subpackage/*.py
# Shadowing a stdlib module to test "relative import of stdlib module" is
# allowed if the module is also being checked
$ mkdir email
$ touch email/__init__.py
$ touch email/errors.py
$ cat > email/utils.py << EOF
> from __future__ import absolute_import
> from . import errors
> EOF
$ $PYTHON "$import_checker" testpackage*/*.py testpackage/subpackage/*.py \
> email/*.py
testpackage/importalias.py:2: ui module must be "as" aliased to uimod
testpackage/importfromalias.py:2: ui from testpackage must be "as" aliased to uimod
testpackage/importfromrelative.py:2: import should be relative: testpackage.unsorted