Merge pull request #95 from TanyaSingh369-svg/refactor/iterator-pattern/policy-set

Refactor(policy-set): convert list to Iterator pattern

Author: isivaselvan

examples/policy_set.py

@@ -163,16 +163,15 @@ def main():
         )
 
     try:
-        ps_list = client.policy_sets.list(args.org, list_options)
+        ps_list = list(client.policy_sets.list(args.org, list_options))
 
-        print(f"Total policy sets: {ps_list.total_count}")
-        print(f"Page {ps_list.current_page} of {ps_list.total_pages}")
+        print(f"Total policy sets: {len(ps_list)}")
         print()
 
-        if not ps_list.items:
+        if not ps_list:
             print("No policy sets found for this organization.")
         else:
-            for ps in ps_list.items:
+            for ps in ps_list:
                 print(
                     f"- ID: {ps.id} | Name: {ps.name} | Kind: {ps.kind} | Global: {ps.Global}"
                 )

src/pytfe/resources/policy_set.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from collections.abc import Iterator
+
 from ..errors import (
     InvalidNameError,
     InvalidOrgError,
@@ -17,7 +19,6 @@
     PolicySetAddWorkspaceExclusionsOptions,
     PolicySetAddWorkspacesOptions,
     PolicySetCreateOptions,
-    PolicySetList,
     PolicySetListOptions,
     PolicySetReadOptions,
     PolicySetRemovePoliciesOptions,
@@ -38,47 +39,41 @@ class PolicySets(_Service):
 
     def list(
         self, organization: str, options: PolicySetListOptions | None = None
-    ) -> PolicySetList:
-        """List all the policy sets of the given organization."""
+    ) -> Iterator[PolicySet]:
+        """Iterate all the policy sets of the given organization."""
         if not valid_string_id(organization):
             raise InvalidOrgError()
+
+        # Build params from options but do not pass page[number] — let _list handle pagination.
         params = options.model_dump(by_alias=True, exclude_none=True) if options else {}
-        r = self.t.request(
-            "GET",
-            f"/api/v2/organizations/{organization}/policy-sets",
-            params=params,
-        )
-        jd = r.json()
-        items = []
-        meta = jd.get("meta", {})
-        pagination = meta.get("pagination", {})
-        for d in jd.get("data", []):
-            attrs = d.get("attributes", {})
-            attrs["id"] = d.get("id")
-            attrs["organization"] = d.get("relationships", {}).get("organization", {})
-            attrs["workspace_exclusions"] = (
-                d.get("relationships", {})
-                .get("workspace-exclusions", {})
-                .get("data", [])
-            )
-            attrs["workspaces"] = (
-                d.get("relationships", {}).get("workspaces", {}).get("data", [])
-            )
-            attrs["projects"] = (
-                d.get("relationships", {}).get("projects", {}).get("data", [])
-            )
-            attrs["policies"] = (
-                d.get("relationships", {}).get("policies", {}).get("data", [])
-            )
-            items.append(PolicySet.model_validate(attrs))
-        return PolicySetList(
-            items=items,
-            current_page=pagination.get("current-page"),
-            total_pages=pagination.get("total-pages"),
-            prev_page=pagination.get("prev-page"),
-            next_page=pagination.get("next-page"),
-            total_count=pagination.get("total-count"),
-        )
+        params.pop("page[number]", None)
+
+        path = f"/api/v2/organizations/{organization}/policy-sets"
+
+        def _gen() -> Iterator[PolicySet]:
+            for d in self._list(path, params=params):
+                attrs = d.get("attributes", {})
+                attrs["id"] = d.get("id")
+                attrs["organization"] = d.get("relationships", {}).get(
+                    "organization", {}
+                )
+                attrs["workspace_exclusions"] = (
+                    d.get("relationships", {})
+                    .get("workspace-exclusions", {})
+                    .get("data", [])
+                )
+                attrs["workspaces"] = (
+                    d.get("relationships", {}).get("workspaces", {}).get("data", [])
+                )
+                attrs["projects"] = (
+                    d.get("relationships", {}).get("projects", {}).get("data", [])
+                )
+                attrs["policies"] = (
+                    d.get("relationships", {}).get("policies", {}).get("data", [])
+                )
+                yield PolicySet.model_validate(attrs)
+
+        return _gen()
 
     def create(self, organization: str, options: PolicySetCreateOptions) -> PolicySet:
         """Create a new policy set in the given organization."""