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

Uploaded Source

Built Distributions

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

Uploaded Python 3

pyre_check-0.9.12-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.12.tar.gz.

File metadata

  • Download URL: pyre-check-0.9.12.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.12.tar.gz
Algorithm Hash digest
SHA256 b05cde43a86b0cea6cd3ef4848abf5cc7526efdd5dfc96880126c3053f1a5975
MD5 639723f65fe79a3a7ca3462f47710711
BLAKE2b-256 ac50438d43310060d57106f16565dac4e57e58ec3932662955efda99d2275dc7

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyre_check-0.9.12-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.12-py3-none-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 aecca3bfe4dfd8f686960658fd73647f5e45acda0ec8c2625eb0b4f38e3e6494
MD5 7a4cad94c5d0c3d8084fc9593af5c325
BLAKE2b-256 2d5da45360eeb86a29913f9658bbb5a202a25fcbf5e4867ad65f23427cf45121

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyre_check-0.9.12-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.12-py3-none-macosx_10_11_x86_64.whl
Algorithm Hash digest
SHA256 f0bc7881757567aec22d0b03646620533a363a3945dd5d265c16b4b410484ac5
MD5 bf0a9a8e8f3f37f3ea99e678a02b5ec8
BLAKE2b-256 96c6c83669f62f9265fef26ac5ef56eee0672bee84dcbe72e53453132bba5cc4

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