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.

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

Uploaded Source

Built Distributions

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

Uploaded Python 3

pyre_check-0.9.11-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.11.tar.gz.

File metadata

  • Download URL: pyre-check-0.9.11.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.11.tar.gz
Algorithm Hash digest
SHA256 3e1ddcc9217b6d19b1f31bb822e2fca7edefd8b0dd7fcc13463c9d936838c184
MD5 911e54e3ae28bbe8ffeb56aa1d17e55e
BLAKE2b-256 32f903339923e329ab1a082fdbcabb8ef7cf55f213ae40074c667b2799fac6ea

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyre_check-0.9.11-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.11-py3-none-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 cff42902cb30b7bd6c4c778ae177d939c4791773becc2f897182c1a7d5078442
MD5 0cd9dfabe8271d891608d510c002d24d
BLAKE2b-256 ba1f8e2e79a114fd532d521dcc055bb0a989b43b600bb3aa9c6fbaab22900ad7

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyre_check-0.9.11-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.11-py3-none-macosx_10_11_x86_64.whl
Algorithm Hash digest
SHA256 b7de04e951ebdbd419671d783533b54dd527cc531e6acad57db144bec57982a8
MD5 b091162fd2f77e6636074f05794732ad
BLAKE2b-256 36467db34689c4178f7f7ae41444efefe4c48ec8721cfd1bee82300ac28da2c2

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