anaplan-sdk 0.3.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

anaplan_sdk/_async_clients/_audit.py

@@ -1,6 +1,3 @@
-from asyncio import gather
-from itertools import chain
-from math import ceil
 from typing import Literal
 
 import httpx
@@ -25,63 +22,21 @@ class _AsyncAuditClient(_AsyncBaseClient):
         """
         return [
             User.model_validate(e)
-            for e in (await self._get("https://api.anaplan.com/2/0/users")).get("users")
+            for e in await self._get_paginated("https://api.anaplan.com/2/0/users", "users")
         ]
 
     async def get_events(self, days_into_past: int = 30, event_type: Event = "all") -> list:
         """
         Get audit events from Anaplan Audit API.
         :param days_into_past: The nuber of days into the past to get events for. The API provides
-        data for up to 30 days.
+               data for up to 30 days.
         :param event_type: The type of events to get.
         :return: A list of audit events.
         """
-        total = await self._get_total(days_into_past, event_type)
-        if total == 0:
-            return []
-        if total <= 10_000:
-            return await self._get_result_page(days_into_past, event_type)
-
         return list(
-            chain.from_iterable(
-                await gather(
-                    *(
-                        self._get_result_page(
-                            days_into_past, event_type, self._limit, n * self._limit
-                        )
-                        for n in range(ceil(total / self._limit))
-                    )
-                )
-            )
-        )
-
-    async def _get_total(self, days_into_past: int = 60, event_type: Event = "all") -> int:
-        return (  # noqa
-            await self._get(
+            await self._get_paginated(
                 self._url,
-                params={
-                    "limit": 0,
-                    "type": event_type,
-                    "intervalInHours": days_into_past * 24,
-                },
+                "response",
+                params={"type": event_type, "intervalInHours": days_into_past * 24},
             )
-        )["meta"]["paging"]["totalSize"]  # noqa
-
-    async def _get_result_page(
-        self,
-        days_into_past: int = 60,
-        event_type: Event = "all",
-        limit: int = 10_000,
-        offset: int = 0,
-    ) -> list:
-        return (
-            await self._get(
-                self._url,
-                params={
-                    "intervalInHours": days_into_past * 24,
-                    "limit": limit,
-                    "offset": offset,
-                    "type": event_type,
-                },
-            )
-        ).get("response", [])
+        )

anaplan_sdk/_async_clients/_bulk.py

@@ -191,9 +191,11 @@ class AsyncClient(_AsyncBaseClient):
         """
         return [
             Workspace.model_validate(e)
-            for e in (
-                await self._get("https://api.anaplan.com/2/0/workspaces?tenantDetails=true")
-            ).get("workspaces", [])
+            for e in await self._get_paginated(
+                "https://api.anaplan.com/2/0/workspaces",
+                "workspaces",
+                params={"tenantDetails": "true"},
+            )
         ]
 
     async def list_models(self) -> list[Model]:
@@ -203,8 +205,8 @@ class AsyncClient(_AsyncBaseClient):
         """
         return [
             Model.model_validate(e)
-            for e in (await self._get("https://api.anaplan.com/2/0/models?modelDetails=true")).get(
-                "models", []
+            for e in await self._get_paginated(
+                "https://api.anaplan.com/2/0/models", "models", params={"modelDetails": "true"}
             )
         ]
 
@@ -214,7 +216,7 @@ class AsyncClient(_AsyncBaseClient):
         :return: The List of Files.
         """
         return [
-            File.model_validate(e) for e in (await self._get(f"{self._url}/files")).get("files", [])
+            File.model_validate(e) for e in await self._get_paginated(f"{self._url}/files", "files")
         ]
 
     async def list_actions(self) -> list[Action]:
