style/docs: fix lingering linting issues + add missing func doc strings

Author: tazlin

horde_sdk/ai_horde_api/apimodels/alchemy/async_.py

@@ -75,7 +75,8 @@ class AlchemyAsyncRequestFormItem(HordeAPIData):
     """The name of the form to request."""
 
     @field_validator("name")
-    def check_name(cls, v: KNOWN_ALCHEMY_TYPES | str) -> KNOWN_ALCHEMY_TYPES | str:
+    def validate_name(cls, v: KNOWN_ALCHEMY_TYPES | str) -> KNOWN_ALCHEMY_TYPES | str:
+        """Validate the name of the form to request."""
         if isinstance(v, KNOWN_ALCHEMY_TYPES):
             return v
         if str(v) not in KNOWN_ALCHEMY_TYPES.__members__:
@@ -109,13 +110,15 @@ class AlchemyAsyncRequest(
     """Whether to use the super slow workers."""
 
     @field_validator("forms")
-    def check_at_least_one_form(cls, v: list[AlchemyAsyncRequestFormItem]) -> list[AlchemyAsyncRequestFormItem]:
+    def validate_at_least_one_form(cls, v: list[AlchemyAsyncRequestFormItem]) -> list[AlchemyAsyncRequestFormItem]:
+        """Ensure at least one form is provided."""
         if not v:
             raise ValueError("At least one form must be provided.")
         return v
 
     @field_validator("source_image")
-    def check_source_image(cls, v: str) -> str:
+    def validate_source_image(cls, v: str) -> str:
+        """Validate the source image URL or base64 string."""
         if "http" in v:
             parsed_url = urllib.parse.urlparse(v)
             if parsed_url.scheme not in ["http", "https"]:

horde_sdk/ai_horde_api/apimodels/alchemy/pop.py

@@ -65,6 +65,7 @@ def get_api_model_name(cls) -> str | None:
 
     @field_validator("form", mode="before")
     def validate_form(cls, v: str | KNOWN_ALCHEMY_TYPES) -> KNOWN_ALCHEMY_TYPES | str:
+        """Ensure that the form is a known alchemy type."""
         if isinstance(v, KNOWN_ALCHEMY_TYPES):
             return v
         if isinstance(v, str) and v not in KNOWN_ALCHEMY_TYPES.__members__:

horde_sdk/ai_horde_api/apimodels/alchemy/status.py

@@ -87,6 +87,7 @@ class AlchemyFormStatus(HordeAPIData):
 
     @field_validator("form", mode="before")
     def validate_form(cls, v: str | KNOWN_ALCHEMY_TYPES) -> KNOWN_ALCHEMY_TYPES | str:
+        """Ensure that the form is a known alchemy type."""
         if isinstance(v, KNOWN_ALCHEMY_TYPES):
             return v
         if str(v) not in KNOWN_ALCHEMY_TYPES.__members__:
@@ -103,6 +104,7 @@ def validate_result(
         cls,
         v: dict[str, object],
     ) -> dict[str, object] | None:
+        """Ensure that the result is valid and convert it to the correct type, if possible."""
         if "additionalProp1" in v:
             logger.debug("Found additionalProp1 in result, this is a dummy result. Ignoring.")
             return None
@@ -153,6 +155,7 @@ def all_upscale_results(self) -> list[AlchemyUpscaleResult]:
         """Return all completed upscale results."""
         return [form.result for form in self.forms if form.done and isinstance(form.result, AlchemyUpscaleResult)]
 
+    @override
     @classmethod
     def get_api_model_name(cls) -> str | None:
         return "InterrogationStatus"

horde_sdk/ai_horde_api/apimodels/documents.py

@@ -50,6 +50,7 @@ class AIHordeDocumentRequestMixin(HordeAPIObjectBaseModel):
 
     @field_validator("format")
     def validate_format(cls, value: DocumentFormat | str) -> DocumentFormat | str:
+        """Validate the format is a valid document format."""
         if isinstance(value, DocumentFormat):
             return value
 

horde_sdk/ai_horde_api/apimodels/generate/async_.py

@@ -13,9 +13,8 @@
 )
 from horde_sdk.ai_horde_api.apimodels.generate.check import ImageGenerateCheckRequest
 from horde_sdk.ai_horde_api.apimodels.generate.status import DeleteImageGenerateRequest, ImageGenerateStatusRequest
-from horde_sdk.ai_horde_api.apimodels.workers.messages import _ResponseModelMessageData
 from horde_sdk.ai_horde_api.endpoints import AI_HORDE_API_ENDPOINT_SUBPATH
