Skip to main content

A performant type checker for Python

Project description

Pyre

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:

$ sudo apt-get install python3 python3-pip watchman

We tested Pyre on Ubuntu 16.04 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.0.58.tar.gz (15.4 MB view details)

Uploaded Source

Built Distributions

pyre_check-0.0.58-py3-none-manylinux1_x86_64.whl (24.8 MB view details)

Uploaded Python 3

pyre_check-0.0.58-py3-none-macosx_10_11_x86_64.whl (16.3 MB view details)

Uploaded Python 3 macOS 10.11+ x86-64

File details

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

File metadata

  • Download URL: pyre-check-0.0.58.tar.gz
  • Upload date:
  • Size: 15.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.1+fb1 setuptools/46.1.0 requests-toolbelt/0.8.0 tqdm/4.47.0 CPython/3.7.5+

File hashes

Hashes for pyre-check-0.0.58.tar.gz
Algorithm Hash digest
SHA256 cb83f8e9f3d5bc5f659ca16c248dbc7125030ec8a2ef979e0a4d0ec1e55b115b
MD5 2fca3bf7c25f5701f6d76d4f749ae40b
BLAKE2b-256 b1d80e1373b92a45d30678e9e8af3d5ce9e41024339ab22e1a7050a9a11ea228

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyre_check-0.0.58-py3-none-manylinux1_x86_64.whl
  • Upload date:
  • Size: 24.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.1+fb1 setuptools/46.1.0 requests-toolbelt/0.8.0 tqdm/4.47.0 CPython/3.7.5+

File hashes

Hashes for pyre_check-0.0.58-py3-none-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 aaf90c9bfe5043684e0649a94dcd025fa355df60ab2dbb592f6ab8696614cc02
MD5 4c7dfd3a22eac3f1607c3fcec15c4840
BLAKE2b-256 69df88e16fd4d9f9c5e1a1eee000b9396e6422780070028558fc4228b444ae14

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyre_check-0.0.58-py3-none-macosx_10_11_x86_64.whl
  • Upload date:
  • Size: 16.3 MB
  • Tags: Python 3, macOS 10.11+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.1+fb1 setuptools/46.1.0 requests-toolbelt/0.8.0 tqdm/4.47.0 CPython/3.7.5+

File hashes

Hashes for pyre_check-0.0.58-py3-none-macosx_10_11_x86_64.whl
Algorithm Hash digest
SHA256 1d7fa7862ecdf52c1e62b280de32c043e6546e379bde49b661f611e79538a6c1
MD5 6cfa4a9b5c231e1f2f895d31d6cf8a12
BLAKE2b-256 ea7d1324764eed203749ef554fbd9ceb14d7f4c359b1d81fdebe61977127ef62

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