Merge branch 'dev' into optional-nodepools

Author: rammanoj

docs/linode_api4/linode_client.rst

@@ -125,6 +125,15 @@ Includes methods for interacting with our Longview service.
    :members:
    :special-members:
 
+LockGroup
+^^^^^^^^^^^^^
+
+Includes methods for interacting with our Lock service.
+
+.. autoclass:: linode_api4.linode_client.LockGroup
+   :members:
+   :special-members:
+
 NetworkingGroup
 ^^^^^^^^^^^^^^^
 

linode_api4/groups/__init__.py

@@ -9,6 +9,7 @@
 from .linode import *
 from .lke import *
 from .lke_tier import *
+from .lock import *
 from .longview import *
 from .maintenance import *
 from .monitor import *

linode_api4/groups/lock.py

@@ -0,0 +1,72 @@
+from typing import Union
+
+from linode_api4.errors import UnexpectedResponseError
+from linode_api4.groups import Group
+from linode_api4.objects import Lock, LockType
+
+__all__ = ["LockGroup"]
+
+
+class LockGroup(Group):
+    """
+    Encapsulates methods for interacting with Resource Locks.
+
+    Resource locks prevent deletion or modification of resources.
+    Currently, only Linode instances can be locked.
+    """
+
+    def __call__(self, *filters):
+        """
+        Returns a list of all Resource Locks on the account.
+
+        This is intended to be called off of the :any:`LinodeClient`
+        class, like this::
+
+           locks = client.locks()
+
+        API Documentation: TBD
+
+        :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
+
+        :returns: A list of Resource Locks on the account.
+        :rtype: PaginatedList of Lock
+        """
+        return self.client._get_and_filter(Lock, *filters)
+
+    def create(
+        self,
+        entity_type: str,
+        entity_id: Union[int, str],
+        lock_type: Union[LockType, str],
+    ) -> Lock:
+        """
+        Creates a new Resource Lock for the specified entity.
+
+        API Documentation: TBD
+
+        :param entity_type: The type of entity to lock (e.g., "linode").
+        :type entity_type: str
+        :param entity_id: The ID of the entity to lock.
+        :type entity_id: int | str
+        :param lock_type: The type of lock to create. Defaults to "cannot_delete".
+        :type lock_type: LockType | str
+
+        :returns: The newly created Resource Lock.
+        :rtype: Lock
+        """
+        params = {
+            "entity_type": entity_type,
+            "entity_id": entity_id,
+            "lock_type": lock_type,
+        }
+
+        result = self.client.post("/locks", data=params)
+
+        if "id" not in result:
+            raise UnexpectedResponseError(
+                "Unexpected response when creating lock!", json=result
+            )
+
+        return Lock(self.client, result["id"], result)

linode_api4/linode_client.py

@@ -18,6 +18,7 @@
     ImageGroup,
     LinodeGroup,
     LKEGroup,
+    LockGroup,
     LongviewGroup,
     MaintenanceGroup,
     MetricsGroup,
@@ -454,6 +455,9 @@ def __init__(
 
         self.monitor = MonitorGroup(self)
 
+        #: Access methods related to Resource Locks - See :any:`LockGroup` for more information.
+        self.locks = LockGroup(self)
+
         super().__init__(
             token=token,
             base_url=base_url,

linode_api4/objects/__init__.py

@@ -24,3 +24,4 @@
 from .placement import *
 from .monitor import *
 from .monitor_api import *
+from .lock import *

linode_api4/objects/linode.py

@@ -803,6 +803,7 @@ class Instance(Base):
         "maintenance_policy": Property(
             mutable=True
         ),  # Note: This field is only available when using v4beta.
+        "locks": Property(unordered=True),
     }
 
     @property

linode_api4/objects/lock.py

@@ -0,0 +1,47 @@
+from dataclasses import dataclass
+
+from linode_api4.objects.base import Base, Property
+from linode_api4.objects.serializable import JSONObject, StrEnum
+
+__all__ = ["LockType", "LockEntity", "Lock"]
+
+
+class LockType(StrEnum):
+    """
+    LockType defines valid values for resource lock types.
+
+    API Documentation: https://techdocs.akamai.com/linode-api/reference/post-lock
+    """
+
+    cannot_delete = "cannot_delete"
+    cannot_delete_with_subresources = "cannot_delete_with_subresources"
+
+
+@dataclass
+class LockEntity(JSONObject):
+    """
+    Represents the entity that is locked.
+
+    API Documentation: https://techdocs.akamai.com/linode-api/reference/get-lock
+    """
+
+    id: int = 0
+    type: str = ""
+    label: str = ""
+    url: str = ""
+
+
+class Lock(Base):
+    """
+    A resource lock that prevents deletion or modification of a resource.
+
+    API Documentation: https://techdocs.akamai.com/linode-api/reference/get-lock
+    """
+
+    api_endpoint = "/locks/{id}"
+
+    properties = {
+        "id": Property(identifier=True),
+        "lock_type": Property(),
+        "entity": Property(json_object=LockEntity),
+    }

test/fixtures/locks.json

@@ -0,0 +1,27 @@
+{
+  "data": [
+    {
+      "id": 1,
+      "lock_type": "cannot_delete",
+      "entity": {
+        "id": 123,
+        "type": "linode",
+        "label": "test-linode",
+        "url": "/v4/linode/instances/123"
+      }
+    },
+    {
+      "id": 2,
+      "lock_type": "cannot_delete_with_subresources",
+      "entity": {
+        "id": 456,
+        "type": "linode",
+        "label": "another-linode",
+        "url": "/v4/linode/instances/456"
+      }
+    }
+  ],
+  "page": 1,
+  "pages": 1,
+  "results": 2
+}

test/fixtures/locks_1.json

@@ -0,0 +1,10 @@
+{
+  "id": 1,
+  "lock_type": "cannot_delete",
+  "entity": {
+    "id": 123,
+    "type": "linode",
+    "label": "test-linode",
+    "url": "/v4/linode/instances/123"
+  }
+}

test/integration/models/lock/__init__.py

@@ -0,0 +1 @@
+# This file is intentionally left empty to make the directory a Python package.