-from horde_sdk.consts import _ANONYMOUS_MODEL, _MODEL_OVERLOADED, HTTPMethod, HTTPStatusCode
+from horde_sdk.consts import _ANONYMOUS_MODEL, HTTPMethod, HTTPStatusCode
 from horde_sdk.generation_parameters.image.consts import KNOWN_SOURCE_PROCESSING
 from horde_sdk.generic_api.apimodels import (
     APIKeyAllowedInRequestMixin,
@@ -52,6 +51,7 @@ class ImageGenerateAsyncResponse(
 
     @model_validator(mode="after")
     def validate_warnings(self) -> ImageGenerateAsyncResponse:
+        """Log any warnings that were generated by the server or a serving worker."""
         if self.warnings is None:
             return self
 
@@ -66,6 +66,7 @@ def get_follow_up_returned_params(self, *, as_python_field_name: bool = False) -
             return [{"id_": self.id_}]
         return [{"id": self.id_}]
 
+    @override
     @classmethod
     def get_follow_up_default_request_type(cls) -> type[ImageGenerateCheckRequest]:
         return ImageGenerateCheckRequest
@@ -130,6 +131,7 @@ def get_api_model_name(cls) -> str | None:
 
     @field_validator("n", mode="before")
     def validate_n(cls, value: int) -> int:
+        """Ensure that n is at least 1."""
         if value == 0:
             logger.debug("n (number of images to generate) is not set; defaulting to 1")
             return 1
@@ -187,6 +189,7 @@ class ImageGenerateAsyncRequest(
 
     @model_validator(mode="after")
     def validate_censor_nsfw(self) -> ImageGenerateAsyncRequest:
+        """Ensure that censor_nsfw is not set when nsfw is enabled."""
         if self.nsfw and self.censor_nsfw:
             raise ValueError("Cannot censor NSFW content when NSFW detection is enabled.")
         return self

horde_sdk/ai_horde_api/apimodels/generate/pop.py

@@ -15,13 +15,13 @@
     ImageGenerateParamMixin,
 )
 from horde_sdk.ai_horde_api.apimodels.generate.submit import ImageGenerationJobSubmitRequest
-from horde_sdk.ai_horde_api.apimodels.workers.messages import _ResponseModelMessageData, ResponseModelMessage
+from horde_sdk.ai_horde_api.apimodels.workers.messages import _ResponseModelMessageData
 from horde_sdk.ai_horde_api.consts import (
     GENERATION_STATE,
 )
 from horde_sdk.ai_horde_api.endpoints import AI_HORDE_API_ENDPOINT_SUBPATH
 from horde_sdk.ai_horde_api.fields import GenerationID
-from horde_sdk.consts import _ANONYMOUS_MODEL, _MODEL_OVERLOADED, HTTPMethod
+from horde_sdk.consts import _MODEL_OVERLOADED, HTTPMethod
 from horde_sdk.generation_parameters.alchemy.consts import KNOWN_FACEFIXERS, KNOWN_UPSCALERS
 from horde_sdk.generation_parameters.image.consts import KNOWN_SOURCE_PROCESSING
 from horde_sdk.generic_api.apimodels import (
@@ -303,6 +303,7 @@ def source_processing_must_be_known(cls, v: str | KNOWN_SOURCE_PROCESSING) -> st
 
     @field_validator("id_", mode="before")
     def validate_id(cls, v: str | GenerationID) -> GenerationID | str:
+        """Validate the ID is not an empty string."""
         if isinstance(v, str) and v == "":
             logger.warning("Job ID is empty")
             return GenerationID(root=uuid.uuid4())

horde_sdk/ai_horde_api/apimodels/generate/status.py

@@ -69,6 +69,7 @@ def get_api_model_name(self) -> str | None:
 
     @field_validator("id_", mode="before")
     def validate_id(cls, v: str | GenerationID) -> GenerationID | str:
+        """Validate the ID is not an empty string."""
         if isinstance(v, str) and v == "":
             logger.warning("Job ID is empty")
             return GenerationID(root=uuid.uuid4())

horde_sdk/ai_horde_api/apimodels/generate/submit.py

@@ -43,6 +43,7 @@ class ImageGenerationJobSubmitRequest(
 
     @model_validator(mode="after")
     def validate_generation(self) -> ImageGenerationJobSubmitRequest:
+        """Validate the generation field is not an empty string and warn if the seed is 0."""
         if self.generation == "":
             logger.error("Generation cannot be an empty string.")
             logger.error(self.log_safe_model_dump())

horde_sdk/ai_horde_api/apimodels/generate/text/async_.py

@@ -47,6 +47,7 @@ class TextGenerateAsyncResponse(
 
     @model_validator(mode="after")
     def validate_warnings(self) -> TextGenerateAsyncResponse:
+        """Log any warnings that were generated by the server or a serving worker."""
         if self.warnings is None:
             return self
 
@@ -61,6 +62,7 @@ def get_follow_up_returned_params(self, *, as_python_field_name: bool = False) -
             return [{"id_": self.id_}]
         return [{"id": self.id_}]
 
+    @override
     @classmethod
     def get_follow_up_default_request_type(cls) -> type[TextGenerateStatusRequest]:
         return TextGenerateStatusRequest

horde_sdk/ai_horde_api/apimodels/generate/text/pop.py

@@ -90,6 +90,7 @@ class TextGenerateJobPopResponse(
 
     @field_validator("id_", mode="before")
     def validate_id(cls, v: str | GenerationID) -> GenerationID | str:
+        """Validate the ID is not an empty string."""
         if isinstance(v, str) and v == "":
             logger.warning("Job ID is empty")
             return GenerationID(root=uuid.uuid4())