Skip to main content


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.

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

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

Project details

Release history Release notifications | RSS feed

This version


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 hashes)

Uploaded source

Built Distribution

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

Uploaded py2 py3

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