@@ -226,7 +228,7 @@ class AsyncClient(_AsyncBaseClient):
         """
         return [
             Action.model_validate(e)
-            for e in (await self._get(f"{self._url}/actions")).get("actions", [])
+            for e in await self._get_paginated(f"{self._url}/actions", "actions")
         ]
 
     async def list_processes(self) -> list[Process]:
@@ -236,7 +238,7 @@ class AsyncClient(_AsyncBaseClient):
         """
         return [
             Process.model_validate(e)
-            for e in (await self._get(f"{self._url}/processes")).get("processes", [])
+            for e in await self._get_paginated(f"{self._url}/processes", "processes")
         ]
 
     async def list_imports(self) -> list[Import]:
@@ -246,7 +248,7 @@ class AsyncClient(_AsyncBaseClient):
         """
         return [
             Import.model_validate(e)
-            for e in (await self._get(f"{self._url}/imports")).get("imports", [])
+            for e in await self._get_paginated(f"{self._url}/imports", "imports")
         ]
 
     async def list_exports(self) -> list[Export]:
@@ -256,7 +258,7 @@ class AsyncClient(_AsyncBaseClient):
         """
         return [
             Export.model_validate(e)
-            for e in (await self._get(f"{self._url}/exports")).get("exports", [])
+            for e in await self._get_paginated(f"{self._url}/exports", "exports")
         ]
 
     async def run_action(self, action_id: int) -> TaskStatus:
@@ -406,9 +408,9 @@ class AsyncClient(_AsyncBaseClient):
         """
         return [
             TaskSummary.model_validate(e)
-            for e in (
-                await self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks")
-            ).get("tasks", [])
+            for e in await self._get_paginated(
+                f"{self._url}/{action_url(action_id)}/{action_id}/tasks", "tasks"
+            )
         ]
 
     async def get_task_status(self, action_id: int, task_id: str) -> TaskStatus:

anaplan_sdk/_async_clients/_transactional.py

@@ -32,7 +32,7 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
         """
         return [
             Module.model_validate(e)
-            for e in (await self._get(f"{self._url}/modules")).get("modules", [])
+            for e in await self._get_paginated(f"{self._url}/modules", "modules")
         ]
 
     async def get_model_status(self) -> ModelStatus:
