Lint with ruff, pyright and mypy the examples and extra folders (#226)

Author: amenasria

.github/workflows/lint_custom_code.yaml

@@ -21,12 +21,14 @@ jobs:
         with:
           python-version: '3.12'
 
-      - name: Install ruff
-        run: pip install ruff
+      - name: Install Poetry
+        uses: snok/install-poetry@76e04a911780d5b312d89783f7b1cd627778900a # v1.4.1
 
-      - name: Lint with ruff
-        # No need to lint the automatically generated Speakeasy code
+      - name: Install dependencies
         run: |
-          ruff check examples/
-          ruff check src/mistralai/_hooks/ --exclude __init__.py --exclude sdkhooks.py --exclude types.py
-          ruff check src/mistralai/extra/
+          touch README-PYPI.md
+          poetry install
+
+      # The init, sdkhooks.py and types.py files in the _hooks folders are generated by Speakeasy hence the exclusion
+      - name: Run all linters
+        run: scripts/lint_custom_code.sh

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.11.10
+  hooks:
+    - id: ruff
+      args: [--fix]
+      files: ^(example/|src/mistralai/).*\.py$
+      exclude: ^src/mistralai/(__init__|sdkhooks|types)\.py$
+- repo: https://github.com/RobertCraigie/pyright-python
+  rev: v1.1.401
+  hooks:
+    - id: pyright
+      files: ^(example/|src/mistralai/).*\.py$
+      exclude: ^src/mistralai/(__init__|sdkhooks|types)\.py$
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.15.0
+  hooks:
+    - id: mypy
+      files: ^(example/|src/mistralai/).*\.py$
+      exclude: ^src/mistralai/(__init__|sdkhooks|types)\.py$

poetry.lock

@@ -29,12 +29,18 @@ include = ["py.typed", "src/mistralai/py.typed"]
 in-project = true
 
 [tool.poetry.group.dev.dependencies]
-mypy = "==1.14.1"
+mypy = "==1.15.0"
 pylint = "==3.2.3"
 pytest = "^8.2.2"
 pytest-asyncio = "^0.23.7"
 types-python-dateutil = "^2.9.0.20240316"
 
+[tool.poetry.group.lint.dependencies]
+ruff = "^0.11.10"
+pyright = "^1.1.401"
+mypy = "==1.15.0"
+
+
 [project.optional-dependencies]
 gcp = [
     "google-auth >=2.27.0",

pyproject.toml

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+set -e
+
+ERRORS=0
+
+echo "Running mypy..."
+# TODO: Uncomment once the examples are fixed
+# poetry run mypy examples/ || ERRORS=1
+poetry run mypy src/mistralai/extra/ || ERRORS=1
+poetry run mypy src/mistralai/_hooks/ \
+--exclude __init__.py --exclude sdkhooks.py --exclude types.py || ERRORS=1
+
+echo "Running pyright..."
+# TODO: Uncomment once the examples are fixed
+# poetry run pyright examples/ || ERRORS=1
+poetry run pyright src/mistralai/extra/ || ERRORS=1
+poetry run pyright src/mistralai/_hooks/ || ERRORS=1
+
+echo "Running ruff..."
+poetry run ruff check examples/ || ERRORS=1
+poetry run ruff check src/mistralai/extra/ || ERRORS=1
+poetry run ruff check src/mistralai/_hooks/ \
+--exclude __init__.py --exclude sdkhooks.py --exclude types.py || ERRORS=1
+
+if [ "$ERRORS" -ne 0 ]; then
+echo "❌ One or more linters failed"
+exit 1
+else
+echo "✅ All linters passed"
+fi