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.2.23.tar.gz (1.8 MB view details)

Uploaded Source

Built Distributions

pytype-2021.2.23-cp38-cp38-manylinux2014_x86_64.whl (2.2 MB view details)

Uploaded CPython 3.8

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

Uploaded CPython 3.8 macOS 10.14+ x86-64

pytype-2021.2.23-cp37-cp37m-manylinux2014_x86_64.whl (2.1 MB view details)

Uploaded CPython 3.7m

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

Uploaded CPython 3.7m macOS 10.14+ x86-64

pytype-2021.2.23-cp36-cp36m-manylinux2014_x86_64.whl (2.1 MB view details)

Uploaded CPython 3.6m

pytype-2021.2.23-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.2.23.tar.gz.

File metadata

  • Download URL: pytype-2021.2.23.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.7.7

File hashes

Hashes for pytype-2021.2.23.tar.gz
Algorithm Hash digest
SHA256 ce6c652bacd2926b56b7dbb347096863c276d407377784bc2d2674e80fd1d3e7
MD5 684a888a147ef1bd4b7e799f67a4c5f2
BLAKE2b-256 51ea104beb90a906b5aa4f253ea7f786dc94f4bc9c978629b7ba54fddab10f66

See more details on using hashes here.

Provenance

File details

Details for the file pytype-2021.2.23-cp38-cp38-manylinux2014_x86_64.whl.

File metadata

  • Download URL: pytype-2021.2.23-cp38-cp38-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 2.2 MB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.7.7

File hashes

Hashes for pytype-2021.2.23-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 7ca6a9bc7f712e27d3c0763f36dad0df0780107d8850a50d4ae9803249649dbf
MD5 ad661a556b54b50f0171e43fef9b0fec
BLAKE2b-256 622610505d7464e470010ccf18b8e6a9ee9fbde4cd74ad5b9d406b927f3db0c4

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pytype-2021.2.23-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.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.7.7

File hashes

Hashes for pytype-2021.2.23-cp38-cp38-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 2d60e2b2a98855cc43e2d462418235f2d9cc89af86a78c80c167b9a45a2fbf8b
MD5 d693392dfc844fe099e14e31008c0b77
BLAKE2b-256 d9bc167019ab9482bc797d39b8f46a2730eccd3bee472d0e2ad0425870e0d5d5

See more details on using hashes here.

Provenance

File details

Details for the file pytype-2021.2.23-cp37-cp37m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: pytype-2021.2.23-cp37-cp37m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 2.1 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.7.7

File hashes

Hashes for pytype-2021.2.23-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 634f6be47327e7455917115d245f38d9be852f230efa91b658eb9902718f7339
MD5 0962444837ae17d11d647eae0589877e
BLAKE2b-256 b3219bdd3b05dffc66de1602e78a27c0eb3c336699012a364191b5218ff13681

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pytype-2021.2.23-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.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.7.7

File hashes

Hashes for pytype-2021.2.23-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 dd5a58df2f890c20e74d0296a82523890f5e2b04efab3f057b6f739713645018
MD5 6e1d32dfbfb070026ef46bf24382b5ea
BLAKE2b-256 e448fb65bf61f7e56012bea03a11cd5fa09eedfaebf7e19278370b3aea6bbaf7

See more details on using hashes here.

Provenance

File details

Details for the file pytype-2021.2.23-cp36-cp36m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: pytype-2021.2.23-cp36-cp36m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 2.1 MB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.7.7

File hashes

Hashes for pytype-2021.2.23-cp36-cp36m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 7100feca8e7a37b5b55233ae87eee9d32602cd6e285022d20c328cd6f0d10af7
MD5 3bcf0ed76b7d86e3bd6133293339ec5a
BLAKE2b-256 e2d6ec8e4bce4c2526ee60d1554c04dcb26dbf369d9a1788ee2450f459e0a45f

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pytype-2021.2.23-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.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.7.7

File hashes

Hashes for pytype-2021.2.23-cp36-cp36m-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 b45bdd7709dadafd2ab10b1b1836f068b20e7228392ff50b66a20a04de0a271d
MD5 868580a289a536cbf0f28577a23ca0bb
BLAKE2b-256 df95319674c10c3b5607e816a643403c0ec38506b0e397678fe67fe628a6273b

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