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:

$ 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.60.tar.gz (14.5 MB view details)

Uploaded Source

Built Distributions

pyre_check-0.0.60-py3-none-manylinux1_x86_64.whl (23.4 MB view details)

Uploaded Python 3

pyre_check-0.0.60-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.0.60.tar.gz.

File metadata

  • Download URL: pyre-check-0.0.60.tar.gz
  • Upload date:
  • Size: 14.5 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.0.60.tar.gz
Algorithm Hash digest
SHA256 2a2112315f3a5670d4de9dd95773207b1f5e70b432a47208c50462edea6c16d3
MD5 19f3a7febde93326eacb29ec8bb858bd
BLAKE2b-256 7f08672ad37fd972b77dbce4dbaf95961af7b7614db47f7922c2ee82f01c2858

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyre_check-0.0.60-py3-none-manylinux1_x86_64.whl
  • Upload date:
  • Size: 23.4 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.0.60-py3-none-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 76de7d42ffaecc4e6400968d9c8ca8279678c522609a4a5e51eb8e9a303a9202
MD5 4b642c566ce038848ec44cb9b4c691d4
BLAKE2b-256 049dab4f28e2458b80018d34312eda7754c12615462322a4d7937072d0ffb835

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyre_check-0.0.60-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.0.60-py3-none-macosx_10_11_x86_64.whl
Algorithm Hash digest
SHA256 4b153b57a6512c3b8fdda17f5b7d8756f99a180b08b0b38a730bdc0e07a38980
MD5 bc79c735fca541784affcf309af8ae35
BLAKE2b-256 77a4287c0004db01cfde44a8a3f63ee9c542197944aa86e0144bb9daebd401d2

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