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.
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
$ sudo apt-get install python3 python3-pip watchman
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
(venv) $ pyre init
.pyre_configuration) as well as watchman (
.watchmanconfig) in your project's directory. Accept the defaults for now – you can change them later if necessary.
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 : i is declared to have type `int` but is used as type `str`.
pyrewill be faster than the first one.
For more detailed documentation, see https://pyre-check.org.