Merge pull request #113 from hashicorp/refactor/Iterator-pattern-conversion

Refactor/iterator pattern conversion

Author: isivaselvan

examples/policy_check.py

@@ -35,7 +35,6 @@ def main():
         action="store_true",
         help="Get logs for the specified policy check",
     )
-    parser.add_argument("--page", type=int, default=1)
     parser.add_argument("--page-size", type=int, default=20)
     args = parser.parse_args()
 
@@ -50,21 +49,19 @@ def main():
     _print_header(f"Listing policy checks for run: {args.run_id}")
 
     options = PolicyCheckListOptions(
-        page_number=args.page,
         page_size=args.page_size,
     )
 
     try:
-        pc_list = client.policy_checks.list(args.run_id, options)
+        pc_list = list(client.policy_checks.list(args.run_id, options))
 
-        print(f"Total policy checks: {pc_list.total_count}")
-        print(f"Page {pc_list.current_page} of {pc_list.total_pages}")
+        print(f"Total policy checks fetched: {len(pc_list)}")
         print()
 
-        if not pc_list.items:
+        if not pc_list:
             print("No policy checks found for this run.")
         else:
-            for pc in pc_list.items:
+            for pc in pc_list:
                 print(f"- ID: {pc.id}")
                 print(f"Status: {pc.status}")
                 print(f"Scope: {pc.scope}")

examples/state_versions.py

@@ -33,27 +33,23 @@ def main():
     parser.add_argument("--workspace-id", required=True, help="Workspace ID")
     parser.add_argument("--download", help="Path to save downloaded current state")
     parser.add_argument("--upload", help="Path to a .tfstate (or JSON state) to upload")
-    parser.add_argument("--page", type=int, default=1)
     parser.add_argument("--page-size", type=int, default=10)
     args = parser.parse_args()
 
     cfg = TFEConfig(address=args.address, token=args.token)
     client = TFEClient(cfg)
 
     options = StateVersionListOptions(
-        page_number=args.page,
         page_size=args.page_size,
         organization=args.org,
         workspace=args.workspace,
     )
 
-    sv_list = client.state_versions.list(options)
-
-    print(f"Total state versions: {sv_list.total_count}")
-    print(f"Page {sv_list.current_page} of {sv_list.total_pages}")
+    sv_list = list(client.state_versions.list(options))
+    print(f"Total state versions: {len(sv_list)}")
     print()
 
-    for sv in sv_list.items:
+    for sv in sv_list:
         print(f"- {sv.id} | status={sv.status} | created_at={sv.created_at}")
 
     # 1) List all state versions across org and workspace filters
@@ -63,7 +59,7 @@ def main():
             organization=args.org, workspace=args.workspace, page_size=args.page_size
         )
     )
-    for sv in all_sv.items:
+    for sv in all_sv:
         print(f"- {sv.id} | status={sv.status} | created_at={sv.created_at}")
 
     # 2) Read the current state version (with outputs included if you want)
@@ -84,15 +80,30 @@ def main():
 
     # 4) List outputs for the current state version (paged)
     _print_header("Listing outputs (current state version)")
