Skip to main content

Python type inferencer

Project description

CI PyPI - Wheel

pytype - 🦆✔

Pytype checks and infers types for your Python code - without requiring type annotations. Pytype can:

  • Lint plain Python code, flagging common mistakes such as misspelled attribute names, incorrect function calls, and much more, even across file boundaries.
  • Enforce user-provided type annotations. While annotations are optional for pytype, it will check and apply them where present.
  • Generate type annotations in standalone files ("pyi files"), which can be merged back into the Python source with a provided merge-pyi tool.

Pytype is a static analyzer; it does not execute the code it runs on.

Thousands of projects at Google rely on pytype to keep their Python code well-typed and error-free.

For more information, check out the user guide, FAQ, or supported features.

How is pytype different from other type checkers?

  1. Pytype uses inference instead of gradual typing. This means it will infer types on code even when the code has no type hints on it. So it can detect issues with code like this, which other type checkers would miss:

    def f():
        return "PyCon"
    def g():
        return f() + 2019
    
    # pytype: line 4, in g: unsupported operand type(s) for +: 'str'
    # and 'int' [unsupported-operands]
    
  2. Pytype is lenient instead of strict. That means it allows all operations that succeed at runtime and don't contradict annotations. For instance, this code will pass as safe in pytype, but fail in other type checkers, which assign types to variables as soon as they are initialized:

    from typing import List
    def get_list() -> List[str]:
        lst = ["PyCon"]
        lst.append(2019)
        return [str(x) for x in lst]
    
    # mypy: line 4: error: Argument 1 to "append" of "list" has
    # incompatible type "int"; expected "str"
    

Also see the corresponding FAQ entry.

Quickstart

To quickly get started with type-checking a file or directory, run the following, replacing file_or_directory with your input:

pip install pytype
pytype file_or_directory

To set up pytype on an entire package, add the following to a setup.cfg file in the directory immediately above the package, replacing package_name with the package name:

[pytype]
inputs = package_name

Now you can run the no-argument command pytype to type-check the package. It's also easy to add pytype to your automated testing; see this example of a GitHub project that runs pytype on Travis.

Finally, pytype generates files of inferred type information, located by default in .pytype/pyi. You can use this information to type-annotate the corresponding source file:

merge-pyi -i <filepath>.py .pytype/pyi/<filename>.pyi

Requirements

You need a Python 3.6-3.8 interpreter to run pytype, as well as an interpreter in $PATH for the Python version of the code you're analyzing (supported: 2.7, 3.5-3.8).

Platform support:

  • Pytype is currently developed and tested on Linux*, which is the main supported platform.
  • Installation on MacOSX requires OSX 10.7 or higher and Xcode v8 or higher.
  • Windows is currently not supported unless you use WSL.

* Note: On Alpine Linux, installing may fail due to issues with upstream dependencies. See the details of this issue for a possible fix.

Installing

