Merge pull request #143 from hetznercloud/placement-groups

Placement groups

Author: Adi146

docs/api.clients.placement_groups.rst

@@ -0,0 +1,15 @@
+PlacementGroupsClient
+==================
+
+
+.. autoclass:: hcloud.placement_groups.client.PlacementGroupsClient
+    :members:
+
+.. autoclass:: hcloud.placement_groups.client.BoundPlacementGroup
+    :members:
+
+.. autoclass:: hcloud.placement_groups.domain.PlacementGroup
+    :members:
+
+.. autoclass:: hcloud.placement_groups.domain.CreatePlacementGroupResponse
+    :members:

hcloud/__version__.py

@@ -1 +1 @@
-VERSION = "1.14.1"
+VERSION = "1.15.0"

hcloud/hcloud.py

@@ -18,6 +18,7 @@
 from hcloud.datacenters.client import DatacentersClient
 from hcloud.load_balancers.client import LoadBalancersClient
 from hcloud.load_balancer_types.client import LoadBalancerTypesClient
+from hcloud.placement_groups.client import PlacementGroupsClient
 
 from .__version__ import VERSION
 from .firewalls.client import FirewallsClient
@@ -149,6 +150,12 @@ def __init__(
         :type: :class:`FirewallsClient <hcloud.firewalls.client.FirewallsClient>`
         """
 
+        self.placement_groups = PlacementGroupsClient(self)
+        """PlacementGroupsClient Instance
+
+        :type: :class:`PlacementGroupsClient <hcloud.placement_groups.client.PlacementGroupsClient>`
+        """
+
     def _get_user_agent(self):
         """Get the user agent of the hcloud-python instance with the user application name (if specified)
 

hcloud/placement_groups/__init__.py

@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-

hcloud/placement_groups/client.py

@@ -0,0 +1,198 @@
+# -*- coding: utf-8 -*-
+from hcloud.actions.client import BoundAction
+from hcloud.core.client import BoundModelBase, ClientEntityBase, GetEntityByNameMixin
+
+from hcloud.placement_groups.domain import PlacementGroup, CreatePlacementGroupResponse
+
+
+class BoundPlacementGroup(BoundModelBase):
+    model = PlacementGroup
+
+    def update(self, labels=None, name=None):
+        # type: (Optional[str], Optional[Dict[str, str]], Optional[str]) -> BoundPlacementGroup
+        """Updates the name or labels of a Placement Group
+
+        :param labels: Dict[str, str] (optional)
+               User-defined labels (key-value pairs)
+        :param name: str, (optional)
+               New Name to set
+        :return: :class:`BoundPlacementGroup <hcloud.placement_groups.client.BoundPlacementGroup>`
+        """
+        return self._client.update(self, labels, name)
+
+    def delete(self):
+        # type: () -> bool
+        """Deletes a Placement Group
+
+        :return: boolean
+        """
+        return self._client.delete(self)
+
+
+class PlacementGroupsClient(ClientEntityBase, GetEntityByNameMixin):
+    results_list_attribute_name = "placement_groups"
+
+    def get_by_id(self, id):
+        # type: (int) -> BoundPlacementGroup
+        """Returns a specific Placement Group object
+
+        :param id: int
+        :return: :class:`BoundPlacementGroup <hcloud.placement_groups.client.BoundPlacementGroup>`
+        """
+        response = self._client.request(
+            url="/placement_groups/{placement_group_id}".format(placement_group_id=id),
+            method="GET",
+        )
+        return BoundPlacementGroup(self, response["placement_group"])
+
+    def get_list(
+        self,
+        label_selector=None,  # type: Optional[str]
+        page=None,  # type: Optional[int]
+        per_page=None,  # type: Optional[int]
+        name=None,  # type: Optional[str]
+        sort=None,  # type: Optional[List[str]]
+        type=None,  # type: Optional[str]
+    ):
+        # type: (...) -> PageResults[List[BoundPlacementGroup]]
+        """Get a list of Placement Groups
+
+        :param label_selector: str (optional)
+               Can be used to filter Placement Groups by labels. The response will only contain Placement Groups matching the label selector values.
+        :param page: int (optional)
+               Specifies the page to fetch
+        :param per_page: int (optional)
+               Specifies how many results are returned by page
+        :param name: str (optional)
+               Can be used to filter Placement Groups by their name.
+        :param sort: List[str] (optional)
+               Choices: id name created (You can add one of ":asc", ":desc" to modify sort order. ( ":asc" is default))
+        :return: (List[:class:`BoundPlacementGroup <hcloud.placement_groups.client.BoundPlacementGroup>`], :class:`Meta <hcloud.core.domain.Meta>`)
+        """
+
+        params = {}
+
+        if label_selector is not None:
+            params["label_selector"] = label_selector
+        if page is not None:
+            params["page"] = page
+        if per_page is not None:
+            params["per_page"] = per_page
+        if name is not None:
+            params["name"] = name
+        if sort is not None:
+            params["sort"] = sort
+        if type is not None:
+            params["type"] = type
+        response = self._client.request(
+            url="/placement_groups", method="GET", params=params
+        )
+        placement_groups = [
+            BoundPlacementGroup(self, placement_group_data)
+            for placement_group_data in response["placement_groups"]
+        ]
+
+        return self._add_meta_to_result(placement_groups, response)
+
+    def get_all(self, label_selector=None, name=None, sort=None):
+        # type: (Optional[str], Optional[str],  Optional[List[str]]) -> List[BoundPlacementGroup]
+        """Get all Placement Groups
+
+        :param label_selector: str (optional)
+               Can be used to filter Placement Groups by labels. The response will only contain Placement Groups matching the label selector values.
+        :param name: str (optional)
+               Can be used to filter Placement Groups by their name.
+        :param sort: List[str] (optional)
+               Choices: id name created (You can add one of ":asc", ":desc" to modify sort order. ( ":asc" is default))
+        :return: List[:class:`BoundPlacementGroup <hcloud.placement_groups.client.BoundPlacementGroup>`]
+        """
+        return super(PlacementGroupsClient, self).get_all(
+            label_selector=label_selector, name=name, sort=sort
+        )
+
+    def get_by_name(self, name):
+        # type: (str) -> BoundPlacementGroup
+        """Get Placement Group by name
+
+        :param name: str
+               Used to get Placement Group by name
+        :return: class:`BoundPlacementGroup <hcloud.placement_groups.client.BoundPlacementGroup>`
+        """
+        return super(PlacementGroupsClient, self).get_by_name(name)
+
+    def create(
+        self,
+        name,  # type: str
+        type,  # type: str
+        labels=None,  # type: Optional[Dict[str, str]]
+    ):
+        # type: (...) -> CreatePlacementGroupResponse
+        """Creates a new Placement Group.
+
+        :param name: str
+               Placement Group Name
+        :param type: str
+               Type of the Placement Group
+        :param labels: Dict[str, str] (optional)
+               User-defined labels (key-value pairs)
+
+        :return: :class:`CreatePlacementGroupResponse <hcloud.placement_groups.domain.CreatePlacementGroupResponse>`
+        """
+        data = {"name": name, "type": type}
+        if labels is not None:
+            data["labels"] = labels
+        response = self._client.request(
+            url="/placement_groups", json=data, method="POST"
+        )
+
+        action = None
+        if response.get("action") is not None:
+            action = BoundAction(self._client.action, response["action"])
+
+        result = CreatePlacementGroupResponse(
+            placement_group=BoundPlacementGroup(self, response["placement_group"]),
+            action=action,
+        )
+        return result
+
+    def update(self, placement_group, labels=None, name=None):
+        # type: (PlacementGroup, Optional[Dict[str, str]], Optional[str]) -> BoundPlacementGroup
+        """Updates the description or labels of a Placement Group.
+
+        :param placement_group: :class:`BoundPlacementGroup <hcloud.placement_groups.client.BoundPlacementGroup>` or :class:`PlacementGroup <hcloud.placement_groups.domain.PlacementGroup>`
+        :param labels: Dict[str, str] (optional)
+               User-defined labels (key-value pairs)
+        :param name: str (optional)
+               New name to set
+        :return: :class:`BoundPlacementGroup <hcloud.placement_groups.client.BoundPlacementGroup>`
+        """
+
+        data = {}
+        if labels is not None:
+            data["labels"] = labels
+        if name is not None:
+            data["name"] = name
+
+        response = self._client.request(
+            url="/placement_groups/{placement_group_id}".format(
+                placement_group_id=placement_group.id
+            ),
+            method="PUT",
+            json=data,
+        )
+        return BoundPlacementGroup(self, response["placement_group"])
+
+    def delete(self, placement_group):
+        # type: (PlacementGroup) -> bool
+        """Deletes a Placement Group.
+
+        :param placement_group: :class:`BoundPlacementGroup <hcloud.placement_groups.client.BoundPlacementGroup>` or :class:`PlacementGroup <hcloud.placement_groups.domain.PlacementGroup>`
+        :return: boolean
+        """
+        self._client.request(
+            url="/placement_groups/{placement_group_id}".format(
+                placement_group_id=placement_group.id
+            ),
+            method="DELETE",
+        )
+        return True

hcloud/placement_groups/domain.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+from dateutil.parser import isoparse
+
+from hcloud.core.domain import BaseDomain
+
+
+class PlacementGroup(BaseDomain):
+    """Placement Group Domain
+
+    :param id: int
+           ID of the Placement Group
+    :param name: str
+           Name of the Placement Group
+    :param labels: dict
+           User-defined labels (key-value pairs)
+    :param servers: List[ int ]
+           List of server IDs assigned to the Placement Group
+    :param type: str
+           Type of the Placement Group
+    :param created: datetime
+           Point in time when the image was created
+    """
+
+    __slots__ = ("id", "name", "labels", "servers", "type", "created")
+
+    """Placement Group type spread
+       spreads all servers in the group on different vhosts
+    """
+    TYPE_SPREAD = "spread"
+
+    def __init__(
+        self, id=None, name=None, labels=None, servers=None, type=None, created=None
+    ):
+        self.id = id
+        self.name = name
+        self.labels = labels
+        self.servers = servers
+        self.type = type
+        self.created = isoparse(created) if created else None
+
+
+class CreatePlacementGroupResponse(BaseDomain):
+    """Create Placement Group Response Domain
+
+    :param placement_group: :class:`BoundPlacementGroup <hcloud.placement_groups.client.BoundPlacementGroup>`
+           The Placement Group which was created
+    :param action: :class:`BoundAction <hcloud.actions.client.BoundAction>`
+           The Action which shows the progress of the Placement Group Creation
+    """
+
+    __slots__ = ("placement_group", "action")
+
+    def __init__(
+        self,
+        placement_group,  # type: BoundPlacementGroup
+        action,  # type: BoundAction
+    ):
+        self.placement_group = placement_group
+        self.action = action