Skip to main content

Python typehint explainer

Project description

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

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

typesplainer-0.2.6.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

typesplainer-0.2.6-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file typesplainer-0.2.6.tar.gz.

File metadata

  • Download URL: typesplainer-0.2.6.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for typesplainer-0.2.6.tar.gz
Algorithm Hash digest
SHA256 eaaf8d35b4d563b804c0d61c4e4171755aff697f9671814f38ff4edbc5c3131e
MD5 dd36341d8bbd39d2532ae99d751f309f
BLAKE2b-256 0c39eb70440f9aea320f31e3074adbaed9274943c7f5fd4e6755c77b5122b2a2

See more details on using hashes here.

File details

Details for the file typesplainer-0.2.6-py3-none-any.whl.

File metadata

  • Download URL: typesplainer-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using 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

File hashes

Hashes for typesplainer-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e2cb4c4c8f0b8c3d9615639532c9b62d29f6d2a87ac6f3d0d6519cb5bdcbd155
MD5 639902cadee97bb4bee0cc7c0dfebc8e
BLAKE2b-256 93bb9f971cc536889ce8be2699a27843ae81bcc7294e88ae689c2b12889071db

See more details on using hashes here.

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