Skip to main content

Type stubs for oiio-python

Project description

🔍 types-oiio-python

Type stubs for OpenImageIO Python bindings!

This package provides type stubs for oiio-python, enabling static type checking and better IDE support for OpenImageIO and OpenColorIO Python bindings.


Features

  • 🎯 Complete Type Coverage: Type hints for OpenImageIO and PyOpenColorIO modules
  • 🚀 IDE Support: Enhanced code completion and type checking
  • ✨ MyPy Compatible: Full support for static type checking
  • 🔄 Version Matched: Stubs versions match oiio-python releases

Installation

pip install types-oiio-python

It is recommended to add this package to your project development dependencies.

Usage

Once installed, MyPy and your most IDEs will automatically use these stubs for type checking and code completion.

Autocomplete Type Checking
first second
(Example in VS Code) (Example in VS Code)

Note for Pylint users

Unfortunately Pylint does not (yet) support the use of stubs int the .pyi format.

If you use Pylint, you will need to add the following to your .pylintrc file:

extension-pkg-whitelist=OpenImageIO,PyOpenColorIO

To avoid getting E1101:no-member errors when using compiled modules.

Version Compatibility

The version numbers match the corresponding oiio-python releases. For example:

  • types-oiio-python 2.5.12.0.x corresponds to oiio-python 2.5.12.0.x

Development Notes

  • The stubs are generated using mypy's stubgen tool.
  • Included generate_stubs.py script is used to generate stubs for OpenImageIO and OpenColorIO modules.
  • Manual adjustments are made to improve the generated stubs.
  1. Clone the repository
  2. Install in interactive mode with dev dependencies
    pip install -e .[dev]
    
  3. Test the stubs with MyPy stubtest
    stubtest OpenImageIO --allowlist oiio-mypy-baseline.txt
    stubtest PyOpenColorIO --allowlist ocio-mypy-baseline.txt
    

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

types_oiio_python-3.0.2.0.1.tar.gz (30.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

types_oiio_python-3.0.2.0.1-py3-none-any.whl (29.2 kB view details)

Uploaded Python 3

File details

Details for the file types_oiio_python-3.0.2.0.1.tar.gz.

File metadata

  • Download URL: types_oiio_python-3.0.2.0.1.tar.gz
  • Upload date:
  • Size: 30.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.8.19

File hashes

Hashes for types_oiio_python-3.0.2.0.1.tar.gz
Algorithm Hash digest
SHA256 74140f4da4b3dd4b0e5644be46cc35b73fff346c993e80dc8f4bd26eaf3dca43
MD5 c1d0f8e815abe5516c15a8bff3fcde4d
BLAKE2b-256 9edae2840693d889221aabfbb2973fc00325a60b68d92f5cdbb081f2692b2acd

See more details on using hashes here.

File details

Details for the file types_oiio_python-3.0.2.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for types_oiio_python-3.0.2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e9e6337880ffcf87948ffd649cc89fb1f7c61ce2e70a0c57299c7a0cbb442d4a
MD5 f3c2a9852b564b53f3fe20aa9cecae4e
BLAKE2b-256 bcb935dd3cc558077fc98462667554ac8b06c0b6238b2b8ee6399ab68172fd22

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page