Unofficial python stubs for Pixar's Universal Scene Description (USD)
Project description
Unofficial python stubs for Pixar's Universal Scene Description (USD)
These stubs are designed to be used with a type checker like mypy
to provide static type checking of python code, as well as to provide analysis and completion in IDEs like PyCharm and VSCode (with Pylance).
Installing
pip install types-usd
The version of the package corresponds to the version of USD that it is generated from, plus a version suffix for the revision of the stubs
The stubs have been tested against a large USD codebase using mypy
, however, there
are still known issues that need to be resolved.
Using these stubs with mypy
will produce erros within the stubs themselves, mostly about
missing/unknown types. I've left these errors unsilenced as a reminder to fix them.
I recommend adding the following config to your mypy.ini
to silence these errors:
[mypy-pxr.*]
ignore_errors = true
If you find any other issues, please report them on the github issues page.
Developing
The stubs are created using information extracted from python signatures generated by boost-python in each function's docstring, combined with data parsed as from the USD C++ docs.
Currently, creating the stubs requires custom forks of mypy and USD, but I hope to have my changes merged into upstream soon.
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 types_usd-24.5.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e696c40f7aec7fa3f65f14d26345b9b747d9004616bcd9fb01c85d4bb52b3d68 |
|
MD5 | ea7ee4492d72583af9c42fd12592ac21 |
|
BLAKE2b-256 | a93877e716ff072350c3ae98da836e26080ffaf72e5da41c301dad55d23d8897 |