refactor(reserved tag key): Iterator pattern conversion, read method removed and service class renamed

Author: isivaselvan

examples/reserved_tag_key.py

@@ -53,9 +53,7 @@ def main():
     try:
         # 1. List existing reserved tag keys
         print("\n1. Listing reserved tag keys...")
-        reserved_tag_keys = client.reserved_tag_key.list(TFE_ORG)
-        print(f"✅ Found {len(reserved_tag_keys.items)} reserved tag keys:")
-        for rtk in reserved_tag_keys.items:
+        for rtk in client.reserved_tag_key.list(TFE_ORG):
             print(
                 f"  - ID: {rtk.id}, Key: {rtk.key}, Disable Overrides: {rtk.disable_overrides}"
             )
@@ -87,18 +85,16 @@ def main():
 
         # 5. Verify deletion by listing again
         print("\n5. Verifying deletion...")
-        reserved_tag_keys_after = client.reserved_tag_key.list(TFE_ORG)
-        print(
-            f"✅ Reserved tag keys after deletion: {len(reserved_tag_keys_after.items)}"
-        )
+        reserved_tag_keys_after = list(client.reserved_tag_key.list(TFE_ORG))
+        print(f"Reserved tag keys after deletion: {len(reserved_tag_keys_after)}")
 
         # 6. Demonstrate pagination with options
         print("\n6. Demonstrating pagination options...")
-        list_options = ReservedTagKeyListOptions(page_size=5, page_number=1)
-        paginated_rtks = client.reserved_tag_key.list(TFE_ORG, list_options)
-        print(f"✅ Page 1 with page size 5: {len(paginated_rtks.items)} keys")
-        print(f"   Total pages: {paginated_rtks.total_pages}")
-        print(f"   Total count: {paginated_rtks.total_count}")
+        list_options = ReservedTagKeyListOptions(page_size=5)
+        for rtk in client.reserved_tag_key.list(TFE_ORG, list_options):
+            print(
+                f"  - ID: {rtk.id}, Key: {rtk.key}, Disable Overrides: {rtk.disable_overrides}"
+            )
 
         print("\n🎉 Reserved Tag Keys API example completed successfully!")
 

src/pytfe/client.py

@@ -21,7 +21,7 @@
 from .resources.query_run import QueryRuns
 from .resources.registry_module import RegistryModules
 from .resources.registry_provider import RegistryProviders
-from .resources.reserved_tag_key import ReservedTagKey
+from .resources.reserved_tag_key import ReservedTagKeys
 from .resources.run import Runs
 from .resources.run_event import RunEvents
 from .resources.run_task import RunTasks
@@ -91,7 +91,7 @@ def __init__(self, config: TFEConfig | None = None):
         self.ssh_keys = SSHKeys(self._transport)
 
         # Reserved Tag Key
-        self.reserved_tag_key = ReservedTagKey(self._transport)
+        self.reserved_tag_key = ReservedTagKeys(self._transport)
 
     def close(self) -> None:
         try:

src/pytfe/models/__init__.py

@@ -206,7 +206,6 @@
 from .reserved_tag_key import (
     ReservedTagKey,
     ReservedTagKeyCreateOptions,
-    ReservedTagKeyList,
     ReservedTagKeyListOptions,
     ReservedTagKeyUpdateOptions,
 )
@@ -358,7 +357,6 @@
     # Reserved tag keys
     "ReservedTagKey",
     "ReservedTagKeyCreateOptions",
-    "ReservedTagKeyList",
     "ReservedTagKeyListOptions",
     "ReservedTagKeyUpdateOptions",
     # Agent & pools

src/pytfe/models/reserved_tag_key.py

@@ -65,24 +65,6 @@ class ReservedTagKeyListOptions(BaseModel):
 
     model_config = ConfigDict(populate_by_name=True)
 
-    page_number: int | None = Field(
-        None, alias="page[number]", description="Page number to retrieve", ge=1
-    )
     page_size: int | None = Field(
         None, alias="page[size]", description="Number of items per page", ge=1, le=100
     )
-
-
-class ReservedTagKeyList(BaseModel):
-    """Represents a paginated list of reserved tag keys."""
-
-    model_config = ConfigDict(populate_by_name=True)
-
-    items: list[ReservedTagKey] = Field(
-        default_factory=list, description="List of reserved tag keys"
-    )
-    current_page: int | None = Field(None, description="Current page number")
-    total_pages: int | None = Field(None, description="Total number of pages")
-    prev_page: str | None = Field(None, description="URL of the previous page")
-    next_page: str | None = Field(None, description="URL of the next page")
-    total_count: int | None = Field(None, description="Total number of items")

src/pytfe/resources/reserved_tag_key.py

@@ -1,64 +1,42 @@
 from __future__ import annotations
 
+from collections.abc import Iterator
 from typing import Any
 
 from ..errors import (
     InvalidOrgError,
     ValidationError,
 )
 from ..models.reserved_tag_key import (
-    ReservedTagKey as ReservedTagKeyModel,
-)
-from ..models.reserved_tag_key import (
+    ReservedTagKey,
     ReservedTagKeyCreateOptions,
-    ReservedTagKeyList,
     ReservedTagKeyListOptions,
     ReservedTagKeyUpdateOptions,
 )
 from ..utils import valid_string_id
 from ._base import _Service
 
 
-class ReservedTagKey(_Service):
+class ReservedTagKeys(_Service):
     """Reserved Tag Key API for Terraform Enterprise."""
 
     def list(
         self, organization: str, options: ReservedTagKeyListOptions | None = None
-    ) -> ReservedTagKeyList:
+    ) -> Iterator[ReservedTagKey]:
         """List reserved tag keys for the given organization."""
         if not valid_string_id(organization):
             raise InvalidOrgError()
 
         params = (
             options.model_dump(by_alias=True, exclude_none=True) if options else None
         )
