Skip to main content

A performant type checker for Python

Project description

lint tests pyre License: MIT Gitter

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.

Pysa is also available on the GitHub Marketplace as a Github Action

Requirements

To get started, you need Python 3.8 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.22.tar.gz (22.4 MB view details)

Uploaded Source

Built Distributions

pyre_check-0.9.22-py3-none-manylinux1_x86_64.whl (45.0 MB view details)

Uploaded Python 3

pyre_check-0.9.22-py3-none-macosx_10_11_x86_64.whl (23.2 MB view details)

Uploaded Python 3 macOS 10.11+ x86-64

File details

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

File metadata

  • Download URL: pyre-check-0.9.22.tar.gz
  • Upload date:
  • Size: 22.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.10.0 requests/2.31.0+fb3 setuptools/69.0.3 requests-toolbelt/0.9.1 tqdm/4.66.1 CPython/3.10.9+fb

File hashes

Hashes for pyre-check-0.9.22.tar.gz
Algorithm Hash digest
SHA256 e082f926dff71661959535c3936fca5ad40a44858b5fd3e99009a616a1b57083
MD5 df10642e03f1e266f269e8c3f29c270f
BLAKE2b-256 fd94bbbb7b51310bc17fd80453f17c72fdf5079dbfe97558c511295be50a4880

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyre_check-0.9.22-py3-none-manylinux1_x86_64.whl
  • Upload date:
  • Size: 45.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.10.0 requests/2.31.0+fb3 setuptools/69.0.3 requests-toolbelt/0.9.1 tqdm/4.66.1 CPython/3.10.9+fb

File hashes

Hashes for pyre_check-0.9.22-py3-none-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 d331e2687e194fa22505e0724b1536e61bf06fddc5416d7b83d542d2270c91ce
MD5 50c158e563455950a8747bd823eab342
BLAKE2b-256 0c1a655ddae10ad37b4cdb33205aed45ba26f568e9de5ab9cb14776e95bddcb4

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyre_check-0.9.22-py3-none-macosx_10_11_x86_64.whl
  • Upload date:
  • Size: 23.2 MB
  • Tags: Python 3, macOS 10.11+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.10.0 requests/2.31.0+fb3 setuptools/69.0.3 requests-toolbelt/0.9.1 tqdm/4.66.1 CPython/3.10.9+fb

File hashes

Hashes for pyre_check-0.9.22-py3-none-macosx_10_11_x86_64.whl
Algorithm Hash digest
SHA256 4bbd61dad5669dfef00e875bf8a573866595ecbd8240f595339a9781e8a1e22e
MD5 c357f0ad387ca494d980ef57236ce60c
BLAKE2b-256 bab142668886e6ed9f65e009dcd215ee184dac78b1e645b7ddca1f9492a67aae

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