Skip to main content

Python type inferencer

Project description

Tests 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 or FAQ.

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 2.7 or 3.5+ interpreter to run pytype, as well as an interpreter in $PATH for the Python version of the code you're analyzing.

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, 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.

2020 Roadmap

  • Python 3.7 and 3.8 support
  • Stricter type annotation enforcement
  • Better performance on large files
  • Developer documentation

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

Uploaded Source

Built Distributions

pytype-2020.8.10-cp37-cp37m-manylinux2014_x86_64.whl (1.8 MB view details)

Uploaded CPython 3.7m

pytype-2020.8.10-cp37-cp37m-macosx_10_14_x86_64.whl (1.6 MB view details)

Uploaded CPython 3.7m macOS 10.14+ x86-64

pytype-2020.8.10-cp36-cp36m-manylinux2014_x86_64.whl (1.8 MB view details)

Uploaded CPython 3.6m

pytype-2020.8.10-cp36-cp36m-macosx_10_14_x86_64.whl (1.6 MB view details)

Uploaded CPython 3.6m macOS 10.14+ x86-64

pytype-2020.8.10-cp35-cp35m-manylinux2014_x86_64.whl (1.8 MB view details)

Uploaded CPython 3.5m

pytype-2020.8.10-cp35-cp35m-macosx_10_14_x86_64.whl (1.6 MB view details)

Uploaded CPython 3.5m macOS 10.14+ x86-64

File details

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

File metadata

  • Download URL: pytype-2020.8.10.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.7

File hashes

Hashes for pytype-2020.8.10.tar.gz
Algorithm Hash digest
SHA256 6385b6837a6db69c42eb477e8f7539c0b986ec6753eab4d811553d63d58a7785
MD5 29dda15b404b08d91d0e44d7ff92c096
BLAKE2b-256 82056bf66a142b75df005ba0029b56f16f28e0dea9b8db2bbb71cb00d246bc45

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pytype-2020.8.10-cp37-cp37m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.7

File hashes

Hashes for pytype-2020.8.10-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 cd4399abd26a4a3498eca1ac4ad264cb407b17dfd826f9d5f14d6c06c78cf42a
MD5 df3abca1d32a6a690381da1d6939c007
BLAKE2b-256 3054eeda0c5f9b28f7d51c2de29efa4125bb33386643359c35a60cfafae2e111

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pytype-2020.8.10-cp37-cp37m-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 1.6 MB
  • Tags: CPython 3.7m, macOS 10.14+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.7

File hashes

Hashes for pytype-2020.8.10-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 768c9ea0b08f40ce8e1ed8b9207862394d770fe3340ebebfd4210a82af530d67
MD5 de0610fab0158a50257c70b93d08fbac
BLAKE2b-256 f2386503ee2fe8174580896b31a134bfa5bb20d739640dc196273026045c6f5b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pytype-2020.8.10-cp36-cp36m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.7

File hashes

Hashes for pytype-2020.8.10-cp36-cp36m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 08662a6d426a4ef246ba36a807d526734f437451a78f83a140d338e305bc877a
MD5 083cfea3fec3b2b6c9349423f35b4415
BLAKE2b-256 404ae498be8529e9cf4225fb9de6fbc388db3a698989ab3642e3ad47e1ef0720

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pytype-2020.8.10-cp36-cp36m-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 1.6 MB
  • Tags: CPython 3.6m, macOS 10.14+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.7

File hashes

Hashes for pytype-2020.8.10-cp36-cp36m-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 6b0cd56b411738eb607a299437ac405cc94208875e97ba56332105103676a903
MD5 5fbf8e265cbc54e3f7b8d075ec896e0e
BLAKE2b-256 2d60746de3f0bc34d13fabf335d15f4fd4f17c828101fd59e6784131d97681cf

See more details on using hashes here.

Provenance

File details

Details for the file pytype-2020.8.10-cp35-cp35m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: pytype-2020.8.10-cp35-cp35m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: CPython 3.5m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.7

File hashes

Hashes for pytype-2020.8.10-cp35-cp35m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 e0909b99aff8eff0ece91fd64e00b935f0e4fecb51359d83d742b27db160dd00
MD5 7a93be7de354d8f39139a9f7757cef3f
BLAKE2b-256 566deb10f522db33a824dbd8721368f8e942db190e1cded584c97154f432f64f

See more details on using hashes here.

Provenance

File details

Details for the file pytype-2020.8.10-cp35-cp35m-macosx_10_14_x86_64.whl.

File metadata

  • Download URL: pytype-2020.8.10-cp35-cp35m-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 1.6 MB
  • Tags: CPython 3.5m, macOS 10.14+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.7

File hashes

Hashes for pytype-2020.8.10-cp35-cp35m-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 da1977a1aa74fbd237e889c1d29421d490e0be9a91a22efd96fbca2570ef9165
MD5 5203a945384f317ee762e78e7298af0e
BLAKE2b-256 dd6807b3bd34b79ba1ae6f46e1c23b9cf82ce6178907d46e3adb8fc29ba9018c

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