Compare commits

...

7 Commits

Author SHA1 Message Date
github-actions[bot]
4473a0cd91 📝 Update release notes
[skip ci]
2026-06-15 14:31:50 +00:00
Sebastián Ramírez
76876e5a81 🔧 Add ty configs to check docs sources (#15769) 2026-06-15 14:31:14 +00:00
Sebastián Ramírez
a82e5f2fac 🔖 Release version 0.137.1 (#15766)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-06-15 11:26:48 +00:00
github-actions[bot]
edd1461589 📝 Update release notes
[skip ci]
2026-06-15 11:20:24 +00:00
Sebastián Ramírez
b78c82262f 🚨 Fix typing checks for APIRoute (#15765) 2026-06-15 13:19:51 +02:00
github-actions[bot]
e0f8cadf09 📝 Update release notes
[skip ci]
2026-06-15 10:55:32 +00:00
Sebastián Ramírez
d8aad201eb 🐛 Fix bug, allow empty path in path operation in prefixless router (#15763) 2026-06-15 12:55:06 +02:00
7 changed files with 150 additions and 6 deletions

View File

@@ -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

View File

@@ -7,6 +7,17 @@ hide:
## Latest Changes
### Internal
* 🔧 Add ty configs to check docs sources. PR [#15769](https://github.com/fastapi/fastapi/pull/15769) by [@tiangolo](https://github.com/tiangolo).
## 0.137.1 (2026-06-15)
### Fixes
* 🚨 Fix typing checks for APIRoute. PR [#15765](https://github.com/fastapi/fastapi/pull/15765) by [@tiangolo](https://github.com/tiangolo).
* 🐛 Fix bug, allow empty path in path operation in prefixless router. PR [#15763](https://github.com/fastapi/fastapi/pull/15763) by [@tiangolo](https://github.com/tiangolo).
## 0.137.0 (2026-06-14)
### Breaking Changes

View File

@@ -1,6 +1,6 @@
"""FastAPI framework, high performance, easy to learn, fast to code, ready for production"""
__version__ = "0.137.0"
__version__ = "0.137.1"
from starlette import status as status

View File

@@ -1062,6 +1062,41 @@ def _populate_api_route_state(
class APIRoute(routing.Route):
stream_item_type: Any | None
response_model: Any
summary: str | None
response_description: str
deprecated: bool | None
operation_id: str | None
response_model_include: IncEx | None
response_model_exclude: IncEx | None
response_model_by_alias: bool
response_model_exclude_unset: bool
response_model_exclude_defaults: bool
response_model_exclude_none: bool
include_in_schema: bool
response_class: type[Response] | DefaultPlaceholder
dependency_overrides_provider: Any | None
callbacks: list[BaseRoute] | None
openapi_extra: dict[str, Any] | None
generate_unique_id_function: Callable[[Any], str] | DefaultPlaceholder
strict_content_type: bool | DefaultPlaceholder
tags: list[str | Enum]
responses: dict[int | str, dict[str, Any]]
unique_id: str
status_code: int | None
response_field: ModelField | None
stream_item_field: ModelField | None
dependencies: list[params.Depends]
description: str
response_fields: dict[int | str, ModelField]
dependant: Dependant
_flat_dependant: Dependant
_embed_body_fields: bool
body_field: ModelField | None
is_sse_stream: bool
is_json_stream: bool
def __init__(
self,
path: str,
@@ -2435,9 +2470,16 @@ class APIRouter(routing.Router):
"A path prefix must not end with '/', as the routes will start with '/'"
)
else:
for r in _iter_included_route_candidates(router.routes):
path = getattr(r, "path", None)
name = getattr(r, "name", "unknown")
for route, route_context in _iter_routes_with_context(router.routes):
if route_context is None:
path = getattr(route, "path", None)
name = getattr(route, "name", "unknown")
elif route_context.starlette_route is not None:
path = getattr(route_context.starlette_route, "path", None)
name = getattr(route_context.starlette_route, "name", "unknown")
else:
path = route_context.path
name = route_context.name
if path is not None and not path:
raise FastAPIError(
f"Prefix and path cannot be both empty (path operation: {name})"

View File

@@ -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

View File

@@ -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

View File

@@ -2,6 +2,7 @@ from typing import Annotated, cast
import pytest
from fastapi import APIRouter, Body, Depends, FastAPI, Request
from fastapi.exceptions import FastAPIError
from fastapi.responses import HTMLResponse, JSONResponse, PlainTextResponse
from fastapi.routing import (
APIRoute,
@@ -807,6 +808,60 @@ def test_no_prefix_include_validation_sees_effective_starlette_route_candidates(
assert cast(Route, candidates[0]).path == "/child/items"
def test_no_prefix_include_validation_sees_effective_api_route_path():
leaf_router = APIRouter()
@leaf_router.get("")
def read_items():
return []
parent_router = APIRouter()
parent_router.include_router(leaf_router, prefix="/items")
# for coverage
candidates = list(_iter_included_route_candidates(parent_router.routes))
assert cast(APIRoute, candidates[0]).path == ""
app = FastAPI()
app.include_router(parent_router)
client = TestClient(app)
response = client.get("/items")
assert response.status_code == 200, response.text
assert response.json() == []
def test_no_prefix_include_validation_sees_effective_starlette_route_path():
def endpoint(request):
return PlainTextResponse("ok")
child_router = APIRouter(routes=[Route("/items", endpoint, name="read_items")])
parent_router = APIRouter()
parent_router.include_router(child_router, prefix="/child")
app = FastAPI()
app.include_router(parent_router)
client = TestClient(app)
response = client.get("/child/items")
assert response.status_code == 200, response.text
assert response.text == "ok"
def test_no_prefix_include_validation_rejects_empty_effective_api_route_path():
router = APIRouter()
@router.get("")
def read_items(): # pragma: no cover
return []
app = FastAPI()
with pytest.raises(FastAPIError):
app.include_router(router)
def test_apirouter_matches_fallback_without_include_context():
router = APIRouter()