refactor(state-version-output): Iterator conversion and example added to the state-version-output

Author: isivaselvan

examples/state_versions.py

@@ -80,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}")

src/pytfe/models/__init__.py

@@ -299,7 +299,6 @@
 )
 from .state_version_output import (
     StateVersionOutput,
-    StateVersionOutputsList,
     StateVersionOutputsListOptions,
 )
 from .team import (
@@ -670,7 +669,6 @@
     "StateVersionReadOptions",
     # State Version Outputs
     "StateVersionOutput",
-    "StateVersionOutputsList",
     "StateVersionOutputsListOptions",
 ]
 

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/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"),
-        )

src/pytfe/resources/state_versions.py

@@ -16,7 +16,6 @@
 )
 from ..models.state_version_output import (
     StateVersionOutput,
-    StateVersionOutputsList,
     StateVersionOutputsListOptions,
 )
 from ..utils import looks_like_workspace_id, valid_string_id
@@ -254,40 +253,24 @@ def list_outputs(
         self,
         state_version_id: str,
         options: StateVersionOutputsListOptions | None = None,
-    ) -> StateVersionOutputsList:
+    ) -> Iterator[StateVersionOutput]:
         """List outputs for a given state version (paged)."""
         if not valid_string_id(state_version_id):
             raise ValueError("invalid state version id")
 
         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
 
-        r = self.t.request(
-            "GET", f"/api/v2/state-versions/{state_version_id}/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()},
-                )
-            )
+        path = f"/api/v2/state-versions/{state_version_id}/outputs"
 
-        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"),
-        )
+        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()},
+            )
 
     # ----------------------------
     # TFE-only backing data actions

tests/units/test_state_version.py

@@ -287,31 +287,29 @@ def test_download_state_version_success(
         )
         assert result == b"{}"
 
-    def test_list_outputs_success(self, state_versions_service, mock_transport):
-        """Test successful list_outputs() operation."""
-        mock_response = Mock()
-        mock_response.json.return_value = {
-            "data": [
-                {
-                    "id": "wsout-1",
-                    "attributes": {
-                        "name": "vpc_id",
-                        "sensitive": False,
-                        "type": "string",
-                        "value": "vpc-123",
-                    },
-                }
-            ],
-        }
-        mock_transport.request.return_value = mock_response
+    def test_list_outputs_success(self, state_versions_service):
+        """Test successful list_outputs() iterator operation."""
+        mock_items = [
+            {
+                "id": "wsout-1",
+                "attributes": {
+                    "name": "vpc_id",
+                    "sensitive": False,
+                    "type": "string",
+                    "value": "vpc-123",
+                },
+            }
+        ]
+
+        with patch.object(state_versions_service, "_list") as mock_list:
+            mock_list.return_value = mock_items
 
-        options = StateVersionOutputsListOptions(page_number=1, page_size=5)
-        result = state_versions_service.list_outputs("sv-outputs-1", options)
+            options = StateVersionOutputsListOptions(page_size=5)
+            result = list(state_versions_service.list_outputs("sv-outputs-1", options))
 
-        mock_transport.request.assert_called_once_with(
-            "GET",
-            "/api/v2/state-versions/sv-outputs-1/outputs",
-            params={"page[number]": 1, "page[size]": 5},
-        )
-        assert len(result.items) == 1
-        assert result.items[0].id == "wsout-1"
+            mock_list.assert_called_once_with(
+                "/api/v2/state-versions/sv-outputs-1/outputs",
+                params={"page[size]": 5},
+            )
+            assert len(result) == 1
+            assert result[0].id == "wsout-1"