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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for stubsplit-0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65ffcaf9e6708c870f7c09cf155754938e565922ba40505660e718416d4f7ba1 |
|
MD5 | 7cf4624d814aacdd90c4e08349e88e14 |
|
BLAKE2b-256 | e5e90a39223d135680870d9f497ed56b519299f238f9b7ccf3edb65009c784f6 |