-    outs = client.state_versions.list_outputs(
-        current.id, options=StateVersionOutputsListOptions(page_size=50)
+    outs = list(
+        client.state_versions.list_outputs(
+            current.id, options=StateVersionOutputsListOptions(page_size=50)
+        )
     )
-    if not outs.items:
+    if not outs:
         print("No outputs found.")
-    for o in outs.items:
+    for o in outs:
         # Sensitive outputs will have value = None
         print(f"- {o.name}: sensitive={o.sensitive} type={o.type} value={o.value}")
 
+    if args.workspace_id:
+        # 4b) List outputs for the current state version via workspace endpoint
+        _print_header("Listing outputs via workspace endpoint")
+        outs2 = list(
+            client.state_version_outputs.read_current(
+                args.workspace_id, options=StateVersionOutputsListOptions(page_size=50)
+            )
+        )
+        if not outs2:
+            print("No outputs found.")
+        for o in outs2:
+            print(f"- {o.name}: sensitive={o.sensitive} type={o.type} value={o.value}")
+
     # 5) (Optional) Upload a new state file
     if args.upload:
         _print_header(f"Uploading new state from: {args.upload}")

examples/variable_sets.py

@@ -64,7 +64,7 @@ def variable_set_example():
         list_options = VariableSetListOptions(
             page_size=10, include=[VariableSetIncludeOpt.WORKSPACES]
         )
-        variable_sets = client.variable_sets.list(org_name, list_options)
+        variable_sets = list(client.variable_sets.list(org_name, list_options))
         print(f"Found {len(variable_sets)} existing variable sets")
 
         for vs in variable_sets[:3]:  # Show first 3
@@ -92,6 +92,15 @@ def variable_set_example():
         print(f"Priority: {new_variable_set.priority}")
         print()
 
+        print("Listing existing variable sets...")
+        list_options = VariableSetListOptions(page_size=10)
+        variable_sets = list(client.variable_sets.list(org_name, list_options))
+        print(f"Found {len(variable_sets)} existing variable sets")
+
+        for vs in variable_sets:  # Show first 3
+            print(f"- {vs.name} (ID: {vs.id}, Global: {vs.global_})")
+        print()
+
         # 3. Create variables in the variable set
         print("3. Creating variables in the variable set...")
 
@@ -147,12 +156,16 @@ def variable_set_example():
         # 4. List variables in the variable set
         print("4. Listing variables in the variable set...")
         var_list_options = VariableSetVariableListOptions(page_size=50)
-        variables = client.variable_set_variables.list(
-            created_variable_set_id, var_list_options
+        variables = list(
+            client.variable_set_variables.list(
+                created_variable_set_id, var_list_options
+            )
         )
         print(f"Found {len(variables)} variables in the set:")
 
-        for var in variables:
+        for var in client.variable_set_variables.list(
+            created_variable_set_id, var_list_options
+        ):
             sensitive_note = " (sensitive)" if var.sensitive else ""
             hcl_note = " (HCL)" if var.hcl else ""
             print(f"- {var.key}: {var.category.value}{sensitive_note}{hcl_note}")
@@ -212,10 +225,14 @@ def variable_set_example():
                 print("Successfully applied to workspace")
 
                 # List variable sets for this workspace
-                workspace_varsets = client.variable_sets.list_for_workspace(
+                print(f"Listing variable sets for workspace: {first_workspace.name}")
+                workspace_varsets = 0
+                for ws_varset in client.variable_sets.list_for_workspace(
                     first_workspace.id
-                )
-                print(f"Workspace now has {len(workspace_varsets)} variable sets")
+                ):
+                    print(f"- {ws_varset.name} (ID: {ws_varset.id})")
+                    workspace_varsets += 1
+                print(f"Workspace now has {workspace_varsets} variable sets")
 
                 # Remove from workspace
                 remove_ws_options = VariableSetRemoveFromWorkspacesOptions(
@@ -250,10 +267,14 @@ def variable_set_example():
                 print("Successfully applied to project")
 
                 # List variable sets for this project
-                project_varsets = client.variable_sets.list_for_project(
+                print(f"Listing variable sets for project: {first_project.name}")
+                project_varsets = 0
+                for proj_varset in client.variable_sets.list_for_project(
                     first_project.id
-                )
-                print(f"Project now has {len(project_varsets)} variable sets")
+                ):
+                    print(f"- {proj_varset.name} (ID: {proj_varset.id})")
+                    project_varsets += 1
+                print(f"Project now has {project_varsets} variable sets")
 
                 # Remove from project
                 remove_proj_options = VariableSetRemoveFromProjectsOptions(

src/pytfe/models/__init__.py

@@ -106,7 +106,6 @@
     PolicyActions,
     PolicyCheck,
     PolicyCheckIncludeOpt,
-    PolicyCheckList,
     PolicyCheckListOptions,
     PolicyPermissions,
     PolicyResult,
@@ -605,7 +604,6 @@
     "PolicyResult",
     "PolicyStatusTimestamps",
     "PolicyCheckListOptions",
-    "PolicyCheckList",
     # Policy Evaluation
     "PolicyAttachable",
     "PolicyEvaluation",
@@ -672,4 +670,3 @@
 
 # Rebuild models with forward references after all models are loaded
 PolicyCheck.model_rebuild()
-PolicyCheckList.model_rebuild()

src/pytfe/models/policy_check.py

@@ -106,7 +106,6 @@ class PolicyCheckListOptions(BaseModel):
     model_config = ConfigDict(populate_by_name=True, validate_by_name=True)
 
     include: list[PolicyCheckIncludeOpt] | None = Field(None, alias="include")
-    page_number: int | None = Field(None, alias="page[number]")
     page_size: int | None = Field(None, alias="page[size]")
 
 

src/pytfe/models/state_version.py

@@ -78,7 +78,6 @@ class StateVersionListOptions(BaseModel):
     model_config = ConfigDict(populate_by_name=True, validate_by_name=True)
 
     # Standard pagination + filters
-    page_number: int | None = Field(None, alias="page[number]")
     page_size: int | None = Field(None, alias="page[size]")
     organization: str | None = Field(None, alias="filter[organization][name]")
     workspace: str | None = Field(None, alias="filter[workspace][name]")

src/pytfe/models/state_version_output.py

@@ -19,7 +19,6 @@ class StateVersionOutput(BaseModel):
 class StateVersionOutputsListOptions(BaseModel):
     model_config = ConfigDict(populate_by_name=True, validate_by_name=True)
 
-    page_number: int | None = Field(None, alias="page[number]")
     page_size: int | None = Field(None, alias="page[size]")
 
 

src/pytfe/models/variable_set.py

@@ -69,7 +69,6 @@ class VariableSetListOptions(BaseModel):
     """Options for listing variable sets."""
 
     # Pagination options
-    page_number: int | None = None
     page_size: int | None = None
     include: list[VariableSetIncludeOpt] | None = None
     query: str | None = None  # Filter by name

src/pytfe/resources/policy_check.py

@@ -1,14 +1,14 @@
 from __future__ import annotations
 
 import time
+from collections.abc import Iterator
 
 from ..errors import (
     InvalidPolicyCheckIDError,
     InvalidRunIDError,
 )
 from ..models.policy_check import (
     PolicyCheck,
-    PolicyCheckList,
     PolicyCheckListOptions,
     PolicyStatus,
 )
@@ -24,35 +24,19 @@ class PolicyChecks(_Service):
 
     def list(
         self, run_id: str, options: PolicyCheckListOptions | None = None
-    ) -> PolicyCheckList:
+    ) -> Iterator[PolicyCheck]:
         """List all policy checks of the given run."""
         if not valid_string_id(run_id):
             raise InvalidRunIDError()
         params = (
             options.model_dump(by_alias=True, exclude_none=True) if options else None
         )
-        r = self.t.request(
-            "GET",
-            f"/api/v2/runs/{run_id}/policy-checks",
-            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["run"] = d.get("relationships", {}).get("run", {})
-            items.append(PolicyCheck.model_validate(attrs))
-        return PolicyCheckList(
-            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"),
-        )
+        path = f"/api/v2/runs/{run_id}/policy-checks"
+        for item in self._list(path, params=params):
+            attrs = item.get("attributes", {})
+            attrs["id"] = item.get("id")
+            attrs["run"] = item.get("relationships", {}).get("run", {}).get("data")
+            yield PolicyCheck.model_validate(attrs)
 
     def read(self, policy_check_id: str) -> PolicyCheck:
         """Read a policy check by its ID."""
@@ -66,7 +50,7 @@ def read(self, policy_check_id: str) -> PolicyCheck:
         d = jd.get("data", {})
         attrs = d.get("attributes", {})
         attrs["id"] = d.get("id")
-        attrs["run"] = d.get("relationships", {}).get("run", {})
+        attrs["run"] = d.get("relationships", {}).get("run", {}).get("data")
         return PolicyCheck.model_validate(attrs)
 
     def override(self, policy_check_id: str) -> PolicyCheck:
@@ -81,7 +65,7 @@ def override(self, policy_check_id: str) -> PolicyCheck:
         d = jd.get("data", {})
         attrs = d.get("attributes", {})
         attrs["id"] = d.get("id")
-        attrs["run"] = d.get("relationships", {}).get("run", {})
+        attrs["run"] = d.get("relationships", {}).get("run", {}).get("data")
         return PolicyCheck.model_validate(attrs)
 
     def logs(self, policy_check_id: str) -> str:

src/pytfe/resources/state_version_outputs.py

@@ -1,10 +1,10 @@
 from __future__ import annotations
 
+from collections.abc import Iterator
 from typing import Any
 
 from ..models.state_version_output import (
     StateVersionOutput,
-    StateVersionOutputsList,
     StateVersionOutputsListOptions,
 )
 from ..utils import valid_string_id
@@ -42,7 +42,7 @@ def read_current(
         self,
         workspace_id: str,
         options: StateVersionOutputsListOptions | None = None,
-    ) -> StateVersionOutputsList:
+    ) -> Iterator[StateVersionOutput]:
         """
         Read outputs for the workspace's current state version.
         Note: sensitive outputs are returned with null values by the API.
@@ -52,32 +52,13 @@ def read_current(
 
         params: dict[str, Any] = {}
         if options:
-            if options.page_number is not None:
-                params["page[number]"] = options.page_number
             if options.page_size is not None:
                 params["page[size]"] = options.page_size
+        path = f"/api/v2/workspaces/{workspace_id}/current-state-version-outputs"
 
-        r = self.t.request(
-            "GET",
-            f"/api/v2/workspaces/{workspace_id}/current-state-version-outputs",
-            params=params,
-        )
-        data = r.json()
-
-        items: list[StateVersionOutput] = []
-        for item in data.get("data", []):
-            attr = item.get("attributes", {}) or {}
-            items.append(
-                StateVersionOutput(
-                    id=_safe_str(item.get("id")),
-                    **{k.replace("-", "_"): v for k, v in attr.items()},
-                )
+        for d in self._list(path, params=params):
+            attr = d.get("attributes", {}) or {}
+            yield StateVersionOutput(
+                id=_safe_str(d.get("id")),
+                **{k.replace("-", "_"): v for k, v in attr.items()},
             )
-
-        meta = data.get("meta", {}).get("pagination", {}) or {}
-        return StateVersionOutputsList(
-            items=items,
-            current_page=meta.get("current-page"),
-            total_pages=meta.get("total-pages"),
-            total_count=meta.get("total-count"),
-        )