Pytype can be installed via pip. Note that the installation requires wheel and setuptools. (If you're working in a virtualenv, these two packages should already be present.)

pip install pytype

Or from the source code on GitHub.

git clone --recurse-submodules https://github.com/google/pytype.git
cd pytype
pip install .

Instead of using --recurse-submodules, you could also have run

git submodule init
git submodule update

in the pytype directory. To edit the code and have your edits tracked live, replace the pip install command with:

pip install -e .

Installing on WSL

Follow the steps above, but make sure you have the correct libraries first:

sudo apt install build-essential python3-dev libpython3-dev

Usage

usage: pytype [options] input [input ...]

positional arguments:
  input                 file or directory to process

Common options:

  • -V, --python-version: Python version (major.minor) of the target code. Defaults to the version that pytype is running under.
  • -o, --output: The directory into which all pytype output goes, including generated .pyi files. Defaults to .pytype.
  • -d, --disable. Comma or space separated list of error names to ignore. Detailed explanations of pytype's error names are in this doc. Defaults to empty.

For a full list of options, run pytype --help.

In addition to the above, you can direct pytype to use a custom typeshed installation instead of its own bundled copy by setting $TYPESHED_HOME.

Config File

For convenience, you can save your pytype configuration in a file. The config file is an INI-style file with a [pytype] section; if an explicit config file is not supplied, pytype will look for a [pytype] section in the first setup.cfg file found by walking upwards from the current working directory.

Start off by generating a sample config file:

$ pytype --generate-config pytype.cfg

Now customize the file based on your local setup, keeping only the sections you need. Directories may be relative to the location of the config file, which is useful if you want to check in the config file as part of your project.

For example, suppose you have the following directory structure and want to analyze package ~/repo1/foo, which depends on package ~/repo2/bar:

~/
├── repo1
│   └── foo
│       ├── __init__.py
│       └── file_to_check.py
└── repo2
    └── bar
        ├── __init__.py
        └── dependency.py

Here is the filled-in config file, which instructs pytype to type-check ~/repo1/foo as Python 3.6 code, look for packages in ~/repo1 and ~/repo2, and ignore attribute errors. Notice that the path to a package does not include the package itself.

$ cat ~/repo1/pytype.cfg

# NOTE: All relative paths are relative to the location of this file.

[pytype]

# Space-separated list of files or directories to process.
inputs =
    foo

# Python version (major.minor) of the target code.
python_version = 3.6

# Paths to source code directories, separated by ':'.
pythonpath =
    .:
    ~/repo2

# Comma or space separated list of error names to ignore.
disable =
    attribute-error

We could've discovered that ~/repo2 needed to be added to the pythonpath by running pytype's broken dependency checker:

$ pytype --config=~/repo1/pytype.cfg ~/repo1/foo/*.py --unresolved

Unresolved dependencies:
  bar.dependency

Subtools

Pytype ships with a few scripts in addition to pytype itself:

  • annotate-ast, an in-progress type annotator for ASTs.
  • merge-pyi, for merging type information from a .pyi file into a Python file.
  • pytd-tool, a parser for .pyi files.
  • pytype-single, a debugging tool for pytype developers, which analyzes a single Python file assuming that .pyi files have already been generated for all of its dependencies.
  • pyxref, a cross references generator.

2021 Roadmap

  • Python 3.9 support
  • Better performance on large files
  • Support for numerical libraries

License

Apache 2.0

Disclaimer

This is not an official Google product.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytype-2021.5.25.tar.gz (2.1 MB view details)

Uploaded Source

Built Distributions

pytype-2021.5.25-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.0 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

pytype-2021.5.25-cp39-cp39-macosx_10_14_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.9 macOS 10.14+ x86-64

pytype-2021.5.25-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.0 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

pytype-2021.5.25-cp38-cp38-macosx_10_14_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.8 macOS 10.14+ x86-64

pytype-2021.5.25-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.0 MB view details)

Uploaded CPython 3.7m manylinux: glibc 2.17+ x86-64

pytype-2021.5.25-cp37-cp37m-macosx_10_14_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.7m macOS 10.14+ x86-64

pytype-2021.5.25-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.0 MB view details)

Uploaded CPython 3.6m manylinux: glibc 2.17+ x86-64

pytype-2021.5.25-cp36-cp36m-macosx_10_14_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.6m macOS 10.14+ x86-64

File details

Details for the file pytype-2021.5.25.tar.gz.

File metadata

  • Download URL: pytype-2021.5.25.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.7.7

File hashes

Hashes for pytype-2021.5.25.tar.gz
Algorithm Hash digest
SHA256 30029caedd345ccc79867163b4bbaa82376fbb876a45b6bddb48d11cfa08a1aa
MD5 e53560243b776d68c2e991e155d7c181
BLAKE2b-256 f78ca86ad3ac154b7f3e9d11874a458106854c063e11a9d371ea4d296bad4b18

See more details on using hashes here.

Provenance

File details

Details for the file pytype-2021.5.25-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for pytype-2021.5.25-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a889b73d29e52a22f2d15fc45b7e1e0bbc41a25762e6e615d7bec49d487e8bc7
MD5 2547f338330b00ca845f9ffacafffcb6
BLAKE2b-256 6051411689c6d4995bc054069db6deff19993ad9da1041e75879a8d32eaa59c7

See more details on using hashes here.

Provenance

File details

Details for the file pytype-2021.5.25-cp39-cp39-macosx_10_14_x86_64.whl.

File metadata

  • Download URL: pytype-2021.5.25-cp39-cp39-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.9, macOS 10.14+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.7.7

File hashes

Hashes for pytype-2021.5.25-cp39-cp39-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 ba17569236b2d856a7e7951ec386cb655df2fcb8fa1726b47fcf0184aa160acf
MD5 1fc07d2ae5a32da4cf8c8cc9d153c31c
BLAKE2b-256 cc6cfaf98ac6771808d861528097dd6e518c428e891e4fbddcf881a814de2994

See more details on using hashes here.

Provenance

File details

Details for the file pytype-2021.5.25-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for pytype-2021.5.25-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 01ab9e4bd9aef7b5c510e3cd6719a4496fcaa99d58d870ab69872300b0a90786
MD5 ffe89775fc03a6836cb149c2ac92c4c0
BLAKE2b-256 4cc364fd87fc11c1e99769da90defba9a99b572e77d9fb5ca59a90093d0bab45

See more details on using hashes here.

Provenance

File details

Details for the file pytype-2021.5.25-cp38-cp38-macosx_10_14_x86_64.whl.

File metadata

  • Download URL: pytype-2021.5.25-cp38-cp38-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.8, macOS 10.14+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.7.7

File hashes

Hashes for pytype-2021.5.25-cp38-cp38-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 c94fa1fab9b775fb3e9a2700a8c5002152c5a8310cf209c98e249e3c705e34f3
MD5 6b492111797c1bc37681834b71e81442
BLAKE2b-256 51b3265479eb7af3803b4954d214042a430f071f9b8dd521f337ef5e0a3d0926

See more details on using hashes here.

Provenance

File details

Details for the file pytype-2021.5.25-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for pytype-2021.5.25-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 5fafa02fba7959e6b9d837e4040e966fe1874a7c791c64b54f279a063a5e9aad
MD5 2cbb6815f8e2bc7e74dfc6290338d740
BLAKE2b-256 242db9850d266d7bbfe7eebf2cbb29be170f551b292826a5dfba1b372aa3bc82

See more details on using hashes here.

Provenance

File details

Details for the file pytype-2021.5.25-cp37-cp37m-macosx_10_14_x86_64.whl.

File metadata

  • Download URL: pytype-2021.5.25-cp37-cp37m-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.7m, macOS 10.14+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.7.7

File hashes

Hashes for pytype-2021.5.25-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 a3eb1f603273b920206933776be9d6b76eb83f626d192c7a2ae06347fac458d5
MD5 8a497dc9b74468a7fa9fd4b5f9910711
BLAKE2b-256 d71636856f4544724948587b61946f6c1a5ca15983b913646a9b96e3f431f703

See more details on using hashes here.

Provenance

File details

Details for the file pytype-2021.5.25-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for pytype-2021.5.25-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 b20d5e1cc3d01986211fe024a8c44400920c675c7e163919ec977e0a91448473
MD5 01286198df7dc1c99f5b23c0d916417b
BLAKE2b-256 5fa1e6bdc5f84f84668584149947804200b1d18408fa18ddcf7d1d1102d9b905

See more details on using hashes here.

Provenance

File details

Details for the file pytype-2021.5.25-cp36-cp36m-macosx_10_14_x86_64.whl.

File metadata

  • Download URL: pytype-2021.5.25-cp36-cp36m-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.6m, macOS 10.14+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.7.7

File hashes

Hashes for pytype-2021.5.25-cp36-cp36m-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 f0eadaf3dc338109a4d7e184f8c02d4163c27cc7306d7e619ee218401e530976
MD5 f88390c6184fdf8f8782bf03c917b677
BLAKE2b-256 7a15389f438c9b0d4d8a1f6837f9b146dec44888827e1ac4630730fa645098e0

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page