@@ -63,7 +63,7 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
         :return: All Lists on this model.
         """
         return [
-            List.model_validate(e) for e in (await self._get(f"{self._url}/lists")).get("lists", [])
+            List.model_validate(e) for e in await self._get_paginated(f"{self._url}/lists", "lists")
         ]
 
     async def get_list_metadata(self, list_id: int) -> ListMetadata:

anaplan_sdk/_base.py

@@ -6,8 +6,12 @@ import asyncio
 import logging
 import random
 import time
+from asyncio import gather
+from concurrent.futures import ThreadPoolExecutor
 from gzip import compress
-from typing import Any, Callable, Coroutine, Literal
+from itertools import chain
+from math import ceil
+from typing import Any, Callable, Coroutine, Iterator, Literal
 
 import httpx
 from httpx import HTTPError, Response
@@ -26,15 +30,13 @@ class _BaseClient:
         self._retry_count = retry_count
         self._client = client
 
-    def _get(self, url: str, **kwargs) -> dict[str, float | int | str | list | dict | bool]:
+    def _get(self, url: str, **kwargs) -> dict[str, Any]:
         return self._run_with_retry(self._client.get, url, **kwargs).json()
 
     def _get_binary(self, url: str) -> bytes:
         return self._run_with_retry(self._client.get, url).content
 
-    def _post(
-        self, url: str, json: dict | list
-    ) -> dict[str, float | int | str | list | dict | bool]:
+    def _post(self, url: str, json: dict | list) -> dict[str, Any]:
         return self._run_with_retry(
             self._client.post, url, headers={"Content-Type": "application/json"}, json=json
         ).json()
@@ -50,6 +52,30 @@ class _BaseClient:
             content=compress(content),
         )
 
+    def __get_page(self, url: str, limit: int, offset: int, result_key: str, **kwargs) -> list:
+        kwargs["params"] = kwargs.get("params", {}) | {"limit": limit, "offset": offset}
+        return self._get(url, **kwargs).get(result_key, [])
+
+    def __get_first_page(self, url: str, limit: int, result_key: str, **kwargs) -> tuple[list, int]:
+        kwargs["params"] = kwargs.get("params", {}) | {"limit": limit}
+        res = self._get(url, **kwargs)
+        return res.get(result_key, []), res["meta"]["paging"]["totalSize"]
+
+    def _get_paginated(
+        self, url: str, result_key: str, page_size: int = 5_000, **kwargs
+    ) -> Iterator[dict[str, Any]]:
+        first_page, total_items = self.__get_first_page(url, page_size, result_key, **kwargs)
+        if total_items <= page_size:
+            return iter(first_page)
+
+        with ThreadPoolExecutor() as executor:
+            pages = executor.map(
+                lambda n: self.__get_page(url, page_size, n * page_size, result_key, **kwargs),
+                range(1, ceil(total_items / page_size)),
+            )
+
+        return chain(first_page, *pages)
+
     def _run_with_retry(self, func: Callable[..., Response], *args, **kwargs) -> Response:
         for i in range(max(self._retry_count, 1)):
             try:
@@ -77,15 +103,13 @@ class _AsyncBaseClient:
         self._retry_count = retry_count
         self._client = client
 
-    async def _get(self, url: str, **kwargs) -> dict[str, float | int | str | list | dict | bool]:
+    async def _get(self, url: str, **kwargs) -> dict[str, Any]:
         return (await self._run_with_retry(self._client.get, url, **kwargs)).json()
 
     async def _get_binary(self, url: str) -> bytes:
         return (await self._run_with_retry(self._client.get, url)).content
 
-    async def _post(
-        self, url: str, json: dict | list
-    ) -> dict[str, float | int | str | list | dict | bool]:
+    async def _post(self, url: str, json: dict | list) -> dict[str, Any]:
         return (
             await self._run_with_retry(
                 self._client.post, url, headers={"Content-Type": "application/json"}, json=json
@@ -103,6 +127,33 @@ class _AsyncBaseClient:
             content=compress(content),
         )
 
+    async def __get_page(
+        self, url: str, limit: int, offset: int, result_key: str, **kwargs
+    ) -> list:
+        kwargs["params"] = kwargs.get("params", {}) | {"limit": limit, "offset": offset}
+        return (await self._get(url, **kwargs)).get(result_key, [])
+
+    async def __get_first_page(
+        self, url: str, limit: int, result_key: str, **kwargs
+    ) -> tuple[list, int]:
+        kwargs["params"] = kwargs.get("params", {}) | {"limit": limit}
+        res = await self._get(url, **kwargs)
+        return res.get(result_key, []), res["meta"]["paging"]["totalSize"]
+
+    async def _get_paginated(
+        self, url: str, result_key: str, page_size: int = 5_000, **kwargs
+    ) -> Iterator[dict[str, Any]]:
+        first_page, total_items = await self.__get_first_page(url, page_size, result_key, **kwargs)
+        if total_items <= page_size:
+            return iter(first_page)
+        pages = await gather(
+            *(
+                self.__get_page(url, page_size, n * page_size, result_key, **kwargs)
+                for n in range(1, ceil(total_items / page_size))
+            )
+        )
+        return chain(first_page, *pages)
+
     async def _run_with_retry(
         self, func: Callable[..., Coroutine[Any, Any, Response]], *args, **kwargs
     ) -> Response:

anaplan_sdk/_clients/_audit.py

@@ -1,5 +1,3 @@
-from itertools import chain
-from math import ceil
 from typing import Literal
 
 import httpx
@@ -25,62 +23,21 @@ class _AuditClient(_BaseClient):
         """
         return [
             User.model_validate(e)
-            for e in self._get("https://api.anaplan.com/2/0/users").get("users")
+            for e in self._get_paginated("https://api.anaplan.com/2/0/users", "users")
         ]
 
     def get_events(self, days_into_past: int = 30, event_type: Event = "all") -> list:
         """
         Get audit events from Anaplan Audit API.
         :param days_into_past: The nuber of days into the past to get events for. The API provides
-                               data for up to 30 days.
+               data for up to 30 days.
         :param event_type: The type of events to get.
         :return: A list of audit events.
         """
