use git hooks to automatically run mypy and others

Author: attwad

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.8
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        args: [ --config-file=pyproject.toml ]
+        files: ^(pythonosc|examples)/
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 All notable changes to this project will be documented in this file.
- 
+
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased

CONTRIBUTING.md

@@ -7,6 +7,7 @@ TL;DR:
 -  Provide type annotations with mypy (`uv run mypy pythonosc examples`)
 -  Write and run tests with pytest (`uv run pytest`)
 -  Use [uv](https://docs.astral.sh/uv/) for package management and environment isolation
+-  Install and use [pre-commit](https://pre-commit.com/) to automatically run ruff before each commit (`uv run pre-commit install`)
 -  If you're adding a new feature, mention it in the [CHANGELOG.md](CHANGELOG.md) file under the _Unreleased_ section
 
-Please only send the PR once all of the above is done, thanks!
+Please only send the PR once all of the above is done, thanks!

docs/Makefile

@@ -16,4 +16,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/server.rst

@@ -130,4 +130,4 @@ Server Module Documentation
 .. automodule:: pythonosc.osc_tcp_server
   :special-members:
   :members:
-  :exclude-members: __weakref__
+  :exclude-members: __weakref__

pyproject.toml

@@ -32,6 +32,7 @@ dev = [
     "mypy",
     "ruff",
     "pytest-cov",
+    "pre-commit",
 ]
 
 [tool.uv.build-backend]

pythonosc/osc_message_builder.py

@@ -100,7 +100,7 @@ def add_arg(self, arg_value: ArgValue, arg_type: Optional[str] = None) -> None:
             arg_type = self._get_arg_type(arg_value)
         if isinstance(arg_type, list):
             self._args.append((self.ARG_TYPE_ARRAY_START, None))
-            for v, t in zip(arg_value, arg_type):  # type: ignore[arg-type]
+            for v, t in zip(arg_value, arg_type):  # type: ignore[arg-type, var-annotated]
                 self.add_arg(v, t)
             self._args.append((self.ARG_TYPE_ARRAY_STOP, None))
         else: