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

Uploaded Source

Built Distributions

pyre_check-0.0.54-py3-none-manylinux1_x86_64.whl (24.6 MB view details)

Uploaded Python 3

pyre_check-0.0.54-py3-none-macosx_10_11_x86_64.whl (16.1 MB view details)

Uploaded Python 3 macOS 10.11+ x86-64

File details

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

File metadata

  • Download URL: pyre-check-0.0.54.tar.gz
  • Upload date:
  • Size: 15.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 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.54.tar.gz
Algorithm Hash digest
SHA256 d4b8c3310ec4ff62556b575ee4faed11727a1ed750c8c8908bfdfe3f940da6bb
MD5 7f7e5ef95a6dbfb5cf43f3f3ea796fba
BLAKE2b-256 90967eb14fba345c1b2b136b22d37407b61e72697852c56293c7c862cd5e9403

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyre_check-0.0.54-py3-none-manylinux1_x86_64.whl
  • Upload date:
  • Size: 24.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 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.54-py3-none-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 a3d641ba217eded90b29a44ad9042101446539537d192d8d5b25e5f95ceb889a
MD5 9059a5ba47f4e26c56e323d3c46bf4fd
BLAKE2b-256 1cc09e2cd3be66f4040a07040b4460d038477d0a83dc4b63dec700daad6573ef

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyre_check-0.0.54-py3-none-macosx_10_11_x86_64.whl
  • Upload date:
  • Size: 16.1 MB
  • Tags: Python 3, macOS 10.11+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 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.54-py3-none-macosx_10_11_x86_64.whl
Algorithm Hash digest
SHA256 247f96648a6da127dcf16e8ccdef7c0d7fd6a439d08c468da23e608569ae1052
MD5 ef2568269949abaf109a9e4d50049c10
BLAKE2b-256 6fe1345176173cb30dd655da56f0776031505062d82fd9f98ca9677583f5b106

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