-        total = self._get_total(days_into_past, event_type)
-        if total == 0:
-            return []
-        if total <= 10_000:
-            return self._get_result_page(days_into_past, event_type)
-
-        from concurrent.futures import ThreadPoolExecutor
-
-        with ThreadPoolExecutor(max_workers=self._thread_count) as executor:
-            futures = [
-                executor.submit(
-                    self._get_result_page, days_into_past, event_type, self._limit, n * self._limit
-                )
-                for n in range(ceil(total / self._limit))
-            ]
-            results = [future.result() for future in futures]
-            return list(chain.from_iterable(results))
-
-    def _get_total(self, days_into_past: int = 60, event_type: Event = "all") -> int:
-        return (  # noqa
-            self._get(
-                self._url,
-                params={
-                    "limit": 0,
-                    "type": event_type,
-                    "intervalInHours": days_into_past * 24,
-                },
-            )
-        )["meta"]["paging"]["totalSize"]  # noqa
-
-    def _get_result_page(
-        self,
-        days_into_past: int = 60,
-        event_type: Event = "all",
-        limit: int = 10_000,
-        offset: int = 0,
-    ) -> list:
-        return (
-            self._get(
+        return list(
+            self._get_paginated(
                 self._url,
-                params={
-                    "intervalInHours": days_into_past * 24,
-                    "limit": limit,
-                    "offset": offset,
-                    "type": event_type,
-                },
+                "response",
+                params={"type": event_type, "intervalInHours": days_into_past * 24},
             )
-        ).get("response", [])
+        )

anaplan_sdk/_clients/_bulk.py

@@ -199,8 +199,10 @@ class Client(_BaseClient):
         """
         return [
             Workspace.model_validate(e)
-            for e in self._get("https://api.anaplan.com/2/0/workspaces?tenantDetails=true").get(
-                "workspaces", []
+            for e in self._get_paginated(
+                "https://api.anaplan.com/2/0/workspaces",
+                "workspaces",
+                params={"tenantDetails": "true"},
             )
         ]
 
@@ -211,8 +213,8 @@ class Client(_BaseClient):
         """
         return [
             Model.model_validate(e)
-            for e in self._get("https://api.anaplan.com/2/0/models?modelDetails=true").get(
-                "models", []
+            for e in self._get_paginated(
+                "https://api.anaplan.com/2/0/models", "models", params={"modelDetails": "true"}
             )
         ]
 
@@ -221,7 +223,7 @@ class Client(_BaseClient):
         Lists all the Files in the Model.
         :return: The List of Files.
         """
-        return [File.model_validate(e) for e in self._get(f"{self._url}/files").get("files", [])]
+        return [File.model_validate(e) for e in self._get_paginated(f"{self._url}/files", "files")]
 
     def list_actions(self) -> list[Action]:
         """
@@ -231,7 +233,7 @@ class Client(_BaseClient):
         :return: The List of Actions.
         """
         return [
-            Action.model_validate(e) for e in (self._get(f"{self._url}/actions")).get("actions", [])
+            Action.model_validate(e) for e in self._get_paginated(f"{self._url}/actions", "actions")
         ]
 
     def list_processes(self) -> list[Process]:
@@ -241,7 +243,7 @@ class Client(_BaseClient):
         """
         return [
             Process.model_validate(e)
-            for e in (self._get(f"{self._url}/processes")).get("processes", [])
+            for e in self._get_paginated(f"{self._url}/processes", "processes")
         ]
 
     def list_imports(self) -> list[Import]:
@@ -250,7 +252,7 @@ class Client(_BaseClient):
         :return: The List of Imports.
         """
         return [
-            Import.model_validate(e) for e in (self._get(f"{self._url}/imports")).get("imports", [])
+            Import.model_validate(e) for e in self._get_paginated(f"{self._url}/imports", "imports")
         ]
 
     def list_exports(self) -> list[Export]:
@@ -400,8 +402,8 @@ class Client(_BaseClient):
         """
         return [
             TaskSummary.model_validate(e)
-            for e in self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks").get(
-                "tasks", []
+            for e in self._get_paginated(
+                f"{self._url}/{action_url(action_id)}/{action_id}/tasks", "tasks"
             )
         ]
 

anaplan_sdk/_clients/_transactional.py

@@ -28,7 +28,9 @@ class _TransactionalClient(_BaseClient):
         Lists all the Modules in the Model.
         :return: The List of Modules.
         """
-        return [Module.model_validate(e) for e in self._get(f"{self._url}/modules").get("modules")]
+        return [
+            Module.model_validate(e) for e in self._get_paginated(f"{self._url}/modules", "modules")
+        ]
 
     def get_model_status(self) -> ModelStatus:
         """
@@ -53,9 +55,9 @@ class _TransactionalClient(_BaseClient):
     def list_lists(self) -> list[List]:
         """
         Lists all the Lists in the Model.
-        :return: All Lists on this Model.
+        :return: All Lists on this model.
         """
-        return [List.model_validate(e) for e in self._get(f"{self._url}/lists").get("lists", [])]
+        return [List.model_validate(e) for e in self._get_paginated(f"{self._url}/lists", "lists")]
 
     def get_list_metadata(self, list_id: int) -> ListMetadata:
         """

{anaplan_sdk-0.3.0.dist-info → anaplan_sdk-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.3.0
+Version: 0.3.1
 Summary: Provides pythonic access to the Anaplan API
 Project-URL: Homepage, https://vinzenzklass.github.io/anaplan-sdk/
 Project-URL: Repository, https://github.com/VinzenzKlass/anaplan-sdk

anaplan_sdk-0.3.1.dist-info/RECORD

@@ -0,0 +1,19 @@
+anaplan_sdk/__init__.py,sha256=5fr-SZSsH6f3vkRUTDoK6xdAN31cCpe9Mwz2VNu47Uw,134
+anaplan_sdk/_auth.py,sha256=0d495G_iU8vfpk29BJow7Jw2staf18nXqpJlSfaL9h8,5123
+anaplan_sdk/_base.py,sha256=sRsM1z2QadTZ3HhX5NDH6NNRgGCJTy32sJB3cQzDT7E,8465
+anaplan_sdk/exceptions.py,sha256=ALkA9fBF0NQ7dufFxV6AivjmHyuJk9DOQ9jtJV2n7f0,1809
+anaplan_sdk/models.py,sha256=CpfFVJcW4AVwbAoI6GuPClbywjs2bWXOyH7Vrlnlo4o,16255
+anaplan_sdk/_async_clients/__init__.py,sha256=wT6qfi4f_4vLFWTJQTsBw8r3DrHtoTIVqi88p5_j-Cg,259
+anaplan_sdk/_async_clients/_alm.py,sha256=HtpwKNCc5eb6DUgS8nqNocxzaoaHOAMQPo0SaTMaD-A,4021
+anaplan_sdk/_async_clients/_audit.py,sha256=t8tsQQ6v5kJXERAeAWEI1P9-vO5GsJCyWRTwh7EK1uw,1467
+anaplan_sdk/_async_clients/_bulk.py,sha256=O2EiDRdGliYMovGESUvjy2HM0SwsQh9UTmayKmtnASc,22419
+anaplan_sdk/_async_clients/_transactional.py,sha256=eKLT2s5cfnLmK7eqzhfAn8kwoYxEBYgSqwhDgZFA03k,7496
+anaplan_sdk/_clients/__init__.py,sha256=FsbwvZC1FHrxuRXwbPxUzbhz_lO1DpXIxEOjx6-3QuA,219
+anaplan_sdk/_clients/_alm.py,sha256=wzhibRuNzsK3PZM2EOI3OnSGHfv8CG2fuY5zLbnSqog,3912
+anaplan_sdk/_clients/_audit.py,sha256=ae6szT0_OhaNWZUA9b3s2xnkYhSOKbrtnn0SKxmDeqI,1485
+anaplan_sdk/_clients/_bulk.py,sha256=NUW26y0-9PO_4yatabZ3n47ld66nHbBVP7Fx3GbG8l8,22471
+anaplan_sdk/_clients/_transactional.py,sha256=_ZrR40sNREZbaSkIzxpM9iMc85Wq9LDnytR8IlU9lqY,7331
+anaplan_sdk-0.3.1.dist-info/METADATA,sha256=GSpp1wiTd-b1sEKq32K7FzXrc2kTgdio1PK1cUQJsIo,3617
+anaplan_sdk-0.3.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+anaplan_sdk-0.3.1.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+anaplan_sdk-0.3.1.dist-info/RECORD,,

anaplan_sdk-0.3.0.dist-info/RECORD

@@ -1,19 +0,0 @@
-anaplan_sdk/__init__.py,sha256=5fr-SZSsH6f3vkRUTDoK6xdAN31cCpe9Mwz2VNu47Uw,134
-anaplan_sdk/_auth.py,sha256=0d495G_iU8vfpk29BJow7Jw2staf18nXqpJlSfaL9h8,5123
-anaplan_sdk/_base.py,sha256=MEE6LpL788QTkrpAVsYI5hu3RfbzSMLGUj-QSW8-OU0,6160
-anaplan_sdk/exceptions.py,sha256=ALkA9fBF0NQ7dufFxV6AivjmHyuJk9DOQ9jtJV2n7f0,1809
-anaplan_sdk/models.py,sha256=CpfFVJcW4AVwbAoI6GuPClbywjs2bWXOyH7Vrlnlo4o,16255
-anaplan_sdk/_async_clients/__init__.py,sha256=wT6qfi4f_4vLFWTJQTsBw8r3DrHtoTIVqi88p5_j-Cg,259
-anaplan_sdk/_async_clients/_alm.py,sha256=HtpwKNCc5eb6DUgS8nqNocxzaoaHOAMQPo0SaTMaD-A,4021
-anaplan_sdk/_async_clients/_audit.py,sha256=wgJx58aDksWJLu4MU-tOz76KjG41AVzBW0v3jAEv9GE,2897
-anaplan_sdk/_async_clients/_bulk.py,sha256=X5W6-WgUYW9O2f8SIWy7IxjSv4vAz9fYL9jxpEzrpXQ,22354
-anaplan_sdk/_async_clients/_transactional.py,sha256=LlrEVc6c9cUD62PBlOCNjS0ALxqoHy5GZvadacyPbG8,7496
-anaplan_sdk/_clients/__init__.py,sha256=FsbwvZC1FHrxuRXwbPxUzbhz_lO1DpXIxEOjx6-3QuA,219
-anaplan_sdk/_clients/_alm.py,sha256=wzhibRuNzsK3PZM2EOI3OnSGHfv8CG2fuY5zLbnSqog,3912
-anaplan_sdk/_clients/_audit.py,sha256=jqj_sTGNUaM2jAu91Us747pVULntPUkL_qkA4nKc8so,2981
-anaplan_sdk/_clients/_bulk.py,sha256=3oOaUqjvHF-L-ThFK7joLMQ2iDSSFZ9y5mVUhW45fp8,22398
-anaplan_sdk/_clients/_transactional.py,sha256=2ssYdMY9vynQUwwigOvgSgi2-wbfXDQaAShLqXbVFSQ,7299
-anaplan_sdk-0.3.0.dist-info/METADATA,sha256=b4_PgGjPB-TPX2RV3R5PMLxozPjAnCqq6naA3BXLpNA,3617
-anaplan_sdk-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-anaplan_sdk-0.3.0.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-anaplan_sdk-0.3.0.dist-info/RECORD,,