[pre-commit.ci] auto fixes from pre-commit.com hooks

pre-commit-ci[bot] · pre-commit-ci[bot] · commit d92eeaa4b681 · 2025-12-24T15:30:26.000Z
for more information, see https://pre-commit.ci
diff --git a/.github/workflows/maintests.yml b/.github/workflows/maintests.yml
@@ -41,4 +41,4 @@ jobs:
 
 
       - name: Run tests
-        run: uv run pytest tests --ignore-glob='**/*api_calls*' -m "not api_side_ci"
+        run: uv run pytest tests --ignore-glob='**/*api_calls*' -m "not api_side_ci"
diff --git a/docs/.pages b/docs/.pages
@@ -21,7 +21,7 @@ nav:
         - SDK Client Design: concepts/client_design
         - Backend Values Mappers: concepts/backend_values_mappers
     - horde_sdk
-       
+
     - GitHub Repo: 'https://github.com/Haidra-Org/horde-sdk'
 
 order: desc
diff --git a/docs/concepts/backend_values_mappers.md b/docs/concepts/backend_values_mappers.md
@@ -131,7 +131,7 @@ def map_to_example_backend_sampler(self, sdk_sampler: KNOWN_IMAGE_SAMPLERS) -> K
     """Maps an SDK sampler to a backend sampler."""
     ...
 
