From 70bec360aafcd0c659be1a9e5c6f24b6f6d04086 Mon Sep 17 00:00:00 2001 From: junah201 Date: Fri, 24 Jan 2025 04:18:45 +0900 Subject: [PATCH 1/2] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Replace=20float=20with?= =?UTF-8?q?=20SupportsGt,=20SupportsGe,=20SupportsLt,=20SupportsLe=20for?= =?UTF-8?q?=20better=20type=20consistency?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- fastapi/param_functions.py | 57 +++++++++++++++++---------------- fastapi/params.py | 65 +++++++++++++++++++------------------- 2 files changed, 62 insertions(+), 60 deletions(-) diff --git a/fastapi/param_functions.py b/fastapi/param_functions.py index b3621626c..3c618e30c 100644 --- a/fastapi/param_functions.py +++ b/fastapi/param_functions.py @@ -1,5 +1,6 @@ from typing import Any, Callable, Dict, List, Optional, Sequence, Union +from annotated_types import SupportsGe, SupportsGt, SupportsLe, SupportsLt from fastapi import params from fastapi._compat import Undefined from fastapi.openapi.models import Example @@ -90,7 +91,7 @@ def Path( # noqa: N802 ), ] = None, gt: Annotated[ - Optional[float], + Optional[SupportsGt], Doc( """ Greater than. If set, value must be greater than this. Only applicable to @@ -99,7 +100,7 @@ def Path( # noqa: N802 ), ] = None, ge: Annotated[ - Optional[float], + Optional[SupportsGe], Doc( """ Greater than or equal. If set, value must be greater than or equal to @@ -108,7 +109,7 @@ def Path( # noqa: N802 ), ] = None, lt: Annotated[ - Optional[float], + Optional[SupportsLt], Doc( """ Less than. If set, value must be less than this. Only applicable to numbers. @@ -116,7 +117,7 @@ def Path( # noqa: N802 ), ] = None, le: Annotated[ - Optional[float], + Optional[SupportsLe], Doc( """ Less than or equal. If set, value must be less than or equal to this. @@ -415,7 +416,7 @@ def Query( # noqa: N802 ), ] = None, gt: Annotated[ - Optional[float], + Optional[SupportsGt], Doc( """ Greater than. If set, value must be greater than this. Only applicable to @@ -424,7 +425,7 @@ def Query( # noqa: N802 ), ] = None, ge: Annotated[ - Optional[float], + Optional[SupportsGe], Doc( """ Greater than or equal. If set, value must be greater than or equal to @@ -433,7 +434,7 @@ def Query( # noqa: N802 ), ] = None, lt: Annotated[ - Optional[float], + Optional[SupportsLt], Doc( """ Less than. If set, value must be less than this. Only applicable to numbers. @@ -441,7 +442,7 @@ def Query( # noqa: N802 ), ] = None, le: Annotated[ - Optional[float], + Optional[SupportsLe], Doc( """ Less than or equal. If set, value must be less than or equal to this. @@ -730,7 +731,7 @@ def Header( # noqa: N802 ), ] = None, gt: Annotated[ - Optional[float], + Optional[SupportsGt], Doc( """ Greater than. If set, value must be greater than this. Only applicable to @@ -739,7 +740,7 @@ def Header( # noqa: N802 ), ] = None, ge: Annotated[ - Optional[float], + Optional[SupportsGe], Doc( """ Greater than or equal. If set, value must be greater than or equal to @@ -748,7 +749,7 @@ def Header( # noqa: N802 ), ] = None, lt: Annotated[ - Optional[float], + Optional[SupportsLt], Doc( """ Less than. If set, value must be less than this. Only applicable to numbers. @@ -756,7 +757,7 @@ def Header( # noqa: N802 ), ] = None, le: Annotated[ - Optional[float], + Optional[SupportsLe], Doc( """ Less than or equal. If set, value must be less than or equal to this. @@ -1035,7 +1036,7 @@ def Cookie( # noqa: N802 ), ] = None, gt: Annotated[ - Optional[float], + Optional[SupportsGt], Doc( """ Greater than. If set, value must be greater than this. Only applicable to @@ -1044,7 +1045,7 @@ def Cookie( # noqa: N802 ), ] = None, ge: Annotated[ - Optional[float], + Optional[SupportsGe], Doc( """ Greater than or equal. If set, value must be greater than or equal to @@ -1053,7 +1054,7 @@ def Cookie( # noqa: N802 ), ] = None, lt: Annotated[ - Optional[float], + Optional[SupportsLt], Doc( """ Less than. If set, value must be less than this. Only applicable to numbers. @@ -1061,7 +1062,7 @@ def Cookie( # noqa: N802 ), ] = None, le: Annotated[ - Optional[float], + Optional[SupportsLe], Doc( """ Less than or equal. If set, value must be less than or equal to this. @@ -1362,7 +1363,7 @@ def Body( # noqa: N802 ), ] = None, gt: Annotated[ - Optional[float], + Optional[SupportsGt], Doc( """ Greater than. If set, value must be greater than this. Only applicable to @@ -1371,7 +1372,7 @@ def Body( # noqa: N802 ), ] = None, ge: Annotated[ - Optional[float], + Optional[SupportsGe], Doc( """ Greater than or equal. If set, value must be greater than or equal to @@ -1380,7 +1381,7 @@ def Body( # noqa: N802 ), ] = None, lt: Annotated[ - Optional[float], + Optional[SupportsLt], Doc( """ Less than. If set, value must be less than this. Only applicable to numbers. @@ -1388,7 +1389,7 @@ def Body( # noqa: N802 ), ] = None, le: Annotated[ - Optional[float], + Optional[SupportsLe], Doc( """ Less than or equal. If set, value must be less than or equal to this. @@ -1677,7 +1678,7 @@ def Form( # noqa: N802 ), ] = None, gt: Annotated[ - Optional[float], + Optional[SupportsGt], Doc( """ Greater than. If set, value must be greater than this. Only applicable to @@ -1686,7 +1687,7 @@ def Form( # noqa: N802 ), ] = None, ge: Annotated[ - Optional[float], + Optional[SupportsGe], Doc( """ Greater than or equal. If set, value must be greater than or equal to @@ -1695,7 +1696,7 @@ def Form( # noqa: N802 ), ] = None, lt: Annotated[ - Optional[float], + Optional[SupportsLt], Doc( """ Less than. If set, value must be less than this. Only applicable to numbers. @@ -1703,7 +1704,7 @@ def Form( # noqa: N802 ), ] = None, le: Annotated[ - Optional[float], + Optional[SupportsLe], Doc( """ Less than or equal. If set, value must be less than or equal to this. @@ -1991,7 +1992,7 @@ def File( # noqa: N802 ), ] = None, gt: Annotated[ - Optional[float], + Optional[SupportsGt], Doc( """ Greater than. If set, value must be greater than this. Only applicable to @@ -2000,7 +2001,7 @@ def File( # noqa: N802 ), ] = None, ge: Annotated[ - Optional[float], + Optional[SupportsGe], Doc( """ Greater than or equal. If set, value must be greater than or equal to @@ -2009,7 +2010,7 @@ def File( # noqa: N802 ), ] = None, lt: Annotated[ - Optional[float], + Optional[SupportsLt], Doc( """ Less than. If set, value must be less than this. Only applicable to numbers. @@ -2017,7 +2018,7 @@ def File( # noqa: N802 ), ] = None, le: Annotated[ - Optional[float], + Optional[SupportsLe], Doc( """ Less than or equal. If set, value must be less than or equal to this. diff --git a/fastapi/params.py b/fastapi/params.py index 8f5601dd3..c178f77bf 100644 --- a/fastapi/params.py +++ b/fastapi/params.py @@ -2,6 +2,7 @@ import warnings from enum import Enum from typing import Any, Callable, Dict, List, Optional, Sequence, Union +from annotated_types import SupportsGe, SupportsGt, SupportsLe, SupportsLt from fastapi.openapi.models import Example from pydantic.fields import FieldInfo from typing_extensions import Annotated, deprecated @@ -39,10 +40,10 @@ class Param(FieldInfo): serialization_alias: Union[str, None] = None, title: Optional[str] = None, description: Optional[str] = None, - gt: Optional[float] = None, - ge: Optional[float] = None, - lt: Optional[float] = None, - le: Optional[float] = None, + gt: Optional[SupportsGt] = None, + ge: Optional[SupportsGe] = None, + lt: Optional[SupportsLt] = None, + le: Optional[SupportsLe] = None, min_length: Optional[int] = None, max_length: Optional[int] = None, pattern: Optional[str] = None, @@ -153,10 +154,10 @@ class Path(Param): serialization_alias: Union[str, None] = None, title: Optional[str] = None, description: Optional[str] = None, - gt: Optional[float] = None, - ge: Optional[float] = None, - lt: Optional[float] = None, - le: Optional[float] = None, + gt: Optional[SupportsGt] = None, + ge: Optional[SupportsGe] = None, + lt: Optional[SupportsLt] = None, + le: Optional[SupportsLe] = None, min_length: Optional[int] = None, max_length: Optional[int] = None, pattern: Optional[str] = None, @@ -239,10 +240,10 @@ class Query(Param): serialization_alias: Union[str, None] = None, title: Optional[str] = None, description: Optional[str] = None, - gt: Optional[float] = None, - ge: Optional[float] = None, - lt: Optional[float] = None, - le: Optional[float] = None, + gt: Optional[SupportsGt] = None, + ge: Optional[SupportsGe] = None, + lt: Optional[SupportsLt] = None, + le: Optional[SupportsLe] = None, min_length: Optional[int] = None, max_length: Optional[int] = None, pattern: Optional[str] = None, @@ -324,10 +325,10 @@ class Header(Param): convert_underscores: bool = True, title: Optional[str] = None, description: Optional[str] = None, - gt: Optional[float] = None, - ge: Optional[float] = None, - lt: Optional[float] = None, - le: Optional[float] = None, + gt: Optional[SupportsGt] = None, + ge: Optional[SupportsGe] = None, + lt: Optional[SupportsLt] = None, + le: Optional[SupportsLe] = None, min_length: Optional[int] = None, max_length: Optional[int] = None, pattern: Optional[str] = None, @@ -409,10 +410,10 @@ class Cookie(Param): serialization_alias: Union[str, None] = None, title: Optional[str] = None, description: Optional[str] = None, - gt: Optional[float] = None, - ge: Optional[float] = None, - lt: Optional[float] = None, - le: Optional[float] = None, + gt: Optional[SupportsGt] = None, + ge: Optional[SupportsGe] = None, + lt: Optional[SupportsLt] = None, + le: Optional[SupportsLe] = None, min_length: Optional[int] = None, max_length: Optional[int] = None, pattern: Optional[str] = None, @@ -493,10 +494,10 @@ class Body(FieldInfo): serialization_alias: Union[str, None] = None, title: Optional[str] = None, description: Optional[str] = None, - gt: Optional[float] = None, - ge: Optional[float] = None, - lt: Optional[float] = None, - le: Optional[float] = None, + gt: Optional[SupportsGt] = None, + ge: Optional[SupportsGe] = None, + lt: Optional[SupportsLt] = None, + le: Optional[SupportsLe] = None, min_length: Optional[int] = None, max_length: Optional[int] = None, pattern: Optional[str] = None, @@ -609,10 +610,10 @@ class Form(Body): serialization_alias: Union[str, None] = None, title: Optional[str] = None, description: Optional[str] = None, - gt: Optional[float] = None, - ge: Optional[float] = None, - lt: Optional[float] = None, - le: Optional[float] = None, + gt: Optional[SupportsGt] = None, + ge: Optional[SupportsGe] = None, + lt: Optional[SupportsLt] = None, + le: Optional[SupportsLe] = None, min_length: Optional[int] = None, max_length: Optional[int] = None, pattern: Optional[str] = None, @@ -693,10 +694,10 @@ class File(Form): serialization_alias: Union[str, None] = None, title: Optional[str] = None, description: Optional[str] = None, - gt: Optional[float] = None, - ge: Optional[float] = None, - lt: Optional[float] = None, - le: Optional[float] = None, + gt: Optional[SupportsGt] = None, + ge: Optional[SupportsGe] = None, + lt: Optional[SupportsLt] = None, + le: Optional[SupportsLe] = None, min_length: Optional[int] = None, max_length: Optional[int] = None, pattern: Optional[str] = None, From 8d877715e88f923f5b08651b7146e3b9a3490ec1 Mon Sep 17 00:00:00 2001 From: junah201 Date: Sun, 9 Feb 2025 11:08:17 +0900 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=93=9D=20Update=20docstring=20for=20g?= =?UTF-8?q?t,=20ge,=20lt=20and=20le=20parameters?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- fastapi/param_functions.py | 77 +++++++++++++++++++++----------------- 1 file changed, 42 insertions(+), 35 deletions(-) diff --git a/fastapi/param_functions.py b/fastapi/param_functions.py index 3c618e30c..7dc2c1d9f 100644 --- a/fastapi/param_functions.py +++ b/fastapi/param_functions.py @@ -94,8 +94,8 @@ def Path( # noqa: N802 Optional[SupportsGt], Doc( """ - Greater than. If set, value must be greater than this. Only applicable to - numbers. + Greater than. If set, value must be greater than this. Applicable to + any comparable type, not just numbers. """ ), ] = None, @@ -104,7 +104,7 @@ def Path( # noqa: N802 Doc( """ Greater than or equal. If set, value must be greater than or equal to - this. Only applicable to numbers. + this. Applicable to any comparable type, not just numbers. """ ), ] = None, @@ -112,7 +112,8 @@ def Path( # noqa: N802 Optional[SupportsLt], Doc( """ - Less than. If set, value must be less than this. Only applicable to numbers. + Less than. If set, value must be less than this. Applicable to + any comparable type, not just numbers. """ ), ] = None, @@ -121,7 +122,7 @@ def Path( # noqa: N802 Doc( """ Less than or equal. If set, value must be less than or equal to this. - Only applicable to numbers. + Applicable to any comparable type, not just numbers. """ ), ] = None, @@ -419,8 +420,8 @@ def Query( # noqa: N802 Optional[SupportsGt], Doc( """ - Greater than. If set, value must be greater than this. Only applicable to - numbers. + Greater than. If set, value must be greater than this. Applicable to + any comparable type, not just numbers. """ ), ] = None, @@ -429,7 +430,7 @@ def Query( # noqa: N802 Doc( """ Greater than or equal. If set, value must be greater than or equal to - this. Only applicable to numbers. + this. Applicable to any comparable type, not just numbers. """ ), ] = None, @@ -437,7 +438,8 @@ def Query( # noqa: N802 Optional[SupportsLt], Doc( """ - Less than. If set, value must be less than this. Only applicable to numbers. + Less than. If set, value must be less than this. Applicable to + any comparable type, not just numbers. """ ), ] = None, @@ -446,7 +448,7 @@ def Query( # noqa: N802 Doc( """ Less than or equal. If set, value must be less than or equal to this. - Only applicable to numbers. + Applicable to any comparable type, not just numbers. """ ), ] = None, @@ -734,8 +736,8 @@ def Header( # noqa: N802 Optional[SupportsGt], Doc( """ - Greater than. If set, value must be greater than this. Only applicable to - numbers. + Greater than. If set, value must be greater than this. Applicable to + any comparable type, not just numbers. """ ), ] = None, @@ -744,7 +746,7 @@ def Header( # noqa: N802 Doc( """ Greater than or equal. If set, value must be greater than or equal to - this. Only applicable to numbers. + this. Applicable to any comparable type, not just numbers. """ ), ] = None, @@ -752,7 +754,8 @@ def Header( # noqa: N802 Optional[SupportsLt], Doc( """ - Less than. If set, value must be less than this. Only applicable to numbers. + Less than. If set, value must be less than this. Applicable to + any comparable type, not just numbers. """ ), ] = None, @@ -761,7 +764,7 @@ def Header( # noqa: N802 Doc( """ Less than or equal. If set, value must be less than or equal to this. - Only applicable to numbers. + Applicable to any comparable type, not just numbers. """ ), ] = None, @@ -1039,8 +1042,8 @@ def Cookie( # noqa: N802 Optional[SupportsGt], Doc( """ - Greater than. If set, value must be greater than this. Only applicable to - numbers. + Greater than. If set, value must be greater than this. Applicable to + any comparable type, not just numbers. """ ), ] = None, @@ -1049,7 +1052,7 @@ def Cookie( # noqa: N802 Doc( """ Greater than or equal. If set, value must be greater than or equal to - this. Only applicable to numbers. + this. Applicable to any comparable type, not just numbers. """ ), ] = None, @@ -1057,7 +1060,8 @@ def Cookie( # noqa: N802 Optional[SupportsLt], Doc( """ - Less than. If set, value must be less than this. Only applicable to numbers. + Less than. If set, value must be less than this. Applicable to + any comparable type, not just numbers. """ ), ] = None, @@ -1066,7 +1070,7 @@ def Cookie( # noqa: N802 Doc( """ Less than or equal. If set, value must be less than or equal to this. - Only applicable to numbers. + Applicable to any comparable type, not just numbers. """ ), ] = None, @@ -1366,8 +1370,8 @@ def Body( # noqa: N802 Optional[SupportsGt], Doc( """ - Greater than. If set, value must be greater than this. Only applicable to - numbers. + Greater than. If set, value must be greater than this. Applicable to + any comparable type, not just numbers. """ ), ] = None, @@ -1376,7 +1380,7 @@ def Body( # noqa: N802 Doc( """ Greater than or equal. If set, value must be greater than or equal to - this. Only applicable to numbers. + this. Applicable to any comparable type, not just numbers. """ ), ] = None, @@ -1384,7 +1388,8 @@ def Body( # noqa: N802 Optional[SupportsLt], Doc( """ - Less than. If set, value must be less than this. Only applicable to numbers. + Less than. If set, value must be less than this. Applicable to + any comparable type, not just numbers. """ ), ] = None, @@ -1393,7 +1398,7 @@ def Body( # noqa: N802 Doc( """ Less than or equal. If set, value must be less than or equal to this. - Only applicable to numbers. + Applicable to any comparable type, not just numbers. """ ), ] = None, @@ -1681,8 +1686,8 @@ def Form( # noqa: N802 Optional[SupportsGt], Doc( """ - Greater than. If set, value must be greater than this. Only applicable to - numbers. + Greater than. If set, value must be greater than this. Applicable to + any comparable type, not just numbers. """ ), ] = None, @@ -1691,7 +1696,7 @@ def Form( # noqa: N802 Doc( """ Greater than or equal. If set, value must be greater than or equal to - this. Only applicable to numbers. + this. Applicable to any comparable type, not just numbers. """ ), ] = None, @@ -1699,7 +1704,8 @@ def Form( # noqa: N802 Optional[SupportsLt], Doc( """ - Less than. If set, value must be less than this. Only applicable to numbers. + Less than. If set, value must be less than this. Applicable to + any comparable type, not just numbers. """ ), ] = None, @@ -1708,7 +1714,7 @@ def Form( # noqa: N802 Doc( """ Less than or equal. If set, value must be less than or equal to this. - Only applicable to numbers. + Applicable to any comparable type, not just numbers. """ ), ] = None, @@ -1995,8 +2001,8 @@ def File( # noqa: N802 Optional[SupportsGt], Doc( """ - Greater than. If set, value must be greater than this. Only applicable to - numbers. + Greater than. If set, value must be greater than this. Applicable to + any comparable type, not just numbers. """ ), ] = None, @@ -2005,7 +2011,7 @@ def File( # noqa: N802 Doc( """ Greater than or equal. If set, value must be greater than or equal to - this. Only applicable to numbers. + this. Applicable to any comparable type, not just numbers. """ ), ] = None, @@ -2013,7 +2019,8 @@ def File( # noqa: N802 Optional[SupportsLt], Doc( """ - Less than. If set, value must be less than this. Only applicable to numbers. + Less than. If set, value must be less than this. Applicable to + any comparable type, not just numbers. """ ), ] = None, @@ -2022,7 +2029,7 @@ def File( # noqa: N802 Doc( """ Less than or equal. If set, value must be less than or equal to this. - Only applicable to numbers. + Applicable to any comparable type, not just numbers. """ ), ] = None,