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.
11 maintainers
Metadata
11 maintainers
Release files for pyre-check-nightly 0.0.101749813434
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pyre-check-nightly-0.0.101749813434.tar.gz | 21.3 MB | Details |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyre_check_nightly-0.0.101749813434-py3-none-manylinux1_x86_64.whl | Python 3 | none | Linux glibc 2.5+ x86-64 | Details |
| pyre_check_nightly-0.0.101749813434-py3-none-macosx_10_11_x86_64.whl | Python 3 | none | macOS 10.11+ x86-64 | Details |
Total release size: 88.8 MB
Release files / pyre-check-nightly-0.0.101749813434.tar.gz
| Download URL | pyre-check-nightly-0.0.101749813434.tar.gz |
|---|---|
| Size | 21.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3105e647604fece0830dae1325c7da410c79da43d9265da50c17c0d30a879fc1
|
|
BLAKE2b-256 checksum How to use checksums |
bd1bd86317fc675aaa60aa9422d2c294b3abe5737d0a54cef94c375e40c35ce0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.12.0 requests/2.32.3+fb3 setuptools/70.0.0 requests-toolbelt/0.9.1 tqdm/4.67.1 CPython/3.12.11+meta
|
Release files / pyre_check_nightly-0.0.101749813434-py3-none-manylinux1_x86_64.whl
| Download URL | pyre_check_nightly-0.0.101749813434-py3-none-manylinux1_x86_64.whl |
|---|---|
| Size | 45.5 MB |
| Tags | Linux glibc 2.5+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
bd55cdaf4ebcb6fdbaec16bdf08285814e357fa7c411ce8c58ab7c9e58790b95
|
|
BLAKE2b-256 checksum How to use checksums |
3358fc0dcd03c49a70845c2fff16856169e37486b28306a9d10fe778eb08d046
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.12.0 requests/2.32.3+fb3 setuptools/70.0.0 requests-toolbelt/0.9.1 tqdm/4.67.1 CPython/3.12.11+meta
|
Release files / pyre_check_nightly-0.0.101749813434-py3-none-macosx_10_11_x86_64.whl
| Download URL | pyre_check_nightly-0.0.101749813434-py3-none-macosx_10_11_x86_64.whl |
|---|---|
| Size | 22.0 MB |
| Tags | Python 3 macOS 10.11+ x86-64 |
|
SHA-256 checksum How to use checksums |
53af7ab4a7cc7706990f4452e9823f378dd164b78f1a0ca0fbe6e5b9e08d22a2
|
|
BLAKE2b-256 checksum How to use checksums |
4f3d583a157c26ebfc6c615ca0ce87882547974b6112f60e4f8fdf586a674390
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.12.0 requests/2.32.3+fb3 setuptools/70.0.0 requests-toolbelt/0.9.1 tqdm/4.67.1 CPython/3.12.11+meta
|
