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.

PyPI Downloads


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.10.0.1.tar.gz (30.5 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.10.0.1-py3-none-any.whl (29.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: types_oiio_python-3.0.10.0.1.tar.gz
  • Upload date:
  • Size: 30.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for types_oiio_python-3.0.10.0.1.tar.gz
Algorithm Hash digest
SHA256 fbe643d2c84a89a270763e38279e0b2164ddafa736d8721421c9e274aaf46e42
MD5 5e6617b3e471dfd7a220b6d1409eecfa
BLAKE2b-256 0bfcefaeff602d100f3af737860004293c8b7e50bc049f952a348bede564ae14

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for types_oiio_python-3.0.10.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a0db017f2f9dca807e4e255bcd61197f0ac8cddf4ceade94ee4f6a6feedbaffd
MD5 ecf86eee73d8cb9b1692b6d4634ad6f3
BLAKE2b-256 99226e9ed55ff638bfcbce3993e395063af1f3139d75516d9d7c265d07264b71

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