Simplify running checks locally

This patch refactors some of the GH workflow checks that we are running
in the gate to make it eaier to run locally. That way we can verify the
code prior to pushing it as a PR.

$ pdm verify

Signed-off-by: Lucas Alvares Gomes <lucasagomes@gmail.com>

Author: umago

.github/workflows/black.yaml

@@ -24,4 +24,4 @@ jobs:
       - name: Black version
         run: pdm run black --version
       - name: Black check
-        run: pdm run black . --check
+        run: make black

.github/workflows/mypy.yaml

@@ -17,7 +17,11 @@ jobs:
           python-version: '3.11'
       - name: Python version
         run: python --version
-      - name: Mypy installation
-        run: pip install --user mypy pydantic types-PyYAML
-      - name: Type checks
-        run: mypy --explicit-package-bases --disallow-untyped-calls --disallow-untyped-defs --disallow-incomplete-defs --ignore-missing-imports --disable-error-code attr-defined src/
+      - name: PDM installation
+        run: pip install --user pdm
+      - name: Install dependencies
+        run: pdm install
+      - name: Install devel dependencies
+        run: pdm install --group default,dev
+      - name: Python linter
+        run: make check-types

.github/workflows/pydocstyle.yaml

@@ -17,7 +17,11 @@ jobs:
           python-version: '3.11'
       - name: Python version
         run: python --version
-      - name: Pydocstyle install
-        run: pip install --user pydocstyle
-      - name: Python docstring checks
-        run: pydocstyle -v .
+      - name: PDM installation
+        run: pip install --user pdm
+      - name: Install dependencies
+        run: pdm install
+      - name: Install devel dependencies
+        run: pdm install --group default,dev
+      - name: Python linter
+        run: make docstyle

.github/workflows/pylint.yaml

@@ -25,4 +25,4 @@ jobs:
       - name: Install devel dependencies
         run: pdm install --group default,dev
       - name: Python linter
-        run: pdm run pylint src
+        run: make pylint

.github/workflows/pyright.yaml

@@ -25,4 +25,4 @@ jobs:
       - name: Install devel dependencies
         run: pdm install --group default,dev
       - name: Run Pyright tests
-        run: pdm run pyright src
+        run: make pyright

.github/workflows/ruff.yaml

@@ -12,7 +12,16 @@ jobs:
       pull-requests: read
     steps:
       - uses: actions/checkout@v4
-      - uses: chartboost/ruff-action@v1
+      - uses: actions/setup-python@v5
         with:
-          args: 'check . --per-file-ignores=tests/*:S101 --per-file-ignores=scripts/*:S101'
-
+          python-version: '3.11'
+      - name: Python version
+        run: python --version
+      - name: PDM installation
+        run: pip install --user pdm
+      - name: Install dependencies
+        run: pdm install
+      - name: Install devel dependencies
+        run: pdm install --group default,dev
+      - name: Python linter
+        run: make ruff

Makefile

@@ -16,7 +16,7 @@ test-integration: ## Run integration tests tests
 	COVERAGE_FILE="${ARTIFACT_DIR}/.coverage.integration" pdm run pytest tests/integration --cov=src --cov-report term-missing --cov-report "json:${ARTIFACT_DIR}/coverage_integration.json" --junit-xml="${ARTIFACT_DIR}/junit_integration.xml" --cov-fail-under=10
 
 check-types: ## Checks type hints in sources
-	MYPYPATH=src pdm run mypy --namespace-packages --explicit-package-bases --strict --disallow-untyped-calls --disallow-untyped-defs --disallow-incomplete-defs src
+	pdm run mypy --explicit-package-bases --disallow-untyped-calls --disallow-untyped-defs --disallow-incomplete-defs --ignore-missing-imports --disable-error-code attr-defined src/
 
 security-check: ## Check the project for security issues
 	bandit -c pyproject.toml -r src tests
@@ -43,3 +43,25 @@ shellcheck: ## Run shellcheck
 	shellcheck --version
 	shellcheck -- */*.sh
 
+black:
+	pdm run black --check .
+
+pylint:
+	pdm run pylint src
+
+pyright:
+	pdm run pyright src
+
+docstyle:
+	pdm run pydocstyle -v .
+
+ruff:
+	pdm run ruff check . --per-file-ignores=tests/*:S101 --per-file-ignores=scripts/*:S101
+
+verify:
+	$(MAKE) black
+	$(MAKE) pylint
+	$(MAKE) pyright
+	$(MAKE) ruff
+	$(MAKE) docstyle
+	$(MAKE) check-types

pdm.lock

@@ -26,6 +26,10 @@ dev = [
     "pytest-asyncio>=1.0.0",
     "pyright>=1.1.401",
     "pylint>=3.3.7",
+    "pydocstyle>=6.3.0",
+    "mypy>=1.16.0",
+    "types-PyYAML>=6.0.2",
+    "ruff>=0.11.13",
 ]
 
 [tool.pytest.ini_options]
@@ -47,4 +51,5 @@ distribution = true
 start = "pdm run make run"
 test-unit = "pdm run make test-unit"
 test-integration = "pdm run make test-integration"
+verify = "pdm run make verify"
 

pyproject.toml

@@ -127,9 +127,7 @@ def retrieve_response(
         stream=False,
     )
 
-    return str(
-        response.output_message.content  # pyright: ignore[reportAttributeAccessIssue]
-    )
+    return str(response.output_message.content)  # type: ignore[union-attr]
 
 
 def validate_attachments_metadata(attachments: list[Attachment]) -> None: