Skip to content

rerun-io/ipython-beartype

 
 

Repository files navigation

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.

About

IPython extension type-checking IPython environments with @beartype

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 81.9%
  • Python 18.1%