vs-stubs
Typing stubs for VapourSynth
vs-stubs provides Python type stubs for VapourSynth plugins and core functions.
This helps editors, IDEs, and static type checkers (e.g. mypy, pyright) understand VapourSynth's API.
Due to the dynamic nature of VapourSynth's plugin system, any newly installed plugins are not automatically reflected in the stubs. When adding plugins, you will need to regenerate stubs to keep the type information accurate and in sync with your environment.
Note that vs-stubs does not include or install any actual VapourSynth plugins. Only their type definitions.
[!TIP] A VS Code extension is also available here (which can automatically regenerate stubs for you).
Installation
pip install vsstubs
Usage
You can use vsstubs via the command line or as a Python module.
Command Line
-
Simply update the VapourSynth stubs:
vsstubs
-
Installing from the wheel output for a proper installation:
pip install $(vsstubs --wheel)
--wheelbuilds an installablevapoursynth-stubswheel instead of writing a.pyifile directly.By default, the wheel is created in a temporary directory and the wheel path is printed to stdout, which lets shells pass it straight to
pip install.Use
--outputwith--wheelto choose the directory where the wheel should be built:vsstubs --wheel --output dist
When
--wheelis enabled,--outputmust be a directory path. The special output values@and-are only for direct.pyioutput and cannot be used with wheel output. -
Generate a template stubs:
vsstubs -o out.pyi --template
-
Add plugin stubs:
vsstubs -i out.pyi -o @ add resize2
-
Remove plugin stubs (On Powershell you will need to escape the
@character):vsstubs -i out.pyi -o "@" remove resize2
Python API
from vsstubs import output_stubs
# Example usage
output_stubs(None, "output.pyi", template=True)
CLI Reference
Add command
Check command
Plugins command
Remove command
Update command
1 maintainer
Release files for vsstubs 2.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| vsstubs-2.3.1.tar.gz | 36.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| vsstubs-2.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 67.3 kB
Release files / vsstubs-2.3.1.tar.gz
| Download URL | vsstubs-2.3.1.tar.gz |
|---|---|
| Size | 36.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
182b8c90f34429bd695511a1a181b0c922d52e28c3d35d95ab71714b241da702
|
|
BLAKE2b-256 checksum How to use checksums |
282cfa06eac27cc26300acdc41881cf01fac62c9d2c22bddbe7d2b1b836a189f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency logRelease files / vsstubs-2.3.1-py3-none-any.whl
| Download URL | vsstubs-2.3.1-py3-none-any.whl |
|---|---|
| Size | 31.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d84f8d242d567d1607bc19e1120107eed2f723c6b3835dc1cbc14f9bc014654e
|
|
BLAKE2b-256 checksum How to use checksums |
8615a9cebfaeed1cbe7dfb31ad3f881082245c588264ba4b5b58f946cd343891
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency log
