( )⚙ D12365 import-checker: allow symbol imports from typing module

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D12365

import-checker: allow symbol imports from typing module
ClosedPublic

Authored by indygreg on Mar 9 2022, 8:07 PM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHG8dec9abf2669: import-checker: allow symbol imports from typing module
Summary

As we add typing annotations, we'll want to use a lot of symbols from
the typing module. Typing typing all the time will be annoying. Let's
allow symbol imports from this module.

While I was here, I changed some comments from "whitelist" to "allow list"
as the former is non-inclusive terminology.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

indygreg created this revision.Mar 9 2022, 8:07 PM
Alphare accepted this revision.Mar 14 2022, 6:10 AM
This revision is now accepted and ready to land.Mar 14 2022, 6:10 AM
indygreg added a commit: rHG8dec9abf2669: import-checker: allow symbol imports from typing module.Mar 14 2022, 6:48 AM
Closed by commit rHG8dec9abf2669: import-checker: allow symbol imports from typing module (authored by indygreg). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mcontrib/import-checker.py (5 lines)

Diff 32619

contrib/import-checker.py

try: try:
import BaseHTTPServer as basehttpserver import BaseHTTPServer as basehttpserver
except ImportError: except ImportError:
basehttpserver = None basehttpserver = None
import zlib import zlib
import testparseutil import testparseutil
# Whitelist of modules that symbols can be directly imported from. # Allow list of modules that symbols can be directly imported from.
allowsymbolimports = ( allowsymbolimports = (
'__future__', '__future__',
'breezy', 'breezy',
'concurrent', 'concurrent',
'hgclient', 'hgclient',
'mercurial', 'mercurial',
'mercurial.hgweb.common', 'mercurial.hgweb.common',
'mercurial.hgweb.request', 'mercurial.hgweb.request',
'mercurial.pure.mpatch', 'mercurial.pure.mpatch',
'mercurial.pure.osutil', 'mercurial.pure.osutil',
'mercurial.pure.parsers', 'mercurial.pure.parsers',
# third-party imports should be directly imported # third-party imports should be directly imported
'mercurial.thirdparty', 'mercurial.thirdparty',
'mercurial.thirdparty.attr', 'mercurial.thirdparty.attr',
'mercurial.thirdparty.zope', 'mercurial.thirdparty.zope',
'mercurial.thirdparty.zope.interface', 'mercurial.thirdparty.zope.interface',
'typing',
) )
# Whitelist of symbols that can be directly imported. # Allow list of symbols that can be directly imported.
directsymbols = ('demandimport',) directsymbols = ('demandimport',)
# 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',
} }