refactor/fix: resolve the RootModel problem

style: fix

Author: tazlin

docs/response_field_names_and_descriptions.json

@@ -233,7 +233,7 @@
         }
     },
     "DeleteWorkerResponse": {
-        "deleted_id_": {
+        "deleted_id": {
             "description": "The ID of the deleted worker.",
             "types": [
                 "str",
@@ -1238,6 +1238,20 @@
                 "int",
                 "None"
             ]
+        },
+        "controlnet": {
+            "description": "If True, this worker supports and allows controlnet requests.",
+            "types": [
+                "bool",
+                "None"
+            ]
+        },
+        "sdxl_controlnet": {
+            "description": "If True, this worker supports and allows sdxl controlnet requests.",
+            "types": [
+                "bool",
+                "None"
+            ]
         }
     },
     "TextGenerateAsyncDryRunResponse": {

horde_sdk/__init__.py

@@ -76,7 +76,7 @@ def _dev_env_var_warnings() -> None:  # pragma: no cover
 from horde_sdk.generic_api.apimodels import (
     APIKeyAllowedInRequestMixin,
     ContainsMessageResponseMixin,
-    HordeAPIDataObject,
+    HordeAPIData,
     HordeAPIMessage,
     HordeAPIObject,
     HordeRequest,
@@ -99,7 +99,7 @@ def _dev_env_var_warnings() -> None:  # pragma: no cover
     "APIKeyAllowedInRequestMixin",
     "HordeRequest",
     "ContainsMessageResponseMixin",
-    "HordeAPIDataObject",
+    "HordeAPIData",
     "HordeAPIMessage",
     "HordeAPIObject",
     "RequestErrorResponse",

horde_sdk/ai_horde_api/apimodels/_documents.py

@@ -7,7 +7,7 @@
 from horde_sdk.ai_horde_api.endpoints import AI_HORDE_API_ENDPOINT_SUBPATH
 from horde_sdk.consts import HTTPMethod
 from horde_sdk.generic_api.apimodels import (
-    HordeAPIObject,
+    HordeAPIObjectBaseModel,
     HordeResponseBaseModel,
 )
 
@@ -29,7 +29,7 @@ def get_api_model_name(cls) -> str:
         return "HordeDocument"
 
 
-class AIHordeDocumentRequestMixin(HordeAPIObject):
+class AIHordeDocumentRequestMixin(HordeAPIObjectBaseModel):
     format: DocumentFormat | str = DocumentFormat.html
 
     """The format of the document to return. Default is markdown."""
@@ -108,7 +108,7 @@ def get_http_method(cls) -> HTTPMethod:
     @override
     @classmethod
     def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
-        return AI_HORDE_API_ENDPOINT_SUBPATH.vs_documents_terms
+        return AI_HORDE_API_ENDPOINT_SUBPATH.v2_documents_terms
 
     @override
     @classmethod

horde_sdk/ai_horde_api/apimodels/_kudos.py

@@ -3,10 +3,10 @@
 from horde_sdk.ai_horde_api.apimodels.base import BaseAIHordeRequest
 from horde_sdk.ai_horde_api.endpoints import AI_HORDE_API_ENDPOINT_SUBPATH
 from horde_sdk.consts import _ANONYMOUS_MODEL, HTTPMethod
-from horde_sdk.generic_api.apimodels import APIKeyAllowedInRequestMixin, HordeResponse
+from horde_sdk.generic_api.apimodels import APIKeyAllowedInRequestMixin, HordeResponseBaseModel
 
 
-class KudosTransferResponse(HordeResponse):
+class KudosTransferResponse(HordeResponseBaseModel):
     transferred: float | None = None
     """The amount of Kudos transferred."""
 

horde_sdk/ai_horde_api/apimodels/_stats.py

@@ -9,7 +9,7 @@
 from horde_sdk.ai_horde_api.consts import MODEL_STATE
 from horde_sdk.ai_horde_api.endpoints import AI_HORDE_API_ENDPOINT_SUBPATH
 from horde_sdk.consts import HTTPMethod
-from horde_sdk.generic_api.apimodels import HordeAPIDataObject, HordeResponseBaseModel
+from horde_sdk.generic_api.apimodels import HordeAPIObjectBaseModel, HordeResponseBaseModel
 from horde_sdk.generic_api.decoration import Unequatable, Unhashable
 
 
@@ -122,7 +122,12 @@ def get_default_success_response_type(cls) -> type[ImageStatsModelsResponse]:
         return ImageStatsModelsResponse
 
 
-class SinglePeriodImgStat(HordeAPIDataObject):
+class SinglePeriodImgStat(HordeAPIObjectBaseModel):
+    """Represents the stats for a single period of image generation.
+
+    v2 API Model: `SinglePeriodImgStat`
+    """
+
     images: int | None = Field(
         default=None,
     )
@@ -140,6 +145,11 @@ def mps(self) -> int | None:
 
         return self.ps // 1_000_000
 
+    @override
+    @classmethod
+    def get_api_model_name(cls) -> str | None:
+        return "SinglePeriodImgStat"
+
 
 class ImageStatsModelsTotalResponse(HordeResponseBaseModel):
     """Represents the data returned from the `/v2/stats/img/totals` endpoint."""
@@ -253,7 +263,12 @@ def get_default_success_response_type(cls) -> type[TextStatsModelResponse]:
         return TextStatsModelResponse
 
 
-class SinglePeriodTxtStat(HordeAPIDataObject):
+class SinglePeriodTxtStat(HordeAPIObjectBaseModel):
+    """Represents the stats for a single period.
+
+    v2 API Model: `SinglePeriodTxtStat`
+    """
+
     requests: int | None = Field(
         default=None,
     )
@@ -263,6 +278,11 @@ class SinglePeriodTxtStat(HordeAPIDataObject):
     )
     """The number of tokens generated during this period."""
 
+    @override
+    @classmethod
+    def get_api_model_name(cls) -> str | None:
+        return "SinglePeriodTxtStat"
+
 
 @Unhashable
 class TextStatsModelsTotalResponse(HordeResponseBaseModel):

horde_sdk/ai_horde_api/apimodels/_status.py

@@ -1,6 +1,6 @@
 from collections.abc import Iterator
 
-from pydantic import ConfigDict, Field, RootModel
+from pydantic import ConfigDict, Field
 from typing_extensions import override
 
 from horde_sdk.ai_horde_api.apimodels.base import BaseAIHordeRequest
@@ -9,9 +9,9 @@
 from horde_sdk.consts import HTTPMethod
 from horde_sdk.generic_api.apimodels import (
     ContainsMessageResponseMixin,
-    HordeAPIObject,
-    HordeResponse,
+    HordeAPIObjectBaseModel,
     HordeResponseBaseModel,
+    HordeResponseRootModel,
 )
 from horde_sdk.generic_api.decoration import Unhashable
 
@@ -148,7 +148,7 @@ def get_default_success_response_type(cls) -> type[HordePerformanceResponse]:
         return HordePerformanceResponse
 
 
-class Newspiece(HordeAPIObject):
+class Newspiece(HordeAPIObjectBaseModel):
     date_published: str | None = Field(
         default=None,
     )
@@ -159,6 +159,18 @@ class Newspiece(HordeAPIObject):
         default=None,
     )
     """The actual piece of news."""
+    tags: list[str] | None = Field(
+        default=None,
+    )
+    """The tags associated with this newspiece."""
+    title: str | None = Field(
+        default=None,
+    )
+    """The title of this newspiece."""
+    more_info_urls: list[str] | None = Field(
+        default=None,
+    )
+    """The URLs for more information about this newspiece."""
 
     @override
     @classmethod
@@ -167,7 +179,7 @@ def get_api_model_name(cls) -> str | None:
 
 
 @Unhashable
-class NewsResponse(HordeResponse, RootModel[list[Newspiece]]):
+class NewsResponse(HordeResponseRootModel[list[Newspiece]]):
     root: list[Newspiece]
     """The underlying list of newspieces."""
 
@@ -210,7 +222,7 @@ def get_default_success_response_type(cls) -> type[NewsResponse]:
         return NewsResponse
 
 
-class ActiveModelLite(HordeAPIObject):
+class ActiveModelLite(HordeAPIObjectBaseModel):
     count: int | None = Field(
         default=None,
     )
@@ -256,7 +268,7 @@ def get_api_model_name(cls) -> str | None:
 
 
 @Unhashable
-class HordeStatusModelsAllResponse(HordeResponse, RootModel[list[ActiveModel]]):
+class HordeStatusModelsAllResponse(HordeResponseRootModel[list[ActiveModel]]):
     root: list[ActiveModel]
     """The underlying list of models."""
 
@@ -325,7 +337,7 @@ def get_query_fields(cls) -> list[str]:
 
 
 @Unhashable
-class HordeStatusModelsSingleResponse(HordeResponse, RootModel[list[ActiveModel]]):
+class HordeStatusModelsSingleResponse(HordeResponseRootModel[list[ActiveModel]]):
     # This is a list because of an oversight in the structure of the API response. # FIXME
 
     root: list[ActiveModel]
@@ -377,7 +389,7 @@ def get_default_success_response_type(cls) -> type[HordeStatusModelsSingleRespon
         return HordeStatusModelsSingleResponse
 
 
-class HordeModes(HordeAPIObject):
+class HordeModes(HordeAPIObjectBaseModel):
     maintenance_mode: bool = Field(
         default=False,
     )

horde_sdk/ai_horde_api/apimodels/_styles.py

@@ -3,7 +3,7 @@
 from pydantic import Field
 from strenum import StrEnum
 
-from horde_sdk.generic_api.apimodels import HordeAPIDataObject
+from horde_sdk.generic_api.apimodels import HordeAPIData
 
 
 class StyleType(StrEnum):
@@ -13,7 +13,10 @@ class StyleType(StrEnum):
     text = auto()
 
 
-class ResponseModelStylesUser(HordeAPIDataObject):
+class ResponseModelStylesUser(HordeAPIData):
     name: str
+    """The name of the style."""
     id_: str = Field(alias="id")
+    """The ID of the style."""
     type_: StyleType = Field(alias="type")
+    """The type of the style."""