Skip to main content

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.

Metadata

Release files for stubsplit 0.1

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

Source distribution (sdist)

Source distribution for stubsplit 0.1
File Size Uploaded
stubsplit-0.1.tar.gz 6.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for stubsplit 0.1
File Interpreter ABI Platform
stubsplit-0.1-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 12.5 kB

Release files / stubsplit-0.1.tar.gz

Download URL stubsplit-0.1.tar.gz
Size 6.2 kB
Tags Source
SHA-256 checksum
How to use checksums
53173f0e73f748d0126f7fedb904e8786d2f31d0a4e267d8c3cc75291ed02a32
BLAKE2b-256 checksum
How to use checksums
4959ccc052cfa7dd0e7c6b7f8fbb5ce9f73aaa8a2dc1f6fece35578597c7b7c3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.27.1

Release files / stubsplit-0.1-py2.py3-none-any.whl

Download URL stubsplit-0.1-py2.py3-none-any.whl
Size 6.3 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
65ffcaf9e6708c870f7c09cf155754938e565922ba40505660e718416d4f7ba1
BLAKE2b-256 checksum
How to use checksums
e5e90a39223d135680870d9f497ed56b519299f238f9b7ccf3edb65009c784f6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.27.1

Release history Release notifications | RSS feed

This release

0.1 This release

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