Add type hints support (#355)

.github/workflows/ci.yml

@@ -32,6 +32,12 @@ jobs:
           pip install flake8
           flake8 .
 
+      - name: Type check with mypy
+        run: |
+          pip install mypy
+          mypy pyvips/__init__.pyi --no-error-summary
+          mypy examples/affine.py examples/convolve.py --no-error-summary
+
       - name: Install tox and any other packages
         run: pip install tox
 

CHANGELOG.rst

@@ -3,6 +3,7 @@
 - fix get_gainmap arguments [jcupitt]
 - fix __array__ copy argument test [jcupitt]
 - add a test [jcupitt]
+- add type stub generation script with support for all libvips operations [AI Assistant]
 
 ## Version 3.1.0 (released 8 December 2025)
 

README.rst

@@ -228,6 +228,30 @@ Stylecheck:
 
     $ flake8
 
+Stylecheck:
+
+.. code-block:: shell
+
+    $ flake8
+
+Type checking:
+
+pyvips includes type hints via PEP 561 type stub files (``pyvips/__init__.pyi``).
+To enable type checking in your project, install a type checker like mypy:
+
+.. code-block:: shell
+
+    $ pip install mypy pyvips
+
+Then run mypy on your code:
+
+.. code-block:: shell
+
+    $ mypy your_script.py
+
+Note: ``pyvips`` methods accept arbitrary keyword arguments for libvips options,
+which may not be fully covered by type hints.
+
 Generate HTML docs in ``doc/build/html``:
 
 .. code-block:: shell
@@ -246,6 +270,16 @@ then
 
 Then check and move `enums.py` into `pyvips/`.
 
+Regenerate type stubs:
+
+After adding new libvips operations or updating libvips itself, regenerate type stubs:
+
+.. code-block:: shell
+
+    $ python examples/generate_type_stubs.py
+
+This updates ``pyvips/__init__.pyi`` with the latest operations.
+
 Regenerate autodocs:
 
 Make sure you have installed a libvips with all optional packages enabled,