vsstubs 1.0.0__tar.gz

vsstubs-1.0.0/.gitignore

@@ -0,0 +1,215 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+.vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+
+# vsjet
+.vsjet
+
+# Test files (I know this is bad)
+test.*
+test_*.*

vsstubs-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Vardë
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vsstubs-1.0.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: vsstubs
+Version: 1.0.0
+Summary: Typing stubs for VapourSynth
+Project-URL: Homepage, https://github.com/Ichunjo/vs-stubs
+Project-URL: Repository, https://github.com/Ichunjo/vs-stubs
+Project-URL: Issues, https://github.com/Ichunjo/vs-stubs/issues
+Author-email: Vardë <ichunjo.le.terrible@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: python,stubs,typing
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Requires-Dist: rich
+Requires-Dist: typer
+Requires-Dist: vapoursynth>=73
+Description-Content-Type: text/markdown
+
+# vs-stubs
+
+**Typing stubs for [VapourSynth](http://www.vapoursynth.com/)**
+
+`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.
+
+---
+
+## Installation
+
+```bash
+pip install vsstubs
+```
+
+---
+
+## Usage
+
+You can use `vsstubs` via the command line or as a Python module.
+
+### Command Line
+
+```bash
+vsstubs
+```
+
+Example:
+
+```bash
+vsstubs -o output.pyi --template
+```
+
+### Python API
+
+```python
+from vsstubs import output_stubs
+
+# Example usage
+output_stubs(None, "output.pyi", template=True)
+```
+
+---
+
+## CLI Reference
+
+```
+ Usage: vsstubs [OPTIONS] COMMAND [ARGS]...
+
+ vs-stubs command line interface
+
+╭─ Options ──────────────────────────────────────────────────────────────────────────────────╮
+│ --template  -T        Export blank template; excludes existing plugins unless --load or    │
+│                       --add is used                                                        │
+│ --check     -C        Check for new plugins or new plugin signatures                       │
+│ --help                Show this message and exit.                                          │
+╰────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ I/O options ──────────────────────────────────────────────────────────────────────────────╮
+│ --input   -i,-I      PATH  Path to the input .pyi file                                     │
+│ --output  -o,-O      TEXT  Path to write the output .pyi file. Use '@' to overwrite the    │
+│                            input file.                                                     │
+│                            [default: (vapoursynth-stubs/__init__.pyi inside the            │
+│                            site-package folder)]                                           │
+│ --load    -L         PATH  Load plugins from a folder or a single library file             │
+╰────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Informations ─────────────────────────────────────────────────────────────────────────────╮
+│ --quiet              Suppress non-error output                                             │
+│ --version  -V        Show version info and exit                                            │
+╰────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ─────────────────────────────────────────────────────────────────────────────────╮
+│ add      Add or update the specified plugins in the stubs                                  │
+│ remove   Remove the specified plugins from the stubs                                       │
+╰────────────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+---
+
+## Examples
+
+- Simply update the VapourSynth stubs:
+
+  ```bash
+  vsstubs
+  ```
+
+- Generate a template stubs:
+
+  ```bash
+  vsstubs -o out.pyi --template
+  ```
+
+- Add plugin stubs:
+
+  ```bash
+  vsstubs -i out.pyi -o @ add resize2
+  ```
+
+- Remove plugin stubs (On Powershell you will need to escape the `@` character):
+
+  ```pwsh
+  vsstubs -i out.pyi -o "@" remove resize2
+  ```
+
+---
+
+## License
+
+MIT
+
+---
+
+## Why use this over `vsrepo genstubs`?
+
+- **Much faster** than `genstubs`.
+- **More accurate typing**: the generated stubs better reflect the actual signatures of plugins, core classes, and functions.
+- **Modern Python typing**.
+- Easier to **maintain** and **extend** than `genstubs`.
+- More **flexible workflow**: supports generating blank templates, checking for new plugin signatures, and selectively adding/removing plugins.

vsstubs-1.0.0/README.md

@@ -0,0 +1,117 @@
+# vs-stubs
+
+**Typing stubs for [VapourSynth](http://www.vapoursynth.com/)**
+
+`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.
+
+---
+
+## Installation
+
+```bash
+pip install vsstubs
+```
+
+---
+
+## Usage
+
+You can use `vsstubs` via the command line or as a Python module.
+
+### Command Line
+
+```bash
+vsstubs
+```
+
+Example:
+
+```bash
+vsstubs -o output.pyi --template
+```
+
+### Python API
+
+```python
+from vsstubs import output_stubs
+
+# Example usage
+output_stubs(None, "output.pyi", template=True)
+```
+
+---
+
+## CLI Reference
+
+```
+ Usage: vsstubs [OPTIONS] COMMAND [ARGS]...
+
+ vs-stubs command line interface
+
+╭─ Options ──────────────────────────────────────────────────────────────────────────────────╮
+│ --template  -T        Export blank template; excludes existing plugins unless --load or    │
+│                       --add is used                                                        │
+│ --check     -C        Check for new plugins or new plugin signatures                       │
+│ --help                Show this message and exit.                                          │
+╰────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ I/O options ──────────────────────────────────────────────────────────────────────────────╮
+│ --input   -i,-I      PATH  Path to the input .pyi file                                     │
+│ --output  -o,-O      TEXT  Path to write the output .pyi file. Use '@' to overwrite the    │
+│                            input file.                                                     │
+│                            [default: (vapoursynth-stubs/__init__.pyi inside the            │
+│                            site-package folder)]                                           │
+│ --load    -L         PATH  Load plugins from a folder or a single library file             │
+╰────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Informations ─────────────────────────────────────────────────────────────────────────────╮
+│ --quiet              Suppress non-error output                                             │
+│ --version  -V        Show version info and exit                                            │
+╰────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ─────────────────────────────────────────────────────────────────────────────────╮
+│ add      Add or update the specified plugins in the stubs                                  │
+│ remove   Remove the specified plugins from the stubs                                       │
+╰────────────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+---
+
+## Examples
+
+- Simply update the VapourSynth stubs:
+
+  ```bash
+  vsstubs
+  ```
+
+- Generate a template stubs:
+
+  ```bash
+  vsstubs -o out.pyi --template
+  ```
+
+- Add plugin stubs:
+
+  ```bash
+  vsstubs -i out.pyi -o @ add resize2
+  ```
+
+- Remove plugin stubs (On Powershell you will need to escape the `@` character):
+
+  ```pwsh
+  vsstubs -i out.pyi -o "@" remove resize2
+  ```
+
+---
+
+## License
+
+MIT
+
+---
+
+## Why use this over `vsrepo genstubs`?
+
+- **Much faster** than `genstubs`.
+- **More accurate typing**: the generated stubs better reflect the actual signatures of plugins, core classes, and functions.
+- **Modern Python typing**.
+- Easier to **maintain** and **extend** than `genstubs`.
+- More **flexible workflow**: supports generating blank templates, checking for new plugin signatures, and selectively adding/removing plugins.

vsstubs-1.0.0/pyproject.toml

@@ -0,0 +1,99 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "vsstubs"
+dynamic = ["version"]
+description = "Typing stubs for VapourSynth"
+readme = "README.md"
+requires-python = ">=3.13"
+license = { text = "MIT" }
+authors = [{ name = "Vardë", email = "ichunjo.le.terrible@gmail.com" }]
+keywords = ["stubs", "typing", "python"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Code Generators",
+    "Topic :: Utilities",
+    "Operating System :: OS Independent",
+    "Typing :: Typed",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+
+dependencies = ["vapoursynth>=73", "typer", "rich"]
+
+
+[project.urls]
+Homepage = "https://github.com/Ichunjo/vs-stubs"
+Repository = "https://github.com/Ichunjo/vs-stubs"
+Issues = "https://github.com/Ichunjo/vs-stubs/issues"
+
+[project.scripts]
+vsstubs = "vsstubs.cli:app"
+
+[dependency-groups]
+dev = ["mypy~=1.18.2", "ruff~=0.14.0", "twine"]
+
+[tool.hatch.version]
+path = "vsstubs/_version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["vsstubs"]
+include = ["vsstubs/_template/*.pyi", "vsstubs/py.typed"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "vsstubs",
+    "vsstubs/_template/*.pyi",
+    "pyproject.toml",
+    "README.md",
+    "LICENSE",
+]
+
+[tool.mypy]
+exclude = []
+# Flags changed by --strict
+warn_return_any = false
+extra_checks = false
+
+# Misc
+warn_unreachable = true
+
+allow_redefinition_new = true
+local_partial_types = true
+implicit_reexport = false
+strict = true
+
+show_column_numbers = true
+pretty = true
+color_output = true
+error_summary = true
+
+[tool.ruff]
+target-version = "py313"
+extend-exclude = []
+line-length = 120
+
+[tool.ruff.format]
+docstring-code-format = true
+exclude = ["test.pyi", "test2.pyi"]
+
+[tool.ruff.lint]
+exclude = []
+extend-select = ["E", "C4", "I", "PYI", "Q", "SIM", "N", "W", "RUF"]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.*" = ["F401", "F403"]
+"vsstubs/_template/**.pyi" = [
+    "PYI002",
+    "PYI046",
+    "PYI029",
+    "F822",
+    "N801",
+    "N805",
+]

vsstubs-1.0.0/vsstubs/__init__.py

@@ -0,0 +1,6 @@
+"""Typing stubs for VapourSynth."""
+
+from .cli import __version__
+from .func import output_stubs
+
+__all__ = ["__version__", "output_stubs"]

vsstubs-1.0.0/vsstubs/__main__.py

@@ -0,0 +1,4 @@
+from .cli import app
+
+if __name__ == "__main__":
+    app()

vsstubs-1.0.0/vsstubs/_template/__all__.pyi

@@ -0,0 +1,68 @@
+__all__ = [
+    "CHROMA_BOTTOM",
+    "CHROMA_BOTTOM_LEFT",
+    "CHROMA_CENTER",
+    "CHROMA_LEFT",
+    "CHROMA_TOP",
+    "CHROMA_TOP_LEFT",
+    "FIELD_BOTTOM",
+    "FIELD_PROGRESSIVE",
+    "FIELD_TOP",
+    "FLOAT",
+    "GRAY",
+    "GRAY8",
+    "GRAY9",
+    "GRAY10",
+    "GRAY12",
+    "GRAY14",
+    "GRAY16",
+    "GRAY32",
+    "GRAYH",
+    "GRAYS",
+    "INTEGER",
+    "NONE",
+    "RANGE_FULL",
+    "RANGE_LIMITED",
+    "RGB",
+    "RGB24",
+    "RGB27",
+    "RGB30",
+    "RGB36",
+    "RGB42",
+    "RGB48",
+    "RGBH",
+    "RGBS",
+    "YUV",
+    "YUV410P8",
+    "YUV411P8",
+    "YUV420P8",
+    "YUV420P9",
+    "YUV420P10",
+    "YUV420P12",
+    "YUV420P14",
+    "YUV420P16",
+    "YUV420PH",
+    "YUV420PS",
+    "YUV422P8",
+    "YUV422P9",
+    "YUV422P10",
+    "YUV422P12",
+    "YUV422P14",
+    "YUV422P16",
+    "YUV422PH",
+    "YUV422PS",
+    "YUV440P8",
+    "YUV444P8",
+    "YUV444P9",
+    "YUV444P10",
+    "YUV444P12",
+    "YUV444P14",
+    "YUV444P16",
+    "YUV444PH",
+    "YUV444PS",
+    "clear_output",
+    "clear_outputs",
+    "core",
+    "get_output",
+    "get_outputs",
+]