Mc pydantic

app.py

@@ -9,7 +9,6 @@
 from resources.Callback import namespace_auth
 from resources.DataRequests import namespace_data_requests
 from resources.GithubDataRequests import namespace_github
-from resources.HomepageSearchCache import namespace_homepage_search_cache
 from resources.LinkToGithub import namespace_link_to_github
 from resources.LoginWithGithub import namespace_login_with_github
 from resources.Map import namespace_map
@@ -109,9 +108,7 @@
 def create_app() -> Flask:
     psycopg2_connection = initialize_psycopg_connection()
     config.connection = psycopg2_connection
-    api = Api()
-    for namespace in NAMESPACES:
-        api.add_namespace(namespace)
+    api = get_api_with_namespaces()
     app = Flask(__name__)
     app.json = UpdatedJSONProvider(app)
 
@@ -132,6 +129,13 @@
     return app
 
 
+def get_api_with_namespaces():
+    api = Api()
+    for namespace in NAMESPACES:
+        api.add_namespace(namespace)
+    return api
+
+
 if __name__ == "__main__":
     app = create_app()
     app.run(host=os.getenv("FLASK_RUN_HOST", "127.0.0.1"))

database_client/db_client_dataclasses.py

@@ -2,6 +2,7 @@
 from dataclasses import dataclass
 from typing import Any, Callable, Optional
 
+from pydantic import BaseModel
 from sqlalchemy.sql.expression import UnaryExpression
 from sqlalchemy.schema import Column
 from sqlalchemy.sql.expression import asc, desc, BinaryExpression
@@ -16,8 +17,7 @@
 }
 
 
-@dataclass
-class OrderByParameters:
+class OrderByParameters(BaseModel):
     """
     Contains parameters for an order_by clause
     """

database_client/subquery_logic.py

@@ -1,22 +1,23 @@
 from dataclasses import dataclass
 from functools import partialmethod
+from typing import Optional
 
+from pydantic import BaseModel
 from sqlalchemy.orm import defaultload, joinedload
 from sqlalchemy.sql.base import ExecutableOption
 
 from database_client.models import convert_to_column_reference
 from middleware.enums import Relations
 
 
-@dataclass
-class SubqueryParameters:
+class SubqueryParameters(BaseModel):
     """
     Contains parameters for executing a subquery
     """
 
     relation_name: str
     linking_column: str
-    columns: list[str] = None
+    columns: Optional[list[str]] = None
 
     def set_columns(self, columns: list[str]) -> None:
         self.columns = columns

manual_tests/test_api_spec.py

@@ -0,0 +1,9 @@
+import json
+
+from app import get_api_with_namespaces, create_app
+
+
+def test_api_spec():
+    app = create_app()
+    api = get_api_with_namespaces()
+    print(json.dumps(api.__schema__))

middleware/access_logic.py

@@ -1,11 +1,12 @@
-from dataclasses import dataclass
 from http import HTTPStatus
 from typing import Optional
 
 from flask import request
 from flask_jwt_extended import get_jwt_identity, verify_jwt_in_request
+from flask_jwt_extended.exceptions import NoAuthorizationError
 from flask_restx import abort
 from jwt import ExpiredSignatureError
+from pydantic import BaseModel
 
 from database_client.database_client import DatabaseClient
 from middleware.SimpleJWT import SimpleJWT, JWTPurpose
@@ -16,11 +17,11 @@
     InvalidAPIKeyException,
     InvalidAuthorizationHeaderException,
 )
+from middleware.flask_response_manager import FlaskResponseManager
 from middleware.primary_resource_logic.permissions_logic import get_user_permissions
 
 
-@dataclass
-class AuthenticationInfo:
+class AuthenticationInfo(BaseModel):
     """
     A dataclass providing information on how the user was authenticated
     """
@@ -62,19 +63,16 @@
         return access_type in self.allowed_access_methods
 
 
-@dataclass
-class AccessInfoBase:
-    pass
+class AccessInfoBase(BaseModel):
+    access_type: AccessTypeEnum
 
 
-@dataclass
 class AccessInfoPrimary(AccessInfoBase):
     """
     A dataclass providing information on how the endpoint was accessed
     """
 
     user_email: str
-    access_type: AccessTypeEnum
     user_id: Optional[int] = None
     permissions: list[PermissionsEnum] = None
 
@@ -84,17 +82,15 @@
         return self.user_id
 
 
-@dataclass
 class PasswordResetTokenAccessInfo(AccessInfoBase):
-    access_type = AccessTypeEnum.RESET_PASSWORD
+    access_type: AccessTypeEnum = AccessTypeEnum.RESET_PASSWORD
     user_id: int
     user_email: str
     reset_token: str
 
 
