♻️ Update internal type annotations and upgrade mypy (#9658)

tiangolo · Jun 11, 2023 · 4ac55af · 4ac55af
1 parent 3390a82
commit 4ac55af
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 18 deletions.
diff --git a/fastapi/openapi/models.py b/fastapi/openapi/models.py
@@ -3,6 +3,7 @@
 
 from fastapi.logger import logger
 from pydantic import AnyUrl, BaseModel, Field
+from typing_extensions import Literal
 
 try:
     import email_validator  # type: ignore
@@ -298,18 +299,18 @@ class APIKeyIn(Enum):
 
 
 class APIKey(SecurityBase):
-    type_ = Field(SecuritySchemeType.apiKey, alias="type")
+    type_: SecuritySchemeType = Field(default=SecuritySchemeType.apiKey, alias="type")
     in_: APIKeyIn = Field(alias="in")
     name: str
 
 
 class HTTPBase(SecurityBase):
-    type_ = Field(SecuritySchemeType.http, alias="type")
+    type_: SecuritySchemeType = Field(default=SecuritySchemeType.http, alias="type")
     scheme: str
 
 
 class HTTPBearer(HTTPBase):
-    scheme = "bearer"
+    scheme: Literal["bearer"] = "bearer"
     bearerFormat: Optional[str] = None
 
 
@@ -349,12 +350,14 @@ class Config:
 
 
 class OAuth2(SecurityBase):
-    type_ = Field(SecuritySchemeType.oauth2, alias="type")
+    type_: SecuritySchemeType = Field(default=SecuritySchemeType.oauth2, alias="type")
     flows: OAuthFlows
 
 
 class OpenIdConnect(SecurityBase):
-    type_ = Field(SecuritySchemeType.openIdConnect, alias="type")
+    type_: SecuritySchemeType = Field(
+        default=SecuritySchemeType.openIdConnect, alias="type"
+    )
     openIdConnectUrl: str
 
 

diff --git a/fastapi/security/api_key.py b/fastapi/security/api_key.py
@@ -21,7 +21,9 @@ def __init__(
         auto_error: bool = True,
     ):
         self.model: APIKey = APIKey(
-            **{"in": APIKeyIn.query}, name=name, description=description
+            **{"in": APIKeyIn.query},  # type: ignore[arg-type]
+            name=name,
+            description=description,
         )
         self.scheme_name = scheme_name or self.__class__.__name__
         self.auto_error = auto_error
@@ -48,7 +50,9 @@ def __init__(
         auto_error: bool = True,
     ):
         self.model: APIKey = APIKey(
-            **{"in": APIKeyIn.header}, name=name, description=description
+            **{"in": APIKeyIn.header},  # type: ignore[arg-type]
+            name=name,
+            description=description,
         )
         self.scheme_name = scheme_name or self.__class__.__name__
         self.auto_error = auto_error
@@ -75,7 +79,9 @@ def __init__(
         auto_error: bool = True,
     ):
         self.model: APIKey = APIKey(
-            **{"in": APIKeyIn.cookie}, name=name, description=description
+            **{"in": APIKeyIn.cookie},  # type: ignore[arg-type]
+            name=name,
+            description=description,
         )
         self.scheme_name = scheme_name or self.__class__.__name__
         self.auto_error = auto_error

diff --git a/fastapi/security/oauth2.py b/fastapi/security/oauth2.py
@@ -1,4 +1,4 @@
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union, cast
 
 from fastapi.exceptions import HTTPException
 from fastapi.openapi.models import OAuth2 as OAuth2Model
@@ -121,7 +121,9 @@ def __init__(
         description: Optional[str] = None,
         auto_error: bool = True,
     ):
-        self.model = OAuth2Model(flows=flows, description=description)
+        self.model = OAuth2Model(
+            flows=cast(OAuthFlowsModel, flows), description=description
+        )
         self.scheme_name = scheme_name or self.__class__.__name__
         self.auto_error = auto_error
 
@@ -148,7 +150,9 @@ def __init__(
     ):
         if not scopes:
             scopes = {}
-        flows = OAuthFlowsModel(password={"tokenUrl": tokenUrl, "scopes": scopes})
+        flows = OAuthFlowsModel(
+            password=cast(Any, {"tokenUrl": tokenUrl, "scopes": scopes})
+        )
         super().__init__(
             flows=flows,
             scheme_name=scheme_name,
@@ -185,12 +189,15 @@ def __init__(
         if not scopes:
             scopes = {}
         flows = OAuthFlowsModel(
-            authorizationCode={
-                "authorizationUrl": authorizationUrl,
-                "tokenUrl": tokenUrl,
-                "refreshUrl": refreshUrl,
-                "scopes": scopes,
-            }
+            authorizationCode=cast(
+                Any,
+                {
+                    "authorizationUrl": authorizationUrl,
+                    "tokenUrl": tokenUrl,
+                    "refreshUrl": refreshUrl,
+                    "scopes": scopes,
+                },
+            )
         )
         super().__init__(
             flows=flows,

diff --git a/requirements-tests.txt b/requirements-tests.txt
@@ -1,7 +1,7 @@
 -e .
 pytest >=7.1.3,<8.0.0
 coverage[toml] >= 6.5.0,< 8.0
-mypy ==0.982
+mypy ==1.3.0
 ruff ==0.0.138
 black == 23.1.0
 isort >=5.0.6,<6.0.0