-... 
+...
 ```
 
 #### Understanding `_map_value` and `_is_valid_value`
diff --git a/docs/concepts/client_design.md b/docs/concepts/client_design.md
@@ -12,9 +12,9 @@ classDiagram
     class GenericHordeAPIManualClient
 
     class GenericAsyncHordeAPIManualClient
-    class GenericHordeAPISession 
+    class GenericHordeAPISession
 
-    class GenericAsyncHordeAPISession 
+    class GenericAsyncHordeAPISession
 
     BaseHordeAPIClient <|-- GenericHordeAPIManualClient
     BaseHordeAPIClient <|-- GenericAsyncHordeAPIManualClient
diff --git a/docs/concepts/style_guide.md b/docs/concepts/style_guide.md
@@ -162,7 +162,7 @@ Many classes contain standardized prefixes, suffixes, or identifiers within thei
         - For example, methods which are known to rely on external resources (e.g., network calls, file I/O) should document the exceptions that may be raised in the event of a failure.
         - It is **not** expected that every conceivable exception raised from a particular call hierarchy is documented, but rather those that are most likely to occur and can be reasonably anticipated.
             - A method that opens a file should document `FileNotFoundError` and `IOError` in its `Raises` section, while network-related methods should document `ConnectionError`, `TimeoutError`, and other relevant exceptions.
-  
+
 ### API Model Specific Documentation
 
 Many docstrings in the SDK have additional requirements when they are related to API models or requests/responses. While these rules would be difficult to remember, they are luckily enforced by CI and the `horde_sdk.meta` module has helper functions to assist in generating the required docstrings. The correct docstrings will also be emitted by the `object_verify` tests. Be sure to run the tests with `-s` to see the output.
diff --git a/docs/worker/generation_states_flow.md b/docs/worker/generation_states_flow.md
@@ -14,7 +14,7 @@ flowchart TD
 
     NOT_STARTED@{shape: subproc}
     PRELOADING@{shape: subproc}
-    PRELOADING_COMPLETE@{shape: subproc} 
+    PRELOADING_COMPLETE@{shape: subproc}
     PENDING_POST_PROCESSING@{ shape: subproc}
     POST_PROCESSING@{ shape: subproc}
     GENERATING@{ shape: subproc}
@@ -119,7 +119,7 @@ Good:
     - Here, the worker encountered an error during preloading, attempted to recover, but failed again and then aborted the job. Note that you can set the intended number of retries in worker job configuration. See the `HordeWorkerJobConfig` class and the  `state_error_limits` arg in a generation class constructor for more details.
 - `NOT_STARTED` -> `PRELOADING` -> `USER_REQUESTED_ABORT` -> `USER_ABORT_COMPLETE`
     - In this case, the user who created the job requested an abort, and the worker was able to complete the abort process successfully.
-  
+
 Bad:
 
 - `NOT_STARTED` -> `PRELOADING` -> `ERROR` -> `GENERATING`
diff --git a/docs/worker/generations.md b/docs/worker/generations.md
@@ -85,7 +85,7 @@ These functions return the transitioned to state.
 #### Important Notes on State Transitions
 
 - **Strict Order:** You must call state transition methods in the correct sequence. For example, you cannot call `on_generating()` before `on_preloading_complete()`. This strictness helps catch workflow errors early. Out-of-order calls almost always indicate a problem in your logic or resource handling.
-- **Error Handling:** If an error occurs at any step, use `on_error(failed_message="...")` to move the generation into the `ERROR` state. This lets you handle errors gracefully and, if needed, recover. To continue after an error, you must return to the most recent valid state before proceeding.  
+- **Error Handling:** If an error occurs at any step, use `on_error(failed_message="...")` to move the generation into the `ERROR` state. This lets you handle errors gracefully and, if needed, recover. To continue after an error, you must return to the most recent valid state before proceeding.
     - For example, if you are in the `GENERATING` state and an error occurs, call `on_error()` to enter `ERROR`, then call `on_generating()` again to retry.
 - **Dynamic States:** Some transition methods, such as `on_generation_work_complete()`, may lead to different next states depending on context (e.g., whether post-processing is required). The class handles these decisions internally, so you don’t need to manually select the next state.
 - **Manual States:** You can use the generic `step(state)` or `on_state(state)` methods to transition to a specific state. However, you are responsible for ensuring the transition is valid—these methods bypass some of the built-in checks.
@@ -346,7 +346,7 @@ flowchart TD
 
     NOT_STARTED@{shape: subproc}
     PRELOADING@{shape: subproc}
-    PRELOADING_COMPLETE@{shape: subproc} 
+    PRELOADING_COMPLETE@{shape: subproc}
     PENDING_POST_PROCESSING@{ shape: subproc}
     POST_PROCESSING@{ shape: subproc}
     GENERATING@{ shape: subproc}
@@ -451,7 +451,7 @@ Good:
     - Here, the worker encountered an error during preloading, attempted to recover, but failed again and then aborted the job. Note that you can set the intended number of retries in worker job configuration. See the `HordeWorkerJobConfig` class and the  `state_error_limits` arg in a generation class constructor for more details.
 - `NOT_STARTED` -> `PRELOADING` -> `USER_REQUESTED_ABORT` -> `USER_ABORT_COMPLETE`
     - In this case, the user who created the job requested an abort, and the worker was able to complete the abort process successfully.
-  
+
 Bad:
 
 - `NOT_STARTED` -> `PRELOADING` -> `ERROR` -> `GENERATING`
diff --git a/horde_sdk/generation_parameters/image/object_models.py b/horde_sdk/generation_parameters/image/object_models.py
@@ -259,7 +259,6 @@ class BasicImageGenerationParameters(BasicImageGenerationParametersTemplate):
         from_attributes=True,
     )
 
-
     model: str
     """The model to use for the generation."""
 
diff --git a/horde_sdk/generation_parameters/utils.py b/horde_sdk/generation_parameters/utils.py
@@ -41,7 +41,9 @@ class TemplateFinalization[TemplateT: BaseModel]:
     payload: dict[str, object]
 
 
-def apply_template_overrides[TemplateT: BaseModel](
+def apply_template_overrides[
+    TemplateT: BaseModel
+](
     template: TemplateT,
     *,
     overrides: Mapping[str, object] | None = None,
diff --git a/tests/ai_horde_api/test_ai_horde_generate_api_calls.py b/tests/ai_horde_api/test_ai_horde_generate_api_calls.py
@@ -51,11 +51,11 @@ async def submit_request(
             ) -> ImageGenerateAsyncResponse | RequestErrorResponse | None:
                 await asyncio.sleep(delay)
                 async with AIHordeAPIAsyncClientSession(aiohttp_session) as horde_session:
-                    api_response: (
-                        ImageGenerateAsyncResponse | RequestErrorResponse
-                    ) = await horde_session.submit_request(
-                        simple_image_gen_request,
-                        simple_image_gen_request.get_default_success_response_type(),
+                    api_response: ImageGenerateAsyncResponse | RequestErrorResponse = (
+                        await horde_session.submit_request(
+                            simple_image_gen_request,
+                            simple_image_gen_request.get_default_success_response_type(),
+                        )
                     )
                     return api_response
                 return None
diff --git a/tests/ai_horde_api/test_dynamically_validate_against_swagger.py b/tests/ai_horde_api/test_dynamically_validate_against_swagger.py
@@ -118,15 +118,15 @@ def all_ai_horde_model_defs_in_swagger(swagger_doc: SwaggerDoc) -> None:
                     "Consider giving it a unique name on the API.",
                 )
             else:
-                assert request_type.get_api_model_name() in swagger_defined_models, (
-                    f"Model is defined in horde_sdk, but not in swagger: {request_type.get_api_model_name()}"
-                )
+                assert (
+                    request_type.get_api_model_name() in swagger_defined_models
+                ), f"Model is defined in horde_sdk, but not in swagger: {request_type.get_api_model_name()}"
 
             assert endpoint_subpath in swagger_doc.paths, f"Missing {request_type.__name__} in swagger"
 
-            assert endpoint_subpath in swagger_defined_payload_examples, (
-                f"Missing {request_type.__name__} in swagger examples"
-            )
+            assert (
+                endpoint_subpath in swagger_defined_payload_examples
+            ), f"Missing {request_type.__name__} in swagger examples"
 
         endpoint_http_status_code_responses: dict[HTTPStatusCode, dict[str, object] | list[Any]] | None | None = None
 
@@ -155,18 +155,18 @@ def all_ai_horde_model_defs_in_swagger(swagger_doc: SwaggerDoc) -> None:
                 for success_code in get_all_success_status_codes()
                 if success_code in endpoint_http_status_code_responses
             ]
-            assert len(endpoint_success_http_status_codes) > 0, (
-                f"Failed to find any success status codes in {request_type.__name__}"
-            )
+            assert (
+                len(endpoint_success_http_status_codes) > 0
+            ), f"Failed to find any success status codes in {request_type.__name__}"
 
             for success_code in endpoint_success_http_status_codes:
-                assert success_code in request_type.get_success_status_response_pairs(), (
-                    f"Missing success response type for {request_type.__name__} with status code {success_code}"
-                )
+                assert (
+                    success_code in request_type.get_success_status_response_pairs()
+                ), f"Missing success response type for {request_type.__name__} with status code {success_code}"
         else:
-            assert request_type.get_default_success_response_type() is not None, (
-                f"Failed to get default success response type for {request_type.__name__}"
-            )
+            assert (
+                request_type.get_default_success_response_type() is not None
+            ), f"Failed to get default success response type for {request_type.__name__}"
 
         api_to_sdk_response_model_map[endpoint_subpath] = request_type.get_success_status_response_pairs()
 
diff --git a/tests/generation_parameters/test_template_finalization_enforcement.py b/tests/generation_parameters/test_template_finalization_enforcement.py
@@ -80,6 +80,6 @@ def _tracking_finalize(*args: object, **kwargs: object) -> object:
     call_kwargs = case.call_kwargs_factory(module)
     template.to_parameters(**call_kwargs)
 
-    assert finalize_called, (
-        "Template.conversion must call finalize_template_for_parameters() to ensure deterministic result IDs."
-    )
+    assert (
+        finalize_called
+    ), "Template.conversion must call finalize_template_for_parameters() to ensure deterministic result IDs."
diff --git a/tests/test_verify_api_surface.py b/tests/test_verify_api_surface.py
@@ -54,9 +54,9 @@ def test_all_ai_horde_api_models_defined() -> None:
         if key in undefined_classes:
             undefined_classes.remove(key)
 
-    assert "GenerationInputStable" not in undefined_classes, (
-        "A model which is known to be defined in the SDK was not found. Something critically bad has happened."
-    )
+    assert (
+        "GenerationInputStable" not in undefined_classes
+    ), "A model which is known to be defined in the SDK was not found. Something critically bad has happened."
 
     # Pretty print the undefined classes sorted by dict values, NOT by keys
     import json
@@ -104,9 +104,9 @@ def test_all_ai_horde_api_models_defined() -> None:
         if skipped_class in undefined_classes:
             undefined_classes.remove(skipped_class)
 
-    assert not undefined_classes, (
-        f"The following models are defined in the API but not in the SDK: {undefined_classes}"
-    )
+    assert (
+        not undefined_classes
+    ), f"The following models are defined in the API but not in the SDK: {undefined_classes}"
 
 
 @pytest.mark.object_verify
@@ -116,9 +116,9 @@ def test_all_ai_horde_api_models_defined_for_endpoints() -> None:
 
     undefined_classes = all_undefined_classes_for_endpoints(horde_sdk.ai_horde_api.apimodels)
 
-    assert "GenerationInputStable" not in undefined_classes, (
-        "A model which is known to be defined in the SDK was not found. Something critically bad has happened."
-    )
+    assert (
+        "GenerationInputStable" not in undefined_classes
+    ), "A model which is known to be defined in the SDK was not found. Something critically bad has happened."
 
     # Pretty print the undefined classes sorted by dict values, NOT by keys
     import json
@@ -136,9 +136,9 @@ def test_all_ai_horde_api_models_defined_for_endpoints() -> None:
     undefined_classes_sorted = dict(sorted(undefined_classes.items(), key=lambda x: x[1]))
     print(json.dumps(undefined_classes_sorted, indent=4))
 
-    assert not undefined_classes, (
-        f"The following models are defined in the API but not in the SDK: {undefined_classes}"
-    )
+    assert (
+        not undefined_classes
+    ), f"The following models are defined in the API but not in the SDK: {undefined_classes}"
 
 
 @pytest.mark.object_verify
@@ -147,9 +147,9 @@ def test_all_ai_horde_endpoints_known() -> None:
 
     unknown_endpoints = all_unknown_endpoints_ai_horde()
 
-    assert not unknown_endpoints, (
-        f"The following endpoints are defined in the API but not in the SDK: {unknown_endpoints}"
-    )
+    assert (
+        not unknown_endpoints
+    ), f"The following endpoints are defined in the API but not in the SDK: {unknown_endpoints}"
 
 
 # @pytest.mark.skip(reason="This test is not yet enforced.")
@@ -168,9 +168,9 @@ def test_all_ai_horde_endpoints_addressed() -> None:
     for unaddressed_endpoint in unaddressed_endpoints:
         print(f"Unaddressed path: {unaddressed_endpoint}.")
 
-    assert not unaddressed_endpoints, (
-        f"The following endpoints are defined in the API but not in the SDK: {unaddressed_endpoints}"
-    )
+    assert (
+        not unaddressed_endpoints
+    ), f"The following endpoints are defined in the API but not in the SDK: {unaddressed_endpoints}"
 
 
 @pytest.mark.object_verify

Original file line number	Diff line number	Diff line change
`@@ -41,4 +41,4 @@ jobs:`
`41`	`41`
`42`	`42`
`43`	`43`	`- name: Run tests`
`44`		`- run: uv run pytest tests --ignore-glob='*/api_calls*' -m "not api_side_ci"`
	`44`	`+ run: uv run pytest tests --ignore-glob='*/api_calls*' -m "not api_side_ci"`
Original file line number	Diff line number	Diff line change
`@@ -259,7 +259,6 @@ class BasicImageGenerationParameters(BasicImageGenerationParametersTemplate):`
`259`	`259`	`from_attributes=True,`
`260`	`260`	`)`
`261`	`261`
`262`		`-`
`263`	`262`	`model: str`
`264`	`263`	`"""The model to use for the generation."""`
`265`	`264`