Skip to main content

A performant type checker for Python

Project description

lint tests 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 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

This version

0.9.1

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

Uploaded Source

Built Distributions

pyre_check-0.9.1-py3-none-manylinux1_x86_64.whl (23.7 MB view details)

Uploaded Python 3

pyre_check-0.9.1-py3-none-macosx_10_11_x86_64.whl (15.4 MB view details)

Uploaded Python 3 macOS 10.11+ x86-64

File details

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

File metadata

  • Download URL: pyre-check-0.9.1.tar.gz
  • Upload date:
  • Size: 14.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.6.1 requests/2.25.1+fb6 setuptools/51.0.0 requests-toolbelt/0.8.0 tqdm/4.55.1 CPython/3.8.6

File hashes

Hashes for pyre-check-0.9.1.tar.gz
Algorithm Hash digest
SHA256 e5118a683618232b26c475aa782c9d03854fbd7460fd119002f472553187c941
MD5 9983d51add5c4e694582db80962ef669
BLAKE2b-256 e50503160032ff43f9c702f4db8d6c84fc1b220333e123a8c25ecb99e1864c7b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyre_check-0.9.1-py3-none-manylinux1_x86_64.whl
  • Upload date:
  • Size: 23.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.6.1 requests/2.25.1+fb6 setuptools/51.0.0 requests-toolbelt/0.8.0 tqdm/4.55.1 CPython/3.8.6

File hashes

Hashes for pyre_check-0.9.1-py3-none-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 4fe4db2baeb04cf22962df7df2305c1d00f9540811ed78ff419e0151afa010eb
MD5 b3b10b599065494221d83dc7ef492c87
BLAKE2b-256 b4007d7ad23844891256344b3a59b83f81441f7d6545a42edab40b894f6fb88a

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyre_check-0.9.1-py3-none-macosx_10_11_x86_64.whl
  • Upload date:
  • Size: 15.4 MB
  • Tags: Python 3, macOS 10.11+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.6.1 requests/2.25.1+fb6 setuptools/51.0.0 requests-toolbelt/0.8.0 tqdm/4.55.1 CPython/3.8.6

File hashes

Hashes for pyre_check-0.9.1-py3-none-macosx_10_11_x86_64.whl
Algorithm Hash digest
SHA256 7e1647f3e7540e971562771fc26e16073449dd8929acf98187033c5136220996
MD5 5b2877ae7ed2961eb4110ec7cf6cc0d9
BLAKE2b-256 6ed1339e459a00d04afb782377c09e1652945af77ce888b0d379c679c0daef0d

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