Try to make ty mostly happy

Author: bkis

Tekst-API/openapi.json

@@ -1,7 +1,7 @@
 from importlib import metadata
 
 
-_package_metadata = metadata.metadata(__package__)
+_package_metadata = metadata.metadata(__package__ or __name__)
 
 # whyyyyy
 _project_urls = {

Tekst-API/tekst/__init__.py

@@ -123,7 +123,7 @@ async def _export(
                     export_format=fmt,
                 )
             except TekstHTTPException as e:
-                if e.detail.detail.key == "unsupportedExportFormat":
+                if "unsupportedExportFormat" in str(e.detail):
                     click.echo(
                         f"Resource {res_id_str} does not support export format {fmt}",
                         err=True,

Tekst-API/tekst/__main__.py

@@ -13,7 +13,7 @@
 from tekst import db, search
 from tekst.config import TekstConfig, get_config
 from tekst.db import migrations
-from tekst.errors import TekstHTTPException
+from tekst.errors import TekstErrorModel, TekstHTTPException
 from tekst.logs import log
 from tekst.middlewares import CookieTypeChoiceMiddleware
 from tekst.models.platform import PlatformState
@@ -117,14 +117,22 @@ async def lifespan(app: FastAPI):
 async def custom_http_exception_handler(request: Request, exc: Exception):
     # force garbage collection due to issues with custom exception handler
     # (see https://github.com/fastapi/fastapi/discussions/9145#discussioncomment-7254388)
+
+    # TODO To anyone touching this in the future:
+    # The ignored concerns of ty might be justified or not.
+    # I wasn't able to figure it out.
+    # As it works fine, I'm leaving it as is for now. I am sorry.
+
     gc.collect()
     return await http_exception_handler(
         request,
         HTTPException(
             status_code=exc.status_code,
-            detail=exc.detail.model_dump().get("detail", None),
-            headers=exc.headers,
+            detail=exc.detail.model_dump().get("detail", None)
+            if isinstance(exc.detail, TekstErrorModel)
+            else None,
+            headers=exc.headers,  # ty:ignore[invalid-argument-type]
         )
         if isinstance(exc, TekstHTTPException)
-        else exc,
+        else exc,  # ty:ignore[invalid-argument-type]
     )

Tekst-API/tekst/app.py

@@ -6,12 +6,9 @@
 from datetime import UTC, datetime
 from typing import Annotated, Any
 
-import fastapi_users.models as fapi_users_models
-
 from beanie import Document, PydanticObjectId
 from beanie.operators import Eq, Or, Pull, Set, Size
 from fastapi import (
-    APIRouter,
     Depends,
     FastAPI,
     HTTPException,
@@ -23,6 +20,7 @@
     BaseUserManager,
     FastAPIUsers,
     InvalidPasswordException,
+    models,
 )
 from fastapi_users.authentication import (
     AuthenticationBackend,
@@ -76,7 +74,7 @@ class Settings(BeanieBaseAccessToken.Settings):
     cookie_path=_cfg.api_path or "/",
     cookie_secure=not _cfg.dev_mode,
     cookie_httponly=True,
-    cookie_samesite="Lax",
+    cookie_samesite="lax",
 )
 
 _bearer_transport = BearerTransport(tokenUrl="auth/jwt/login")
@@ -117,7 +115,7 @@ def _get_jwt_strategy() -> JWTStrategy:
     return JWTStrategy(
         secret=_cfg.security.secret,
         lifetime_seconds=_cfg.security.auth_jwt_lifetime,
-        token_audience="tekst:jwt",
+        token_audience=["tekst:jwt"],
     )
 
 
@@ -359,7 +357,12 @@ async def validate_password(
                 reason="Password should not contain e-mail address"
             )
 
-    async def create(self, user_create, **kwargs) -> fapi_users_models.UP:
+    async def create(
+        self,
+        user_create: UserCreate,
+        safe: bool = False,
+        request: Request | None = None,
+    ) -> models.UP:
         """
         Overrides FastAPI-User's BaseUserManager's create method to check if the
         username already exists and respond with a meaningful HTTP exception.
@@ -374,7 +377,7 @@ async def create(self, user_create, **kwargs) -> fapi_users_models.UP:
                 status_code=status.HTTP_400_BAD_REQUEST,
                 detail="REGISTER_USERNAME_ALREADY_EXISTS",
             )
-        return await super().create(user_create, **kwargs)
+        return await super().create(user_create, safe, request)  # ty:ignore[invalid-return-type]
 
 
 async def get_user_manager(user_db=Depends(get_user_db)):
@@ -390,7 +393,7 @@ async def get_user_manager(user_db=Depends(get_user_db)):
 )
 
 
-def setup_auth_routes(app: FastAPI) -> list[APIRouter]:
+def setup_auth_routes(app: FastAPI) -> None:
     # cookie auth
     if _cfg.security.enable_cookie_auth:
         app.include_router(
@@ -437,7 +440,7 @@ def setup_auth_routes(app: FastAPI) -> list[APIRouter]:
     app.include_router(
         _fastapi_users.get_users_router(
             UserRead,
-            UserUpdate,
+            UserUpdate,  # ty:ignore[invalid-argument-type] # this is correct
             requires_verification=not _cfg.security.closed_mode,
         ),
         prefix="/users",

Tekst-API/tekst/auth.py

@@ -13,6 +13,7 @@
 from humps import camelize
 from pydantic import (
     BaseModel,
+    BeforeValidator,
     ConfigDict,
     DirectoryPath,
     EmailStr,
@@ -24,7 +25,7 @@
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
 from tekst import package_metadata
-from tekst.types import EmptyStrToNone, HttpUrl, MultiLineString, SingleLineString
+from tekst.types import FalsyToNone, HttpUrl, MultiLineString, SingleLineString
 
 
 _DEV_MODE: bool = bool(os.environ.get("TEKST_DEV_MODE", False))
@@ -93,13 +94,13 @@ class MongoDBConfig(ConfigSubSection):
         str | None,
         StringConstraints(max_length=64),
         SingleLineString,
-        EmptyStrToNone,
+        FalsyToNone,
     ] = None
     password: Annotated[
         str | None,
         StringConstraints(max_length=64),
         SingleLineString,
-        EmptyStrToNone,
+        FalsyToNone,
     ] = None
     name: str = "tekst"
     unicode_nf: Literal["NFC", "NFKC", "NFD", "NFKD"] | None = "NFC"
@@ -181,7 +182,7 @@ class SecurityConfig(ConfigSubSection):
         str | None,
         StringConstraints(max_length=64),
         SingleLineString,
-        EmptyStrToNone,
+        FalsyToNone,
     ] = None
     auth_cookie_lifetime: Annotated[
         int,
@@ -211,13 +212,13 @@ class SecurityConfig(ConfigSubSection):
         str | None,
         StringConstraints(max_length=256),
         SingleLineString,
-        EmptyStrToNone,
+        FalsyToNone,
     ] = None
     init_admin_password: Annotated[
         str | None,
         StringConstraints(max_length=256),
         SingleLineString,
-        EmptyStrToNone,
+        FalsyToNone,
     ] = None
 
 
@@ -229,18 +230,18 @@ class EMailConfig(ConfigSubSection):
         StringConstraints(max_length=256),
         SingleLineString,
     ] = "127.0.0.1"
-    smtp_port: int | None = 25
+    smtp_port: int = 25
     smtp_user: Annotated[
         str | None,
         StringConstraints(max_length=256),
         SingleLineString,
-        EmptyStrToNone,
+        FalsyToNone,
     ] = None
     smtp_password: Annotated[
         str | None,
         StringConstraints(max_length=256),
         SingleLineString,
-        EmptyStrToNone,
+        FalsyToNone,
     ] = None
     smtp_starttls: bool = True
     from_address: str = "noreply@example-tekst-instance.org"
@@ -262,39 +263,39 @@ class ApiDocConfig(ConfigSubSection):
         str | None,
         StringConstraints(max_length=256),
         SingleLineString,
-        EmptyStrToNone,
+        FalsyToNone,
     ] = None
     description: Annotated[
         str | None,
         StringConstraints(max_length=4096),
         MultiLineString,
-        EmptyStrToNone,
+        FalsyToNone,
     ] = None
-    terms_url: Annotated[HttpUrl | None, EmptyStrToNone] = None
+    terms_url: Annotated[HttpUrl | None, FalsyToNone] = None
     contact_name: Annotated[
         str | None,
         StringConstraints(max_length=64),
         SingleLineString,
-        EmptyStrToNone,
+        FalsyToNone,
     ] = None
     contact_email: Annotated[
         EmailStr | None,
-        EmptyStrToNone,
+        FalsyToNone,
     ] = None
-    contact_url: Annotated[HttpUrl | None, EmptyStrToNone] = None
+    contact_url: Annotated[HttpUrl | None, FalsyToNone] = None
     license_name: Annotated[
         str | None,
         StringConstraints(max_length=32),
         SingleLineString,
-        EmptyStrToNone,
+        FalsyToNone,
     ] = None
     license_id: Annotated[
         str | None,
         StringConstraints(max_length=32),
         SingleLineString,
-        EmptyStrToNone,
+        FalsyToNone,
     ] = None
-    license_url: Annotated[HttpUrl | None, EmptyStrToNone] = None
+    license_url: Annotated[HttpUrl | None, FalsyToNone] = None
 
 
 class CORSConfig(ConfigSubSection):
@@ -352,7 +353,10 @@ class TekstConfig(BaseSettings):
     auto_migrate: bool = False
     xsrf: bool = True
 
-    temp_files_dir: DirectoryPath = Path("/tmp/tekst_tmp")
+    temp_files_dir: Annotated[
+        DirectoryPath,
+        BeforeValidator(lambda v: Path(v) if isinstance(v, str) else v),
+    ] = Path("/tmp/tekst_tmp")
 
     # config sub sections
     db: MongoDBConfig = MongoDBConfig()  # MongoDB-related config

Tekst-API/tekst/config.py

@@ -51,7 +51,7 @@ async def get_db_status() -> dict[str, Any] | None:
 
 
 def get_db(
-    db_client: Database = get_db_client(), cfg: TekstConfig = get_config()
+    db_client: DatabaseClient = get_db_client(), cfg: TekstConfig = get_config()
 ) -> Database:
     return db_client.get_database(
         cfg.db.name,
@@ -79,8 +79,12 @@ async def init_odm(db: Database = get_db()) -> None:
     ]
     # add all resource types' resource and content document models
     for lt_class in resource_types_mgr.get_all().values():
-        models.append(lt_class.resource_model().document_model())
-        models.append(lt_class.content_model().document_model())
+        res_doc_model = lt_class.resource_model().document_model()
+        cnt_doc_model = lt_class.content_model().document_model()
+        assert isinstance(res_doc_model, ResourceBaseDocument)
+        assert isinstance(cnt_doc_model, ContentBaseDocument)
+        models.append(res_doc_model)
+        models.append(cnt_doc_model)
     # init beanie ODM
     await init_beanie(
         database=db,

Tekst-API/tekst/db/__init__.py

@@ -105,7 +105,7 @@ async def migrate() -> None:
     for mig_ver in pending:
         log.info(f"Migrating DB from {curr_db_version} to {str(mig_ver)}...")
         try:
-            await pending[mig_ver](db)
+            await pending[mig_ver](db)  # ty:ignore[invalid-await] # TODO: look into what ty wants here!
         except Exception as e:  # pragma: no cover
             log.error(
                 f"Failed migrating DB from {curr_db_version} to {str(mig_ver)}: {e}"

Tekst-API/tekst/db/migrations/__init__.py

@@ -13,6 +13,8 @@ async def migration(db: Database) -> None:
                 "position": corr["position"],
             }
         )
+        if loc is None:
+            raise ValueError(f"Location not found for correction {corr['_id']}")
         await db.corrections.update_one(
             {"_id": corr["_id"]}, {"$set": {"location_id": loc["_id"]}}
         )

Tekst-API/tekst/db/migrations/migration_0_3_0a0.py

@@ -2,7 +2,7 @@
 
 from logging import config
 from time import perf_counter, process_time
-from typing import Literal
+from typing import Any, Literal
 from uuid import uuid4
 
 from tekst.config import TekstConfig, get_config
@@ -95,15 +95,12 @@ def filter(self, record):  # pragma: no cover
     },
 }
 
-_LOG_LEVELS = {
-    "DEBUG": logging.getLevelName("DEBUG"),
-    "INFO": logging.getLevelName("INFO"),
-    "WARNING": logging.getLevelName("WARNING"),
-    "ERROR": logging.getLevelName("ERROR"),
-    "CRITICAL": logging.getLevelName("CRITICAL"),
-}
 
-LogLevelString = Literal[tuple(_LOG_LEVELS.keys())]
+def _get_lvl_name(level: str, fallback_level: str) -> Any:
+    return logging.getLevelName(level) or logging.getLevelName(fallback_level)
+
+
+LogLevelString = Literal["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]
 
 config.dictConfig(_LOGGING_CONFIG)
 log = logging.getLogger("tekst")
@@ -120,7 +117,7 @@ def log_op_start(
     use_process_time: bool = False,
 ) -> str:
     global _running_ops
-    level_code = _LOG_LEVELS.get(level, _LOG_LEVELS["DEBUG"])
+    level_code = _get_lvl_name(level, "DEBUG")
     op_id = str(uuid4())
     start_t = process_time() if use_process_time else perf_counter()
     _running_ops[op_id] = (label, start_t, level_code, use_process_time)
@@ -145,7 +142,7 @@ def log_op_end(
     if not failed:
         log.log(level_code, f"Finished: {label} [{dur:.2f}s]")
     else:
-        level_code = _LOG_LEVELS.get(failed_level, _LOG_LEVELS["ERROR"])
+        level_code = _get_lvl_name(failed_level, "ERROR")
         failed_msg = f" – {failed_msg}" if failed_msg else ""
         log.log(level_code, f"Failed: {label} [{dur:.2f}s]{failed_msg}")
     return dur