Skip to main content

IPython extension type-checking IPython environments with beartype.

Project description

https://beartype.readthedocs.io

ipython-beartype

IPython extension type-checking IPython environments with beartype.

Installation

pip install ipython_beartype

Usage

Within an IPython / Jupyter notebook session, do the following:

%load_ext ipython_beartype
%beartype

All the type annotations in the following cells will be type checked.

Local Development / Testing

  • Create and activate a virtual environment
  • Run pip install -e .[dev] to do an editable install
  • Run pytest to run tests

Type Checking

Run mypy .

Credits

Thanks to knyazer and patrick-kidger for building the jaxtyping IPython extension, which was used as the base for this extension.

Also special thanks to leycec for creating beartype and the IPython team.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ipython_beartype-0.2.0.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ipython_beartype-0.2.0-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file ipython_beartype-0.2.0.tar.gz.

File metadata

  • Download URL: ipython_beartype-0.2.0.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ipython_beartype-0.2.0.tar.gz
Algorithm Hash digest
SHA256 83deb80fb90ee92138e3ebd3368d1b368fd4974c45cbd49c617a50b9172ef7e8
MD5 2dab1e68c7a1a18452e31b6d89c1466a
BLAKE2b-256 01ced214c97bdee971021b528b0d87758fe2540a764f0b85c0aa0749e5cf23a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for ipython_beartype-0.2.0.tar.gz:

Publisher: python_release.yml on beartype/ipython-beartype

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ipython_beartype-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ipython_beartype-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9f79b5264a8ccbaeba487639fb37d6818c9576a0d270f79b7f5a8e6ef352340c
MD5 ebde5826d2760b7d94e31775c14c9323
BLAKE2b-256 df52a63ad6df0d74ca74019b4f4498a5a00483cdaf2e5f17efea261d1f05e3b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for ipython_beartype-0.2.0-py3-none-any.whl:

Publisher: python_release.yml on beartype/ipython-beartype

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page