From 76876e5a812268860148ba3a2059795b4d65ae55 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Mon, 15 Jun 2026 16:31:14 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=94=A7=20Add=20ty=20configs=20to=20check?= =?UTF-8?q?=20docs=20sources=20(#15769)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .pre-commit-config.yaml | 2 +- pyproject.toml | 36 ++++++++++++++++++++++++++++++++++++ scripts/lint.sh | 2 +- 3 files changed, 38 insertions(+), 2 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0cb5b86e3d..de6f56a537 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -45,7 +45,7 @@ repos: - id: local-ty name: ty check - entry: uv run ty check fastapi + entry: uv run ty check fastapi docs_src --force-exclude require_serial: true language: unsupported pass_filenames: false diff --git a/pyproject.toml b/pyproject.toml index daa523ce28..8b633a928c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -349,5 +349,41 @@ havin = "havin" Ines = "Ines" ser = "ser" +[tool.ty.src] +exclude = [ + # These docs examples are intentionally partial, dynamic, environment-driven, + # deprecated, or currently require broader tutorial rewrites to satisfy ty. + "docs_src/additional_status_codes/", + "docs_src/app_testing/tutorial003_py310.py", + "docs_src/body_multiple_params/", + "docs_src/body_updates/tutorial002_py310.py", + "docs_src/custom_docs_ui/", + "docs_src/custom_response/tutorial001_py310.py", + "docs_src/custom_response/tutorial001b_py310.py", + "docs_src/custom_response/tutorial009c_py310.py", + "docs_src/dependencies/tutorial007_py310.py", + "docs_src/dependencies/tutorial008_an_py310.py", + "docs_src/dependencies/tutorial008_py310.py", + "docs_src/dependencies/tutorial010_py310.py", + "docs_src/events/", + "docs_src/extending_openapi/tutorial001_py310.py", + "docs_src/path_params_numeric_validations/", + "docs_src/pydantic_v1_in_v2/tutorial004_an_py310.py", + "docs_src/python_types/tutorial003_py310.py", + "docs_src/python_types/tutorial011_py310.py", + "docs_src/query_params_str_validations/", + "docs_src/response_model/tutorial006_py310.py", + "docs_src/security/tutorial003_an_py310.py", + "docs_src/security/tutorial003_py310.py", + "docs_src/security/tutorial004_an_py310.py", + "docs_src/security/tutorial004_py310.py", + "docs_src/security/tutorial005_an_py310.py", + "docs_src/security/tutorial005_py310.py", + "docs_src/settings/", + "docs_src/sql_databases/", + "docs_src/using_request_directly/tutorial001_py310.py", + "docs_src/wsgi/tutorial001_py310.py", +] + [tool.ty.terminal] error-on-warning = true diff --git a/scripts/lint.sh b/scripts/lint.sh index a4d3422d3a..291674e32e 100755 --- a/scripts/lint.sh +++ b/scripts/lint.sh @@ -4,6 +4,6 @@ set -e set -x mypy fastapi -ty check fastapi +ty check fastapi docs_src --force-exclude ruff check fastapi tests docs_src scripts ruff format fastapi tests --check