Unofficial stubs for the opencv-python package.
Project description
OpenCV stubs
Unofficial python stubs for the opencv-python package.
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 progrmmatically. Please open an issue if you see one.
The typing is still a work in progress, if you want a function/method to be added first you can open an issue.
The stubs include the docstrings as they are otherwise not available in the IDE (as far as I know).
These stubs are a temporary help until official ones are made (see this issue and this PR).
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
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.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c9ff5b91c6891b9a43ac5e8615dbd824a74db9903fea5eb0cfd564d65b6f314 |
|
MD5 | 89cdf1d5aad0184050ae6d1da9ce3654 |
|
BLAKE2b-256 | ce5bd7082c461342202caf6a728531fcdb2e50837c082d5a36d5e10ef4249445 |