chore: enable pydantic mypy plugin

Signed-off-by: Panos Vagenas <[email protected]>

deepsearch/core/cli/profile.py

@@ -1,7 +1,6 @@
 from typing import Optional
 
 import typer
-from pydantic import SecretStr
 from rich.console import Console
 from rich.table import Table
 from typing_extensions import Annotated
@@ -43,7 +42,7 @@ def add_profile(
     profile_settings = ProfileSettings(
         host=host,
         username=username,
-        api_key=SecretStr(api_key),
+        api_key=api_key,
         verify_ssl=verify_ssl,
     )
 

deepsearch/core/client/settings.py

@@ -47,10 +47,8 @@ def from_cli_prompt(cls) -> ProfileSettings:
         return cls(
             host=input("Host: "),
             username=input("Username: "),
-            api_key=SecretStr(getpass("API key: ")),
-            verify_ssl=True
-            if input("SSL verification [y/n]: ") == "y" or "Y"
-            else False,
+            api_key=getpass("API key: "),
+            verify_ssl=input("SSL verification [y/n]: "),
         )
 
 

deepsearch/core/client/settings_manager.py

@@ -4,7 +4,7 @@
 from typing import Dict, Optional
 
 import platformdirs
-from pydantic import SecretStr, ValidationError
+from pydantic import ValidationError
 
 from deepsearch.core.cli.profile_utils import (
     MSG_AMBIGUOUS_SUCCESSOR,
@@ -40,6 +40,8 @@ def __init__(self) -> None:
         )
         self._main_path = self.config_root_path / MAIN_DOTENV_FILENAME
         self._main_settings = MainSettings(_env_file=self._main_path)  # type: ignore
+        # suppressing due to known Pydantic bug https://github.com/pydantic/pydantic/issues/3072
+
         self._profile_root_path = self.config_root_path / PROFILES_DIR_NAME
         self._profile_root_path.mkdir(exist_ok=True)
 
@@ -52,6 +54,7 @@ def __init__(self) -> None:
                 self._profile_cache[profile_name] = ProfileSettingsEntry(
                     path=file_path,
                     settings=ProfileSettings(_env_file=file_path),  # type: ignore
+                    # suppressing due to known Pydantic bug https://github.com/pydantic/pydantic/issues/3072
                 )
 
         # reset any stale active profile config
@@ -85,7 +88,7 @@ def _migrate_legacy_config(self) -> None:
                     new_cfg = ProfileSettings(
                         host=legacy_cfg.host,
                         username=legacy_cfg.auth.username,
-                        api_key=SecretStr(legacy_cfg.auth.api_key),
+                        api_key=legacy_cfg.auth.api_key,
                         verify_ssl=legacy_cfg.verify_ssl,
                     )
                     self.save_settings(
@@ -113,7 +116,7 @@ def get_profile_settings(
         prfl_name = profile_name or self.get_active_profile()
         if prfl_name is None:
             try:  # try to instantiate from environment alone
-                return ProfileSettings()  # type: ignore
+                return ProfileSettings()
             except ValidationError:
                 if len(self._profile_cache) == 0:
                     raise RuntimeError(MSG_NO_PROFILES_DEFINED)

deepsearch/documents/core/models.py

@@ -351,7 +351,7 @@ class ConversionSettings(BaseModel):
 
     @classmethod
     def from_project(cls, api: CpsApi, proj_key: str) -> "ConversionSettings":
-        conv_settings = cls()  # type: ignore
+        conv_settings = cls()
 
         proj_key, _ = get_ccs_project_key(api, proj_key)
 
@@ -372,7 +372,7 @@ def from_project(cls, api: CpsApi, proj_key: str) -> "ConversionSettings":
 
     @classmethod
     def from_defaults(cls, api: CpsApi) -> "ConversionSettings":
-        conv_settings = cls()  # type: ignore
+        conv_settings = cls()
 
         request_conv_settings = api.client.session.get(
             url=URLNavigator(api).url_conversion_defaults()

deepsearch/model/examples/dummy_nlp_annotator/model.py

@@ -12,7 +12,6 @@
     AnnotationLabels,
     EntityLabel,
     NLPConfig,
-    NLPType,
 )
 
 
@@ -24,7 +23,7 @@ def __init__(self) -> None:
             kind=Kind.NLPModel,
             name="DummyNLPAnnotator",
             version="0.1.0",
-            supported_types=[NLPType("text")],
+            supported_types=["text"],
             labels=self._generate_labels(),
         )
 

deepsearch/model/kinds/nlp/controller.py

@@ -1,5 +1,3 @@
-from typing import Literal
-
 from fastapi import HTTPException, status
 
 from deepsearch.model.base.controller import BaseController
@@ -31,11 +29,11 @@ def __init__(self, model: BaseNLPModel):
     def get_info(self) -> NLPInfoOutput:
         cfg = self._model.get_nlp_config()
         metadata = NLPModelMetadata(
-            supported_object_types=cfg.supported_types,  # type: ignore
+            supported_object_types=cfg.supported_types,
             **self._get_metadata().dict(),  # passing parent metadata dict as kwargs
         )
         spec = NLPInfoOutputDefinitionsSpec(
-            definition=cfg.labels.dict(),
+            definition=cfg.labels,
             metadata=metadata,
         )
         definitions = NLPInfoOutputDefinitions(
@@ -45,7 +43,7 @@ def get_info(self) -> NLPInfoOutput:
         )
         return NLPInfoOutput(definitions=definitions)
 
-    def get_kind(self) -> Literal[Kind.NLPModel]:
+    def get_kind(self) -> str:
         return Kind.NLPModel
 
     def _get_model(self) -> BaseDSModel:

deepsearch/model/kinds/qagen/controller.py

@@ -1,5 +1,3 @@
-from typing import Literal
-
 from fastapi import HTTPException, status
 
 from deepsearch.model.base.controller import BaseController
@@ -34,7 +32,7 @@ def get_info(self) -> QAGenInfoOutput:
     def _get_model(self) -> BaseDSModel:
         return self._model
 
-    def get_kind(self) -> Literal[Kind.QAGenModel]:
+    def get_kind(self) -> str:
         return Kind.QAGenModel
 
     def dispatch_predict(self, spec: CtrlPredInput) -> CtrlPredOutput:

pyproject.toml

@@ -108,6 +108,7 @@ py_version=38
 known_first_party = ["cps"]
 
 [tool.mypy]
+plugins = ["pydantic.mypy"]
 pretty = true
 # strict = true
 no_implicit_optional = true