Skip to main content

typesplainer

A Python typehint explainer!

Available as a cli, as a website, as a vscode extension

PyPI Website Visual Studio Marketplace Version

Usage

First, install the package with pip install typesplainer

Then like any other tool such a black, isort. run typesplainer on your desired files or directory. It will automatically find all types and then explain them for you. e.g.

python -m typesplainer my_file.py
python -m typesplainer my_directory

Features

  • Very performant! Takes 1.7 seconds (YMMV) to explain the entire python rich library source code consisting of around 50,000 lines!
  • Colorized output. Output with colors is going to make sure your eyes feel refreshed.
  • Intelligent explanation. Takes pluralization, pronoun usage, article usage, correct grammar into account.
  • Best in class parser. It does not rely on some substandard AI based description generator, instead it parses the file using mypy's custom parser and shows the most accurate description

Contribute

Contributions are appreciated. See the TODO.md file or open issues

Release files for typesplainer 0.2.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for typesplainer 0.2.6
File Size Uploaded
typesplainer-0.2.6.tar.gz 8.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for typesplainer 0.2.6
File Interpreter ABI Platform
typesplainer-0.2.6-py3-none-any.whl Python 3 none any Details

Total release size: 15.6 kB

Release files / typesplainer-0.2.6.tar.gz

Download URL typesplainer-0.2.6.tar.gz
Size 8.1 kB
Tags Source
SHA-256 checksum
How to use checksums
eaaf8d35b4d563b804c0d61c4e4171755aff697f9671814f38ff4edbc5c3131e
BLAKE2b-256 checksum
How to use checksums
0c39eb70440f9aea320f31e3074adbaed9274943c7f5fd4e6755c77b5122b2a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

Release files / typesplainer-0.2.6-py3-none-any.whl

Download URL typesplainer-0.2.6-py3-none-any.whl
Size 7.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e2cb4c4c8f0b8c3d9615639532c9b62d29f6d2a87ac6f3d0d6519cb5bdcbd155
BLAKE2b-256 checksum
How to use checksums
93bb9f971cc536889ce8be2699a27843ae81bcc7294e88ae689c2b12889071db
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

Release history Release notifications | RSS feed

This release

0.2.6 This release

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page