MPT-14533 Create collection mixins (#96)

- Moved collection related methods from Service to CollectionMixin.
- Created Resource types mixins: ModifiableResourceMixin,
ManagedResourceMixin
- Updated Resources to use new mixins

Author: d3rky

mpt_api_client/http/async_service.py

@@ -1,11 +1,10 @@
-from collections.abc import AsyncIterator
 from urllib.parse import urljoin
 
 from mpt_api_client.http.async_client import AsyncHTTPClient
 from mpt_api_client.http.base_service import ServiceBase
 from mpt_api_client.http.types import QueryParam, Response
-from mpt_api_client.models import Collection, ResourceData
 from mpt_api_client.models import Model as BaseModel
+from mpt_api_client.models import ResourceData
 from mpt_api_client.models.collection import ResourceList
 
 
@@ -21,72 +20,6 @@ class AsyncService[Model: BaseModel](ServiceBase[AsyncHTTPClient, Model]):  # no
 
     """
 
-    async def fetch_page(self, limit: int = 100, offset: int = 0) -> Collection[Model]:
-        """Fetch one page of resources.
-
-        Returns:
-            Collection of resources.
-        """
-        response = await self._fetch_page_as_response(limit=limit, offset=offset)
-        return self._create_collection(response)
-
-    async def fetch_one(self) -> Model:
-        """Fetch one resource, expect exactly one result.
-
-        Returns:
-            One resource.
-
-        Raises:
-            ValueError: If the total matching records are not exactly one.
-        """
-        response = await self._fetch_page_as_response(limit=1, offset=0)
-        resource_list = self._create_collection(response)
-        total_records = len(resource_list)
-        if resource_list.meta:
-            total_records = resource_list.meta.pagination.total
-        if total_records == 0:
-            raise ValueError("Expected one result, but got zero results")
-        if total_records > 1:
-            raise ValueError(f"Expected one result, but got {total_records} results")
-
-        return resource_list[0]
-
-    async def iterate(self, batch_size: int = 100) -> AsyncIterator[Model]:
-        """Iterate over all resources, yielding GenericResource objects.
-
-        Args:
-            batch_size: Number of resources to fetch per request
-
-        Returns:
-            Iterator of resources.
-        """
-        offset = 0
-        limit = batch_size  # Default page size
-
-        while True:
-            response = await self._fetch_page_as_response(limit=limit, offset=offset)
-            items_collection = self._create_collection(response)
-            for resource in items_collection:
-                yield resource
-
-            if not items_collection.meta:
-                break
-            if not items_collection.meta.pagination.has_next():
-                break
-            offset = items_collection.meta.pagination.next_offset()
-
-    async def _fetch_page_as_response(self, limit: int = 100, offset: int = 0) -> Response:
-        """Fetch one page of resources.
-
-        Returns:
-            Response object.
-
-        Raises:
-            HTTPStatusError: if the response status code is not 200.
-        """
-        pagination_params: dict[str, int] = {"limit": limit, "offset": offset}
-        return await self.http_client.request("get", self.build_path(pagination_params))
-
     async def _resource_do_request(  # noqa: WPS211
         self,
         resource_id: str,

mpt_api_client/http/base_service.py

@@ -1,13 +1,12 @@
 from typing import Any
 
-from mpt_api_client.http.mixins import QueryableMixin
 from mpt_api_client.http.query_state import QueryState
 from mpt_api_client.http.types import Response
 from mpt_api_client.models import Collection, Meta
 from mpt_api_client.models import Model as BaseModel
 
 
-class ServiceBase[Client, Model: BaseModel](QueryableMixin):  # noqa: WPS214
+class ServiceBase[Client, Model: BaseModel]:  # noqa: WPS214
     """Service base with agnostic HTTP client."""
 
     _endpoint: str
@@ -43,7 +42,12 @@ def build_path(
         return f"{self.path}?{query}" if query else self.path
 
     @classmethod
-    def _create_collection(cls, response: Response) -> Collection[Model]:
+    def make_collection(cls, response: Response) -> Collection[Model]:
+        """Builds a collection from a response.
+
+        Args:
+            response: The response object.
+        """
         meta = Meta.from_response(response)
         return Collection(
             resources=[

mpt_api_client/http/mixins.py

@@ -1,10 +1,12 @@
 import json
+from collections.abc import AsyncIterator, Iterator
 from typing import Self
 from urllib.parse import urljoin
 
 from mpt_api_client.http.query_state import QueryState
 from mpt_api_client.http.types import FileTypes, Response
-from mpt_api_client.models import FileModel, ResourceData
+from mpt_api_client.models import Collection, FileModel, ResourceData
+from mpt_api_client.models import Model as BaseModel
 from mpt_api_client.rql import RQLQuery
 
 
@@ -301,3 +303,162 @@ def _create_new_instance(
             query_state=query_state,
             endpoint_params=self.endpoint_params,  # type: ignore[attr-defined]
         )
+
+
+class CollectionMixin[Model: BaseModel](QueryableMixin):
+    """Mixin providing collection functionality."""
+
+    def fetch_page(self, limit: int = 100, offset: int = 0) -> Collection[Model]:
+        """Fetch one page of resources.
+
+        Returns:
+            Collection of resources.
+        """
+        response = self._fetch_page_as_response(limit=limit, offset=offset)
+        return self.make_collection(response)  # type: ignore[attr-defined, no-any-return]
+
+    def fetch_one(self) -> Model:
+        """Fetch one resource, expect exactly one result.
+
+        Returns:
+            One resource.
+
+        Raises:
+            ValueError: If the total matching records are not exactly one.
+        """
+        response = self._fetch_page_as_response(limit=1, offset=0)
+        resource_list = self.make_collection(response)  # type: ignore[attr-defined]
+        total_records = len(resource_list)
+        if resource_list.meta:
+            total_records = resource_list.meta.pagination.total
+        if total_records == 0:
+            raise ValueError("Expected one result, but got zero results")
+        if total_records > 1:
+            raise ValueError(f"Expected one result, but got {total_records} results")
+
+        return resource_list[0]  # type: ignore[no-any-return]
+
+    def iterate(self, batch_size: int = 100) -> Iterator[Model]:
+        """Iterate over all resources, yielding GenericResource objects.
+
+        Args:
+            batch_size: Number of resources to fetch per request
+
+        Returns:
+            Iterator of resources.
+        """
+        offset = 0
+        limit = batch_size  # Default page size
+
+        while True:
+            response = self._fetch_page_as_response(limit=limit, offset=offset)
+            items_collection = self.make_collection(response)  # type: ignore[attr-defined]
+            yield from items_collection
+
+            if not items_collection.meta:
+                break
+            if not items_collection.meta.pagination.has_next():
+                break
+            offset = items_collection.meta.pagination.next_offset()
+
+    def _fetch_page_as_response(self, limit: int = 100, offset: int = 0) -> Response:
+        """Fetch one page of resources.
+
+        Returns:
+            Response object.
+
+        Raises:
+            HTTPStatusError: if the response status code is not 200.
+        """
+        pagination_params: dict[str, int] = {"limit": limit, "offset": offset}
+        return self.http_client.request("get", self.build_path(pagination_params))  # type: ignore[attr-defined, no-any-return]
+
+
+class AsyncCollectionMixin[Model: BaseModel](QueryableMixin):
+    """Async mixin providing collection functionality."""
+
+    async def fetch_page(self, limit: int = 100, offset: int = 0) -> Collection[Model]:
+        """Fetch one page of resources.
+
+        Returns:
+            Collection of resources.
+        """
+        response = await self._fetch_page_as_response(limit=limit, offset=offset)
+        return self.make_collection(response)  # type: ignore[no-any-return,attr-defined]
+
+    async def fetch_one(self) -> Model:
+        """Fetch one resource, expect exactly one result.
+
+        Returns:
+            One resource.
+
+        Raises:
+            ValueError: If the total matching records are not exactly one.
+        """
+        response = await self._fetch_page_as_response(limit=1, offset=0)
+        resource_list = self.make_collection(response)  # type: ignore[attr-defined]
+        total_records = len(resource_list)
+        if resource_list.meta:
+            total_records = resource_list.meta.pagination.total
+        if total_records == 0:
+            raise ValueError("Expected one result, but got zero results")
+        if total_records > 1:
+            raise ValueError(f"Expected one result, but got {total_records} results")
+
+        return resource_list[0]  # type: ignore[no-any-return]
+
+    async def iterate(self, batch_size: int = 100) -> AsyncIterator[Model]:
+        """Iterate over all resources, yielding GenericResource objects.
+
+        Args:
+            batch_size: Number of resources to fetch per request
+
+        Returns:
+            Iterator of resources.
+        """
+        offset = 0
+        limit = batch_size  # Default page size
+
+        while True:
+            response = await self._fetch_page_as_response(limit=limit, offset=offset)
+            items_collection = self.make_collection(response)  # type: ignore[attr-defined]
+            for resource in items_collection:
+                yield resource
+
+            if not items_collection.meta:
+                break
+            if not items_collection.meta.pagination.has_next():
+                break
+            offset = items_collection.meta.pagination.next_offset()
+
+    async def _fetch_page_as_response(self, limit: int = 100, offset: int = 0) -> Response:
+        """Fetch one page of resources.
+
+        Returns:
+            Response object.
+
+        Raises:
+            HTTPStatusError: if the response status code is not 200.
+        """
+        pagination_params: dict[str, int] = {"limit": limit, "offset": offset}
+        return await self.http_client.request("get", self.build_path(pagination_params))  # type: ignore[attr-defined,no-any-return]
+
+
+class ModifiableResourceMixin[Model](GetMixin[Model], UpdateMixin[Model], DeleteMixin):
+    """Editable resource mixin allows to read and update a resource resources."""
+
+
+class AsyncModifiableResourceMixin[Model](
+    AsyncGetMixin[Model], AsyncUpdateMixin[Model], AsyncDeleteMixin
+):
+    """Editable resource mixin allows to read and update a resource resources."""
+
+
+class ManagedResourceMixin[Model](CreateMixin[Model], ModifiableResourceMixin[Model]):
+    """Managed resource mixin allows to read, create, update and delete a resource resources."""
+
+
+class AsyncManagedResourceMixin[Model](
+    AsyncCreateMixin[Model], AsyncModifiableResourceMixin[Model]
+):
+    """Managed resource mixin allows to read, create, update and delete a resource resources."""

mpt_api_client/http/service.py

@@ -1,11 +1,10 @@
-from collections.abc import Iterator
 from urllib.parse import urljoin
 
 from mpt_api_client.http.base_service import ServiceBase
 from mpt_api_client.http.client import HTTPClient
 from mpt_api_client.http.types import QueryParam, Response
-from mpt_api_client.models import Collection, ResourceData
 from mpt_api_client.models import Model as BaseModel
+from mpt_api_client.models import ResourceData
 from mpt_api_client.models.collection import ResourceList
 
 
@@ -21,71 +20,6 @@ class Service[Model: BaseModel](ServiceBase[HTTPClient, Model]):  # noqa: WPS214
 
     """
 
-    def fetch_page(self, limit: int = 100, offset: int = 0) -> Collection[Model]:
-        """Fetch one page of resources.
-
-        Returns:
-            Collection of resources.
-        """
-        response = self._fetch_page_as_response(limit=limit, offset=offset)
-        return self._create_collection(response)
-
-    def fetch_one(self) -> Model:
-        """Fetch one resource, expect exactly one result.
-
-        Returns:
-            One resource.
-
-        Raises:
-            ValueError: If the total matching records are not exactly one.
-        """
-        response = self._fetch_page_as_response(limit=1, offset=0)
-        resource_list = self._create_collection(response)
-        total_records = len(resource_list)
-        if resource_list.meta:
-            total_records = resource_list.meta.pagination.total
-        if total_records == 0:
-            raise ValueError("Expected one result, but got zero results")
-        if total_records > 1:
-            raise ValueError(f"Expected one result, but got {total_records} results")
-
-        return resource_list[0]
-
-    def iterate(self, batch_size: int = 100) -> Iterator[Model]:
-        """Iterate over all resources, yielding GenericResource objects.
-
-        Args:
-            batch_size: Number of resources to fetch per request
-
-        Returns:
-            Iterator of resources.
-        """
-        offset = 0
-        limit = batch_size  # Default page size
-
-        while True:
-            response = self._fetch_page_as_response(limit=limit, offset=offset)
-            items_collection = self._create_collection(response)
-            yield from items_collection
-
-            if not items_collection.meta:
-                break
-            if not items_collection.meta.pagination.has_next():
-                break
-            offset = items_collection.meta.pagination.next_offset()
-
-    def _fetch_page_as_response(self, limit: int = 100, offset: int = 0) -> Response:
-        """Fetch one page of resources.
-
-        Returns:
-            Response object.
-
-        Raises:
-            HTTPStatusError: if the response status code is not 200.
-        """
-        pagination_params: dict[str, int] = {"limit": limit, "offset": offset}
-        return self.http_client.request("get", self.build_path(pagination_params))
-
     def _resource_do_request(  # noqa: WPS211
         self,
         resource_id: str,