blob: a710037788e926d63c426fde7aef94902d765ba4 [file] [log] [blame]
"""Collection of names of notable Python library modules.
Both standard library and third party modules are included. The
selection criteria for third party modules is somewhat arbitrary.
For packages we usually just include the top-level package name, but
sometimes some or all submodules are enumerated. In the latter case if
the top-level name is included we include all possible submodules
(this is an implementation limitation).
These are used to give more useful error messages when there is
no stub for a module.
"""
from typing import Set
from typing_extensions import Final
third_party_modules = {
# From https://hugovk.github.io/top-pypi-packages/
'pip',
'urllib3',
'six',
'botocore',
'dateutil',
's3transfer',
'yaml',
'requests',
'pyasn1',
'docutils',
'jmespath',
'certifi',
'rsa',
'setuptools',
'idna',
'awscli',
'concurrent.futures',
'colorama',
'chardet',
'wheel',
'simplejson',
'boto3',
'pytz',
'numpy',
'markupsafe',
'jinja2',
'cffi',
'cryptography',
'google.protobuf',
'cwlogs',
'enum',
'pycparser',
'asn1crypto',
'attr',
'click',
'ipaddress',
'pytest',
'future',
'decorator',
'pbr',
'google.api',
'pandas',
'werkzeug',
'pyparsing',
'flask',
'psutil',
'itsdangerous',
'google.cloud',
'grpc',
'cachetools',
'virtualenv',
'google.auth',
'py',
'pluggy',
'scipy',
'boto',
'coverage',
'mock',
'OpenSSL',
'sklearn',
'jsonschema',
'argparse',
'more_itertools',
'pygments',
'psycopg2',
'websocket',
'PIL',
'googleapiclient',
'httplib2',
'matplotlib',
'oauth2client',
'docopt',
'tornado',
'funcsigs',
'lxml',
'prompt_toolkit',
'paramiko',
'jwt',
'IPython',
'docker',
'dockerpycreds',
'oauthlib',
'mccabe',
'google.resumable_media',
'sqlalchemy',
'wrapt',
'bcrypt',
'ptyprocess',
'requests_oauthlib',
'multidict',
'markdown',
'pexpect',
'atomicwrites',
'uritemplate',
'nacl',
'pycodestyle',
'elasticsearch',
'absl',
'aiohttp',
'redis',
'sklearn',
'gevent',
'pymysql',
'wcwidth',
'tqdm',
'bs4',
'functools32',
'configparser',
'gunicorn',
'typing',
'ujson',
'pyflakes',
'packaging',
'lazy_object_proxy',
'ipython_genutils',
'toolz',
'async_timeout',
'traitlets',
'kiwisolver',
'pathlib2',
'greenlet',
'networkx',
'cv2',
'termcolor',
'babel',
'django',
'pymemcache',
'skimage',
'pickleshare',
'flake8',
'cycler',
'requests_toolbelt',
'bleach',
'scandir',
'selenium',
'dask',
'websockets',
'isort',
'h5py',
'tabulate',
'tensorflow',
'html5lib',
'pylint',
'tensorboard',
'compose',
'astroid',
'trueskill',
'webencodings',
'defusedxml',
'pykube',
'pymongo',
'retrying',
'cached_property',
'zope',
'singledispatch',
'tzlocal',
'datadog',
'zmq',
'discord',
'apache_beam',
'subprocess32',
'astor',
'entrypoints',
'gast',
'nose',
'smmap',
'gitdb',
'isodate',
'pywt',
'simplegeneric',
'sortedcontainers',
'psycopg2',
'pytest_cov',
'hiredis',
'elasticsearch_dsl',
'dill',
'keras',
'contextlib2',
'hdfs',
'jupyter_core',
'typed_ast',
'croniter',
'azure',
'nbformat',
'xmltodict',
'lockfile',
'arrow',
'parso',
'jsonpickle',
# Skipped (name considered too generic):
# - fixtures
# - migrate (from sqlalchemy-migrate)
# - git (GitPython)
# Other
'formencode',
'pkg_resources',
'wx',
'gi.repository',
'pygtk',
'gtk',
'PyQt4',
'PyQt5',
'pylons',
# for use in tests
'__dummy_third_party1',
} # type: Final
# Modules and packages common to Python 2.7 and 3.x.
common_std_lib_modules = {
'abc',
'aifc',
'antigravity',
'argparse',
'array',
'ast',
'asynchat',
'asyncore',
'audioop',
'base64',
'bdb',
'binascii',
'binhex',
'bisect',
'bz2',
'cProfile',
'calendar',
'cgi',
'cgitb',
'chunk',
'cmath',
'cmd',
'code',
'codecs',
'codeop',
'collections',
'colorsys',
'compileall',
'contextlib',
'copy',
'crypt',
'csv',
'ctypes',
'curses',
'datetime',
'decimal',
'difflib',
'dis',
'distutils',
'doctest',
'dummy_threading',
'email',
'encodings',
'fcntl',
'filecmp',
'fileinput',
'fnmatch',
'formatter',
'fractions',
'ftplib',
'functools',
'genericpath',
'getopt',
'getpass',
'gettext',
'glob',
'grp',
'gzip',
'hashlib',
'heapq',
'hmac',
'imaplib',
'imghdr',
'importlib',
'inspect',
'io',
'json',
'keyword',
'lib2to3',
'linecache',
'locale',
'logging',
'macpath',
'macurl2path',
'mailbox',
'mailcap',
'math',
'mimetypes',
'mmap',
'modulefinder',
'msilib',
'multiprocessing',
'netrc',
'nis',
'nntplib',
'ntpath',
'nturl2path',
'numbers',
'opcode',
'operator',
'optparse',
'os',
'ossaudiodev',
'parser',
'pdb',
'pickle',
'pickletools',
'pipes',
'pkgutil',
'platform',
'plistlib',
'poplib',
'posixpath',
'pprint',
'profile',
'pstats',
'pty',
'py_compile',
'pyclbr',
'pydoc',
'pydoc_data',
'pyexpat',
'quopri',
'random',
're',
'resource',
'rlcompleter',
'runpy',
'sched',
'select',
'shelve',
'shlex',
'shutil',
'site',
'smtpd',
'smtplib',
'sndhdr',
'socket',
'spwd',
'sqlite3',
'sqlite3.dbapi2',
'sqlite3.dump',
'sre_compile',
'sre_constants',
'sre_parse',
'ssl',
'stat',
'string',
'stringprep',
'struct',
'subprocess',
'sunau',
'symbol',
'symtable',
'sysconfig',
'syslog',
'tabnanny',
'tarfile',
'telnetlib',
'tempfile',
'termios',
'textwrap',
'this',
'threading',
'timeit',
'token',
'tokenize',
'trace',
'traceback',
'tty',
'types',
'unicodedata',
'unittest',
'urllib',
'uu',
'uuid',
'warnings',
'wave',
'weakref',
'webbrowser',
'wsgiref',
'xdrlib',
'xml.dom',
'xml.dom.NodeFilter',
'xml.dom.domreg',
'xml.dom.expatbuilder',
'xml.dom.minicompat',
'xml.dom.minidom',
'xml.dom.pulldom',
'xml.dom.xmlbuilder',
'xml.etree',
'xml.etree.ElementInclude',
'xml.etree.ElementPath',
'xml.etree.ElementTree',
'xml.etree.cElementTree',
'xml.parsers',
'xml.parsers.expat',
'xml.sax',
'xml.sax._exceptions',
'xml.sax.expatreader',
'xml.sax.handler',
'xml.sax.saxutils',
'xml.sax.xmlreader',
'zipfile',
'zlib',
# fake names to use in tests
'__dummy_stdlib1',
'__dummy_stdlib2',
} # type: Final
# Python 2 standard library modules.
python2_std_lib_modules = common_std_lib_modules | {
'BaseHTTPServer',
'Bastion',
'CGIHTTPServer',
'ConfigParser',
'Cookie',
'DocXMLRPCServer',
'HTMLParser',
'MimeWriter',
'Queue',
'SimpleHTTPServer',
'SimpleXMLRPCServer',
'SocketServer',
'StringIO',
'UserDict',
'UserList',
'UserString',
'anydbm',
'atexit',
'audiodev',
'bsddb',
'cPickle',
'cStringIO',
'commands',
'cookielib',
'copy_reg',
'curses.wrapper',
'dbhash',
'dircache',
'dumbdbm',
'dummy_thread',
'fpformat',
'future_builtins',
'hotshot',
'htmlentitydefs',
'htmllib',
'httplib',
'ihooks',
'imputil',
'itertools',
'linuxaudiodev',
'markupbase',
'md5',
'mhlib',
'mimetools',
'mimify',
'multifile',
'multiprocessing.forking',
'mutex',
'new',
'os2emxpath',
'popen2',
'posixfile',
'repr',
'rexec',
'rfc822',
'robotparser',
'sets',
'sgmllib',
'sha',
'sre',
'statvfs',
'stringold',
'strop',
'sunaudio',
'time',
'toaiff',
'urllib2',
'urlparse',
'user',
'whichdb',
'xmllib',
'xmlrpclib',
} # type: Final
# Python 3 standard library modules (based on Python 3.5.0).
python3_std_lib_modules = common_std_lib_modules | {
'asyncio',
'collections.abc',
'concurrent',
'concurrent.futures',
'configparser',
'copyreg',
'dbm',
'ensurepip',
'enum',
'html',
'http',
'imp',
'ipaddress',
'lzma',
'pathlib',
'queue',
'readline',
'reprlib',
'selectors',
'signal',
'socketserver',
'statistics',
'tkinter',
'tracemalloc',
'turtle',
'turtledemo',
'typing',
'unittest.mock',
'urllib.error',
'urllib.parse',
'urllib.request',
'urllib.response',
'urllib.robotparser',
'venv',
'xmlrpc',
'xxlimited',
'zipapp',
} # type: Final
def is_third_party_module(id: str) -> bool:
return is_in_module_collection(third_party_modules, id)
def is_py2_std_lib_module(id: str) -> bool:
return is_in_module_collection(python2_std_lib_modules, id)
def is_py3_std_lib_module(id: str) -> bool:
return is_in_module_collection(python3_std_lib_modules, id)
def is_in_module_collection(collection: Set[str], id: str) -> bool:
components = id.split('.')
for prefix_length in range(1, len(components) + 1):
if '.'.join(components[:prefix_length]) in collection:
return True
return False