Unofficial stubs for the opencv-python package.
Project description
OpenCV stubs
Unofficial python stubs for the opencv-python package.
Official OpenCV stubs now exist (in OpenCV>=4.8, cf this issue and this PR), so this repo was archived from 2023/03/27 to 2024/04/13.
However I found the official stubs unhelpfull when it came to type hinting, so I'm un-archiving the repo.
This package includes all the functions, classes and constants (please open an issue if you find a missing one).
For some functions, OpenCV may handle more types than defined in this package. If you would like a type/function to be added or modified, please open an issue or a PR. There may also be a few errors as some types have been added programmatically. Please open an issue/PR if you see one.
The stubs include the docstrings as they are otherwise not available in IDEs (as far as I know).
Installation
The package is available on pypi here, you can install it with:
pip install opencv-stubs
The dependency on opencv is optional, and can be accessed with:
pip install opencv-stubs[opencv]
pip install opencv-stubs[opencv-contrib]
pip install opencv-stubs[opencv-headless]
Acknowledgements
A stub file with opencv functions can be found on the Microsoft stubs repo. This package reused those functions (with some added typing).
TODO:
- Do something about
cv2.gapi.cv
,cv2.utils.cv2
andcv2.mat_wrapper.cv
(do not duplicate everything if possible). - Handle cases like
cv2.misc.version.cv2.misc.version.cv2.misc.get_ocv_version()
. - Only include the
opencv-contrib
specific stubs when usingopencv-stubs[opencv-contrib]
.
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 opencv_stubs-0.0.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 470f979b7403e1766857fd21922f292a9b84450da90d2e498d63c6b59148d87e |
|
MD5 | 5d9ce01a5a2d58dbe7cb8a49d2d20820 |
|
BLAKE2b-256 | 69d2bde334d5d9a95dbda9038ae1c682529d66f4db554b0890e73881106fa7f4 |