-@dataclass
 class ValidateEmailTokenAccessInfo(AccessInfoBase):
-    access_type = AccessTypeEnum.VALIDATE_EMAIL
+    access_type: AccessTypeEnum = AccessTypeEnum.VALIDATE_EMAIL
     validate_email_token: str
 
 
@@ -104,7 +100,11 @@
         try:
             verify_jwt_in_request()
             return get_jwt_identity()
-        except Exception:
+        except NoAuthorizationError:
+            FlaskResponseManager.abort(
+                HTTPStatus.BAD_REQUEST, message="Token is missing"
+            )
+        except Exception as e:
             return None
 
     @staticmethod
@@ -160,14 +160,21 @@
     try:
         return headers["Authorization"]
     except (KeyError, TypeError):
-        raise InvalidAuthorizationHeaderException
+        FlaskResponseManager.abort(
+            code=HTTPStatus.BAD_REQUEST, message="Authorization header missing"
+        )
 
 
 def get_key_from_authorization_header(
     authorization_header: str, scheme: str = "Basic"
 ) -> str:
     try:
         authorization_header_parts = authorization_header.split(" ")
+        if len(authorization_header_parts) != 2:
+            FlaskResponseManager.abort(
+                code=HTTPStatus.BAD_REQUEST,
+                message="Improperly formatted authorization header",
+            )
         if authorization_header_parts[0] != scheme:
             raise InvalidAPIKeyException
         return authorization_header_parts[1]

middleware/column_permission_logic.py

@@ -1,9 +1,7 @@
-from dataclasses import dataclass
-from enum import Enum
 from http import HTTPStatus
 from typing import Optional
 
-from flask_restx import abort
+from pydantic import BaseModel, ConfigDict
 
 from database_client.database_client import DatabaseClient
 from database_client.enums import RelationRoleEnum, ColumnPermissionEnum
@@ -112,8 +110,9 @@
     return RelationRoleEnum.STANDARD
 
 
-@dataclass
-class RelationRoleParameters:
+class RelationRoleParameters(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
     relation_role_function_with_params: DeferredFunction = DeferredFunction(
         function=get_relation_role,
     )

middleware/custom_dataclasses.py

@@ -1,17 +1,18 @@
 from dataclasses import dataclass
 from typing import Optional
 
+from pydantic import BaseModel
+
 from database_client.enums import EntityType, EventType
 from middleware.enums import CallbackFunctionsEnum
 
 
-@dataclass
-class GithubUserInfo:
+class GithubUserInfo(BaseModel):
     """
     Information about a Github user
     """
 
-    user_id: str
+    user_id: int
     user_email: str
 
 
@@ -25,8 +26,7 @@ class FlaskSessionCallbackInfo:
     callback_params: dict
 
 
-@dataclass
-class OAuthCallbackInfo:
+class OAuthCallbackInfo(BaseModel):
     """
     Contains information returned by OAuth in the callback logic
     """

middleware/dynamic_request_logic/get_related_resource_logic.py

@@ -1,6 +1,7 @@
 from typing import Optional
 
 from flask import Response
+from pydantic import BaseModel
 
 from database_client.database_client import DatabaseClient
 from database_client.db_client_dataclasses import WhereMapping

middleware/location_logic.py

@@ -1,4 +1,3 @@
-from dataclasses import asdict
 from typing import Union
 
 from database_client.database_client import DatabaseClient
@@ -19,7 +18,7 @@ def get_location_id(
         location_info_dict = location_info
         location_info = LocationInfoDTO(**location_info)
     else:
-        location_info_dict = asdict(location_info)
+        location_info_dict = dict(location_info)
 
     location_info_where_mappings = WhereMapping.from_dict(location_info_dict)
     # Get location id

middleware/primary_resource_logic/agencies.py

@@ -96,7 +96,7 @@ def validate_and_add_location_info(
 def create_agency(
     db_client: DatabaseClient, dto: AgenciesPostDTO, access_info: AccessInfoPrimary
 ) -> Response:
-    entry_data = asdict(dto.agency_info)
+    entry_data = dict(dto.agency_info)
     deferred_function = optionally_get_location_info_deferred_function(
         db_client=db_client,
         jurisdiction_type=dto.agency_info.jurisdiction_type,

middleware/primary_resource_logic/archives_queries.py

@@ -18,13 +18,6 @@
 ]
 
 
-@dataclass
-class ArchivesQueryData:
-    id: Optional[str] = None
-    broken_source_url_as_of: Optional[str] = None
-    last_cached: Optional[str] = None
-
-
 def archives_get_query(
     db_client: DatabaseClient,
 ) -> List[Dict[str, Any]]: