Patches to contribs client (#1094)

Author: esoteric-ephemera

mp_api/client/contribs/_types.py

@@ -316,12 +316,36 @@ def from_dict(cls, dct: dict) -> Self:
         return cls((k, v) for k, v in dct.items() if k in keys)
 
 
+"""
+The following type annotations are only used in type checking
+(mypy) the ContribsClient.get_all_ids function.
+This function has highly hetereogeneous output and these
+represent the intermediate and final data structures returned
+by that function.
+
+They **shouldn't** have to be used elsewhere.
+"""
+
 ComponentIdSets = dict[str, set[str]]
+"""Use only when type checking of ContribsClient.get_all_ids(...,fmt="sets")."""
+
 ProjectIdSets = dict[str, set[str] | ComponentIdSets]
+"""Use only when type checking of ContribsClient.get_all_ids(...,fmt="sets")."""
+
 AllIdSets = dict[str, ProjectIdSets]
+"""Use only when type checking of ContribsClient.get_all_ids(...,fmt="sets")."""
 
 ComponentNameMap = dict[str, dict[str, str]]
+"""Use only when type checking of ContribsClient.get_all_ids(...,fmt="map")."""
+
 IdentifierLeaf = dict[str, str | ComponentNameMap]
+"""Use only when type checking of ContribsClient.get_all_ids(...,fmt="map")."""
+
 IdentifierBranch = dict[str, IdentifierLeaf]
+"""Use only when type checking of ContribsClient.get_all_ids(...,fmt="map")."""
+
 ProjectIdMap = dict[str, IdentifierLeaf | IdentifierBranch]
+"""Use only when type checking of ContribsClient.get_all_ids(...,fmt="map")."""
+
 AllIdMap = dict[str, ProjectIdMap]
+"""Use only when type checking of ContribsClient.get_all_ids(...,fmt="map")."""

mp_api/client/contribs/client.py

@@ -50,6 +50,7 @@
 from mp_api.client.contribs._logger import MPCC_LOGGER, TqdmToLogger
 from mp_api.client.contribs._types import (
     Attachment,
+    ComponentIdSets,
     MPCDict,
     MPCStructure,
     Table,
@@ -71,10 +72,9 @@
     from collections.abc import Generator, Iterable, Sequence
     from typing import Any
 
-    from mp_api.client.contribs.types import (
+    from mp_api.client.contribs._types import (
         AllIdMap,
         AllIdSets,
-        ComponentIdSets,
         IdentifierLeaf,
         ProjectIdSets,
     )
@@ -88,11 +88,15 @@
 warnings.filterwarnings("default", category=DeprecationWarning, module=__name__)
 
 
-def validate_email(email_string: str):
+def validate_email(email_string: str) -> None:
     """Validate user email address.
 
     Args:
         email_string (str) : the user's email address
+    Returns:
+        None
+    Raises:
+        SwaggerValidationError on malformed email address.
     """
     if email_string.count(":") != 1:
         raise SwaggerValidationError(
@@ -107,6 +111,8 @@ def validate_email(email_string: str):
     if d > BaseDiagnosis.CATEGORIES["VALID"]:
         raise SwaggerValidationError(f"{email} {d.message}")
 
+    return None
+
 
 # TODO: mypy has some problems with putting a bare `str`
 # as a callable function in SwaggerFormat
@@ -2109,7 +2115,7 @@ def submit_contributions(
                         digest in digests[project_name][component]
                         or digest
                         in existing.get(project_name, {})
-                        .get(component, {})
+                        .get(component, {})  # type: ignore[union-attr]
                         .get("md5s", [])
                     )
 
@@ -2227,9 +2233,9 @@ def put_future(pk, payload):
                                 pk=project_name, _fields=["unique_identifiers"]
                             ).result()["unique_identifiers"]
                         )
-                        existing_ids = existing.get(project_name, {}).get(
-                            "identifiers", []
-                        )
+                        existing_ids: Iterable[str] = existing.get(
+                            project_name, {}
+                        ).get("identifiers", [])
                         contribs[project_name] = [
                             c
                             for c in contribs[project_name]

mp_api/client/contribs/schemas.py

@@ -372,5 +372,5 @@ class QueryResult(_DictLikeAccess):
 
     total_count: int
     total_pages: int
-    data: list[BaseModel] | None = None
+    data: list[ContribData] | None = None
     has_more: bool = False