-
-        r = self.t.request(
-            "GET",
-            f"/api/v2/organizations/{organization}/reserved-tag-keys",
-            params=params,
-        )
-
-        jd = r.json()
-        items = []
-        meta = jd.get("meta", {})
-        pagination = meta.get("pagination", {})
-
-        for d in jd.get("data", []):
-            items.append(self._parse_reserved_tag_key(d))
-
-        return ReservedTagKeyList(
-            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/organizations/{organization}/reserved-tag-keys"
+        for item in self._list(path, params=params):
+            yield self._parse_reserved_tag_key(item)
 
     def create(
         self, organization: str, options: ReservedTagKeyCreateOptions
-    ) -> ReservedTagKeyModel:
+    ) -> ReservedTagKey:
         """Create a new reserved tag key for the given organization."""
         if not valid_string_id(organization):
             raise InvalidOrgError()
@@ -82,20 +60,9 @@ def create(
 
         return self._parse_reserved_tag_key(data)
 
-    def read(self, reserved_tag_key_id: str) -> ReservedTagKeyModel:
-        """Read a reserved tag key by its ID."""
-        if not valid_string_id(reserved_tag_key_id):
-            raise ValidationError("Invalid reserved tag key ID")
-
-        # Note: Based on the API docs, there's no explicit GET endpoint for individual reserved tag keys
-        # This method would need to be implemented if such an endpoint exists
-        raise NotImplementedError(
-            "Individual reserved tag key read is not supported by the API"
-        )
-
     def update(
         self, reserved_tag_key_id: str, options: ReservedTagKeyUpdateOptions
-    ) -> ReservedTagKeyModel:
+    ) -> ReservedTagKey:
         """Update a reserved tag key."""
         if not valid_string_id(reserved_tag_key_id):
             raise ValidationError("Invalid reserved tag key ID")
@@ -125,10 +92,10 @@ def delete(self, reserved_tag_key_id: str) -> None:
             raise ValidationError("Invalid reserved tag key ID")
 
         self.t.request("DELETE", f"/api/v2/reserved-tag-keys/{reserved_tag_key_id}")
-        # DELETE returns 204 No Content on success
+        return None
 
-    def _parse_reserved_tag_key(self, data: dict[str, Any]) -> ReservedTagKeyModel:
+    def _parse_reserved_tag_key(self, data: dict[str, Any]) -> ReservedTagKey:
         """Parse reserved tag key data from API response."""
         attrs = data.get("attributes", {})
         attrs["id"] = data.get("id")
-        return ReservedTagKeyModel.model_validate(attrs)
+        return ReservedTagKey.model_validate(attrs)

tests/units/test_reserved_tag_key.py

@@ -14,7 +14,7 @@
     ReservedTagKeyListOptions,
     ReservedTagKeyUpdateOptions,
 )
-from pytfe.resources.reserved_tag_key import ReservedTagKey
+from pytfe.resources.reserved_tag_key import ReservedTagKeys
 
 
 class TestReservedTagKeyParsing:
@@ -24,7 +24,7 @@ class TestReservedTagKeyParsing:
     def reserved_tag_key_service(self):
         """Create a ReservedTagKey service for testing parsing."""
         mock_transport = Mock(spec=HTTPTransport)
-        return ReservedTagKey(mock_transport)
+        return ReservedTagKeys(mock_transport)
 
     def test_parse_reserved_tag_key_minimal(self, reserved_tag_key_service):
         """Test _parse_reserved_tag_key with minimal data."""
@@ -68,12 +68,12 @@ class TestReservedTagKey:
     def reserved_tag_key_service(self):
         """Create a ReservedTagKey service for testing."""
         mock_transport = Mock(spec=HTTPTransport)
-        return ReservedTagKey(mock_transport)
+        return ReservedTagKeys(mock_transport)
 
     def test_list_reserved_tag_keys_invalid_org(self, reserved_tag_key_service):
         """Test listing reserved tag keys with invalid organization."""
         with pytest.raises(InvalidOrgError):
-            reserved_tag_key_service.list("")
+            list(reserved_tag_key_service.list(""))
 
     def test_create_reserved_tag_key_invalid_org(self, reserved_tag_key_service):
         """Test creating reserved tag key with invalid organization."""
@@ -83,11 +83,6 @@ def test_create_reserved_tag_key_invalid_org(self, reserved_tag_key_service):
         with pytest.raises(InvalidOrgError):
             reserved_tag_key_service.create("", options)
 
-    def test_read_reserved_tag_key_not_implemented(self, reserved_tag_key_service):
-        """Test reading reserved tag key raises NotImplementedError."""
-        with pytest.raises(NotImplementedError):
-            reserved_tag_key_service.read("rtk-123")
-
     def test_update_reserved_tag_key_invalid_id(self, reserved_tag_key_service):
         """Test updating reserved tag key with invalid ID."""
         options = ReservedTagKeyUpdateOptions(key="updated-key")
@@ -115,6 +110,5 @@ def test_reserved_tag_key_update_options_model(self):
 
     def test_reserved_tag_key_list_options_model(self):
         """Test ReservedTagKeyListOptions model validation."""
-        options = ReservedTagKeyListOptions(page_number=2, page_size=50)
-        assert options.page_number == 2
+        options = ReservedTagKeyListOptions(page_size=50)
         assert options.page_size == 50