PEP 561 type stubs generator for pybind11 modules
Project description
About
Generates stubs for python modules
There are several tweaks to target specifically modules compiled using pybind11
Package targets python3 only. (In fact, it’s compatible with python2 but it’s not officially supported)
Issues/PR are welcome
Install
From PYPI:
python -m pip install pybind11-stubgen
From github:
python -m pip install git+https://github.com/sizmailov/pybind11-stubgen.git
Usage
pybind11-stubgen [-h] [-o OUTPUT_DIR] \
[--root-module-suffix ROOT_MODULE_SUFFIX] \
[--no-setup-py] \
[--ignore-invalid {signature,defaultarg,all} [{signature,defaultarg,all} ...]] \
[--skip-signature-downgrade] \
[--bare-numpy-ndarray] \
[--log-level LOG_LEVEL] \
MODULE_NAME [MODULE_NAME ...]
Customization
If you need some docstring pre-processing, or you find the hard-coded pybind11-stubgen defaults to be off, you can make the adjustments using a tiny wrapper, see examples below.
Customization examples
Strip a license from docstring
import pybind11_stubgen
import re
license_pattern = re.compile(r"EXAMPLE CORP LICENCE")
def strip_license(docstring: str):
return license_pattern.sub("", docstring)
if __name__ == '__main__':
pybind11_stubgen.function_docstring_preprocessing_hooks.append(
strip_license
)
pybind11_stubgen.main()
Replace List[int[3]] with Annotated[List[int], FixedSize(3)]
import pybind11_stubgen
import re
std_array_pattern = re.compile(r"List\[(int|complex|float)[(\d+)]]")
def std_array_fix(match: re.Match):
return f"Annotated[List[{match.group(0)}], FixedSize({match.group(1)})]"
def strip_dimension_from_std_array(docstring: str):
return std_array_pattern.sub(std_array_fix, docstring)
if __name__ == '__main__':
pybind11_stubgen.function_docstring_preprocessing_hooks.append(
strip_dimension_from_std_array
)
pybind11_stubgen.main()
Replace one type with another
import pybind11_stubgen
import re
def library_b_replacement(match: re.Match):
type_name = match.group(0)
return f"library_b.types.{type_name}"
if __name__ == '__main__':
pybind11_stubgen.StubsGenerator.GLOBAL_CLASSNAME_REPLACEMENTS[
re.compile(r"library_a\.types\.(\w+)")
] = library_b_replacement
pybind11_stubgen.main()
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
pybind11-stubgen-0.16.1.tar.gz
(14.2 kB
view hashes)
Built Distribution
Close
Hashes for pybind11_stubgen-0.16.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2cc6b4c9bc81b7c0520e3c007ac361ea20c72efe3e36b78c9354be84edb5e419 |
|
MD5 | 459fc3d93e0eef1a979be88087a11a4d |
|
BLAKE2b-256 | e029c00dc1cb7df20509239a4776e2f5f4078c1a16cee7777918941933626272 |