Skip to main content

A performant type checker for Python

Project description

lint tests pyre License: MIT

Pyre is a performant type checker for Python compliant with PEP 484. Pyre can analyze codebases with millions of lines of code incrementally – providing instantaneous feedback to developers as they write code. You can try it out on examples in the Pyre Playground.

Pyre ships with Pysa, a security focused static analysis tool we've built on top of Pyre that reasons about data flows in Python applications. Please refer to our documentation to get started with our security analysis.

Requirements

To get started, you need Python 3.6 or later and watchman working on your system. On MacOS you can get everything with homebrew:

$ brew install python3 watchman

On Ubuntu, Mint, or Debian; use apt-get and homebrew:

$ sudo apt-get install python3 python3-pip python3-venv
$ brew install watchman

We tested Pyre on Ubuntu 18.04.5 LTS, CentOS 7, as well as OSX 10.11 and later.

Setting up a Project

We start by creating an empty project directory and setting up a virtual environment:

$ mkdir my_project && cd my_project
$ python3 -m venv ~/.venvs/venv
$ source ~/.venvs/venv/bin/activate
(venv) $ pip install pyre-check

Next, we teach Pyre about our new project:

(venv) $ pyre init

This command will set up a configuration for Pyre (.pyre_configuration) as well as watchman (.watchmanconfig) in your project's directory. Accept the defaults for now – you can change them later if necessary.

Running Pyre

We are now ready to run Pyre:

(venv) $ echo "i: int = 'string'" > test.py
(venv) $ pyre
 ƛ Found 1 type error!
test.py:1:0 Incompatible variable type [9]: i is declared to have type `int` but is used as type `str`.

This first invocation will start a daemon listening for filesystem changes – type checking your project incrementally as you make edits to the code. You will notice that subsequent invocations of pyre will be faster than the first one.

For more detailed documentation, see https://pyre-check.org.

Join the Pyre community

See CONTRIBUTING.md for how to help out.

License

Pyre is licensed under the MIT license.

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

pyre-check-0.9.13.tar.gz (13.3 MB view details)

Uploaded Source

Built Distributions

pyre_check-0.9.13-py3-none-manylinux1_x86_64.whl (20.6 MB view details)

Uploaded Python 3

pyre_check-0.9.13-py3-none-macosx_10_11_x86_64.whl (14.6 MB view details)

Uploaded Python 3 macOS 10.11+ x86-64

File details

Details for the file pyre-check-0.9.13.tar.gz.

File metadata

  • Download URL: pyre-check-0.9.13.tar.gz
  • Upload date:
  • Size: 13.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.7.1 requests/2.25.1+fb6 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.8.6

File hashes

Hashes for pyre-check-0.9.13.tar.gz
Algorithm Hash digest
SHA256 44e9fb236d8d42cfbbfebbe69eb65f626ea23211635ed730fe504b02057a34d1
MD5 34246dcde965d9b7db0f0a32500ebb16
BLAKE2b-256 552a144f8f275712ea343cc75e2e237aa5cdb97d6c2e1d252a42d0ff3c827338

See more details on using hashes here.

Provenance

File details

Details for the file pyre_check-0.9.13-py3-none-manylinux1_x86_64.whl.

File metadata

  • Download URL: pyre_check-0.9.13-py3-none-manylinux1_x86_64.whl
  • Upload date:
  • Size: 20.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.7.1 requests/2.25.1+fb6 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.8.6

File hashes

Hashes for pyre_check-0.9.13-py3-none-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 0152c8bcb64fa918764816cdd51dfe413510a0f71cefa0ab9c44e814e55bdca4
MD5 788f15ed5aa017a676e093ca674e8c79
BLAKE2b-256 3b77e70c68d9a0382c5a9bb49494bca931d335efb0d7868123a3690a490aac21

See more details on using hashes here.

Provenance

File details

Details for the file pyre_check-0.9.13-py3-none-macosx_10_11_x86_64.whl.

File metadata

  • Download URL: pyre_check-0.9.13-py3-none-macosx_10_11_x86_64.whl
  • Upload date:
  • Size: 14.6 MB
  • Tags: Python 3, macOS 10.11+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.7.1 requests/2.25.1+fb6 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.8.6

File hashes

Hashes for pyre_check-0.9.13-py3-none-macosx_10_11_x86_64.whl
Algorithm Hash digest
SHA256 e17ee5b4ff996fe6e4fa0862be410f8cc3ccd3bdbb51e464469e23123f6c2fb6
MD5 a2791e1df38253303dc2f576e85b4fd1
BLAKE2b-256 136d2aad5b85f727d1bfcd434b7bd35dd8d6f5933983b93903e5ae1289c8cf78

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