refactor(state-version): Iterator conversion and unit tests added to the state-version

Author: isivaselvan

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)

src/pytfe/models/__init__.py

@@ -294,7 +294,6 @@
     StateVersion,
     StateVersionCreateOptions,
     StateVersionCurrentOptions,
-    StateVersionList,
     StateVersionListOptions,
     StateVersionReadOptions,
 )
@@ -667,7 +666,6 @@
     "StateVersion",
     "StateVersionCreateOptions",
     "StateVersionCurrentOptions",
-    "StateVersionList",
     "StateVersionListOptions",
     "StateVersionReadOptions",
     # State Version Outputs

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/resources/state_versions.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from collections.abc import Iterator
 from typing import Any
 from urllib.parse import urlencode
 
@@ -10,7 +11,6 @@
     StateVersion,
     StateVersionCreateOptions,
     StateVersionCurrentOptions,
-    StateVersionList,
     StateVersionListOptions,
     StateVersionReadOptions,
 )
@@ -69,28 +69,19 @@ def _encode_query(params: dict[str, Any]) -> str:
             return ""
         return "?" + urlencode(clean, doseq=True)
 
-    def list(self, options: StateVersionListOptions | None = None) -> StateVersionList:
+    def list(
+        self, options: StateVersionListOptions | None = None
+    ) -> Iterator[StateVersion]:
         """
         GET /state-versions
         Accepts filters for organization and workspace and standard pagination.
         """
         params = options.model_dump(by_alias=True, exclude_none=True) if options else {}
         path = f"/api/v2/state-versions{self._encode_query(params)}"
-        r = self.t.request("GET", path)
-        jd = r.json()
-        # Expecting JSON:API list. Normalize to models.
-        items = []
-        meta = jd.get("meta", {})
-        for d in jd.get("data", []):
+        for d in self._list(path, params=params):
             attrs = d.get("attributes", {})
             attrs["id"] = d.get("id")
-            items.append(StateVersion.model_validate(attrs))
-        return StateVersionList(
-            items=items,
-            current_page=meta.get("pagination", {}).get("current-page"),
-            total_pages=meta.get("pagination", {}).get("total-pages"),
-            total_count=meta.get("pagination", {}).get("total-count"),
-        )
+            yield StateVersion.model_validate(attrs)
 
     def read(self, state_version_id: str) -> StateVersion:
         """Read a state version by ID."""