Skip to main content

StubSplit.

Project description

stubsplit is a simple utility which can remove docstrings from or insert docstrings into Python type stub files. It was originally created for the pandas type stubs shipped with pylance, which had some docstrings added because they were not available in the pandas package. It has since been replaced by a newer utility, docify, which does not rely on static files containing docstrings but can get the most up to date docstrings via reflection on the imported module. That said, stubsplit can still be useful for removing docstrings, e.g. from Python stubs generated by pyright.

The algorithm used is a blunt instrument (crude and kludgy parser) but "good enough" for the use cases we have applied it to. It would be better to rewrite this at some point using libcst but the effort is not currently merited.

Usage:
  stubsplit (split|merge) [--verbose] <stubpath> <docpath>
  stubsplit -h | --help
  stubsplit --version

Options:
  -h --help     Show this screen.
  --version     Show version.

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

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

Source Distribution

stubsplit-0.1.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

stubsplit-0.1-py2.py3-none-any.whl (6.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file stubsplit-0.1.tar.gz.

File metadata

  • Download URL: stubsplit-0.1.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.27.1

File hashes

Hashes for stubsplit-0.1.tar.gz
Algorithm Hash digest
SHA256 53173f0e73f748d0126f7fedb904e8786d2f31d0a4e267d8c3cc75291ed02a32
MD5 7b4e533f37aacd6e71a34d2e473179d5
BLAKE2b-256 4959ccc052cfa7dd0e7c6b7f8fbb5ce9f73aaa8a2dc1f6fece35578597c7b7c3

See more details on using hashes here.

File details

Details for the file stubsplit-0.1-py2.py3-none-any.whl.

File metadata

  • Download URL: stubsplit-0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.27.1

File hashes

Hashes for stubsplit-0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 65ffcaf9e6708c870f7c09cf155754938e565922ba40505660e718416d4f7ba1
MD5 7cf4624d814aacdd90c4e08349e88e14
BLAKE2b-256 e5e90a39223d135680870d9f497ed56b519299f238f9b7ccf3edb65009c784f6

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