Merge pull request #26 from hetznercloud/get-resource-by-name

Implement get_by_name method for resources

Author: LD250

hcloud/core/client.py

@@ -64,6 +64,20 @@ def get_actions(self, *args, **kwargs):
         return self._get_all(self.get_actions_list, 'actions', *args, **kwargs)
 
 
+class GetEntityByNameMixin(object):
+    """
+    Use as a mixin for ClientEntityBase classes
+    """
+
+    def get_by_name(self, name):
+        # type: (str) -> BoundModelBase
+        self._is_list_attribute_implemented()
+        response = self.get_list(name=name)
+        entities = getattr(response, self.results_list_attribute_name)
+        entity = entities[0] if entities else None
+        return entity
+
+
 class BoundModelBase(object):
     """Bound Model Base"""
     model = None

hcloud/datacenters/client.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-from hcloud.core.client import ClientEntityBase, BoundModelBase
+from hcloud.core.client import ClientEntityBase, BoundModelBase, GetEntityByNameMixin
 
 from hcloud.datacenters.domain import Datacenter, DatacenterServerTypes
 from hcloud.locations.client import BoundLocation
@@ -28,7 +28,7 @@ def __init__(self, client, data):
         super(BoundDatacenter, self).__init__(client, data)
 
 
-class DatacentersClient(ClientEntityBase):
+class DatacentersClient(ClientEntityBase, GetEntityByNameMixin):
     results_list_attribute_name = 'datacenters'
 
     def get_by_id(self, id):
@@ -82,3 +82,13 @@ def get_all(self, name=None):
         :return: List[:class:`BoundDatacenter <hcloud.datacenters.client.BoundDatacenter>`]
         """
         return super(DatacentersClient, self).get_all(name=name)
+
+    def get_by_name(self, name):
+        # type: (str) -> BoundDatacenter
+        """Get datacenter by name
+
+        :param name: str
+               Used to get datacenter by name.
+        :return: :class:`BoundDatacenter <hcloud.datacenters.client.BoundDatacenter>`
+        """
+        return super(DatacentersClient, self).get_by_name(name)

hcloud/images/client.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 from hcloud.actions.client import BoundAction
-from hcloud.core.client import BoundModelBase, ClientEntityBase
+from hcloud.core.client import BoundModelBase, ClientEntityBase, GetEntityByNameMixin
 from hcloud.core.domain import add_meta_to_result
 
 from hcloud.images.domain import Image
@@ -78,7 +78,7 @@ def change_protection(self, delete=None):
         return self._client.change_protection(self, delete)
 
 
-class ImagesClient(ClientEntityBase):
+class ImagesClient(ClientEntityBase, GetEntityByNameMixin):
     results_list_attribute_name = 'images'
 
     def get_actions_list(self,
@@ -207,6 +207,16 @@ def get_all(self,
         """
         return super(ImagesClient, self).get_all(name=name, label_selector=label_selector, bound_to=bound_to, type=type, sort=sort)
 
+    def get_by_name(self, name):
+        # type: (str) -> BoundImage
+        """Get image by name
+
+        :param name: str
+               Used to get image by name.
+        :return: :class:`BoundImage <hcloud.images.client.BoundImage>`
+        """
+        return super(ImagesClient, self).get_by_name(name)
+
     def update(self, image, description=None, type=None, labels=None):
         # type:(Image,  Optional[str], Optional[str],  Optional[Dict[str, str]]) -> BoundImage
         """Updates the Image. You may change the description, convert a Backup image to a Snapshot Image or change the image labels.

hcloud/isos/client.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-from hcloud.core.client import BoundModelBase, ClientEntityBase
+from hcloud.core.client import BoundModelBase, ClientEntityBase, GetEntityByNameMixin
 
 from hcloud.isos.domain import Iso
 
@@ -8,7 +8,7 @@ class BoundIso(BoundModelBase):
     model = Iso
 
 
-class IsosClient(ClientEntityBase):
+class IsosClient(ClientEntityBase, GetEntityByNameMixin):
     results_list_attribute_name = 'isos'
 
     def get_by_id(self, id):
@@ -58,3 +58,13 @@ def get_all(self, name=None):
         :return: List[:class:`BoundIso <hcloud.isos.client.BoundIso>`]
         """
         return super(IsosClient, self).get_all(name=name)
+
+    def get_by_name(self, name):
+        # type: (str) -> BoundIso
+        """Get iso by name
+
+        :param name: str
+               Used to get iso by name.
+        :return: :class:`BoundIso <hcloud.isos.client.BoundIso>`
+        """
+        return super(IsosClient, self).get_by_name(name)

hcloud/locations/client.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-from hcloud.core.client import ClientEntityBase, BoundModelBase
+from hcloud.core.client import ClientEntityBase, BoundModelBase, GetEntityByNameMixin
 
 from hcloud.locations.domain import Location
 
@@ -8,7 +8,7 @@ class BoundLocation(BoundModelBase):
     model = Location
 
 
-class LocationsClient(ClientEntityBase):
+class LocationsClient(ClientEntityBase, GetEntityByNameMixin):
     results_list_attribute_name = 'locations'
 
     def get_by_id(self, id):
@@ -54,3 +54,13 @@ def get_all(self, name=None):
         :return: List[:class:`BoundLocation <hcloud.locations.client.BoundLocation>`]
         """
         return super(LocationsClient, self).get_all(name=name)
+
+    def get_by_name(self, name):
+        # type: (str) -> BoundLocation
+        """Get location by name
+
+        :param name: str
+               Used to get location by name.
+        :return: :class:`BoundLocation <hcloud.locations.client.BoundLocation>`
+        """
+        return super(LocationsClient, self).get_by_name(name)

hcloud/server_types/client.py

@@ -1,12 +1,12 @@
-from hcloud.core.client import ClientEntityBase, BoundModelBase
+from hcloud.core.client import ClientEntityBase, BoundModelBase, GetEntityByNameMixin
 from hcloud.server_types.domain import ServerType
 
 
 class BoundServerType(BoundModelBase):
     model = ServerType
 
 
-class ServerTypesClient(ClientEntityBase):
+class ServerTypesClient(ClientEntityBase, GetEntityByNameMixin):
     results_list_attribute_name = 'server_types'
 
     def get_by_id(self, id):
@@ -52,3 +52,13 @@ def get_all(self, name=None):
         :return: List[:class:`BoundServerType <hcloud.server_types.client.BoundServerType>`]
         """
         return super(ServerTypesClient, self).get_all(name=name)
+
+    def get_by_name(self, name):
+        # type: (str) -> BoundServerType
+        """Get Server type by name
+
+        :param name: str
+               Used to get Server type by name.
+        :return: :class:`BoundServerType <hcloud.server_types.client.BoundServerType>`
+        """
+        return super(ServerTypesClient, self).get_by_name(name)

hcloud/servers/client.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-from hcloud.core.client import ClientEntityBase, BoundModelBase
+from hcloud.core.client import ClientEntityBase, BoundModelBase, GetEntityByNameMixin
 
 from hcloud.actions.client import BoundAction
 from hcloud.core.domain import add_meta_to_result
@@ -270,7 +270,7 @@ def request_console(self):
         return self._client.request_console(self)
 
 
-class ServersClient(ClientEntityBase):
+class ServersClient(ClientEntityBase, GetEntityByNameMixin):
     results_list_attribute_name = 'servers'
 
     def get_by_id(self, id):
@@ -329,6 +329,16 @@ def get_all(self, name=None, label_selector=None):
         """
         return super(ServersClient, self).get_all(name=name, label_selector=label_selector)
 
+    def get_by_name(self, name):
+        # type: (str) -> BoundServer
+        """Get server by name
+
+        :param name: str
+               Used to get server by name.
+        :return: :class:`BoundServer <hcloud.servers.client.BoundServer>`
+        """
+        return super(ServersClient, self).get_by_name(name)
+
     def create(self,
                name,  # type: str
                server_type,  # type: ServerType

hcloud/ssh_keys/client.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-from hcloud.core.client import ClientEntityBase, BoundModelBase
+from hcloud.core.client import ClientEntityBase, BoundModelBase, GetEntityByNameMixin
 
 from hcloud.ssh_keys.domain import SSHKey
 
@@ -27,7 +27,7 @@ def delete(self):
         return self._client.delete(self)
 
 
-class SSHKeysClient(ClientEntityBase):
+class SSHKeysClient(ClientEntityBase, GetEntityByNameMixin):
     results_list_attribute_name = 'ssh_keys'
 
     def get_by_id(self, id):
@@ -93,6 +93,16 @@ def get_all(self, name=None, fingerprint=None, label_selector=None):
         """
         return super(SSHKeysClient, self).get_all(name=name, fingerprint=fingerprint, label_selector=label_selector)
 
+    def get_by_name(self, name):
+        # type: (str) -> SSHKeysClient
+        """Get ssh key by name
+
+        :param name: str
+               Used to get ssh key by name.
+        :return: :class:`BoundSSHKey <hcloud.ssh_keys.client.BoundSSHKey>`
+        """
+        return super(SSHKeysClient, self).get_by_name(name)
+
     def create(self, name, public_key, labels=None):
         # type: (str, str, Optional[Dict[str, str]]) -> BoundSSHKey
         """Creates a new SSH key with the given name and public_key.

hcloud/volumes/client.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-from hcloud.core.client import ClientEntityBase, BoundModelBase
+from hcloud.core.client import ClientEntityBase, BoundModelBase, GetEntityByNameMixin
 
 from hcloud.actions.client import BoundAction
 from hcloud.core.domain import add_meta_to_result
@@ -103,7 +103,7 @@ def change_protection(self, delete=None):
         return self._client.change_protection(self, delete)
 
 
-class VolumesClient(ClientEntityBase):
+class VolumesClient(ClientEntityBase, GetEntityByNameMixin):
     results_list_attribute_name = 'volumes'
 
     def get_by_id(self, id):
@@ -131,6 +131,8 @@ def get_list(self, name=None, label_selector=None, page=None, per_page=None):
         :return: (List[:class:`BoundVolume <hcloud.volumes.client.BoundVolume>`], :class:`Meta <hcloud.core.domain.Meta>`)
         """
         params = {}
+        if name is not None:
+            params['name'] = name
         if label_selector:
             params['label_selector'] = label_selector
         if page is not None:
@@ -151,6 +153,16 @@ def get_all(self, label_selector=None):
         """
         return super(VolumesClient, self).get_all(label_selector=label_selector)
 
+    def get_by_name(self, name):
+        # type: (str) -> BoundVolume
+        """Get volume by name
+
+        :param name: str
+               Used to get volume by name.
+        :return: :class:`BoundVolume <hcloud.volumes.client.BoundVolume>`
+        """
+        return super(VolumesClient, self).get_by_name(name)
+
     def create(self,
                size,  # type: int
                name,  # type: str

tests/integration/datacenters/test_datacenters.py

@@ -5,6 +5,12 @@ def test_get_by_id(self, hetzner_client):
         assert datacenter.name == "fsn1-dc8"
         assert datacenter.description == "Falkenstein 1 DC 8"
 
+    def test_get_by_name(self, hetzner_client):
+        datacenter = hetzner_client.datacenters.get_by_name("fsn1-dc8")
+        assert datacenter.id == 1
+        assert datacenter.name == "fsn1-dc8"
+        assert datacenter.description == "Falkenstein 1 DC 8"
+
     def test_get_list(self, hetzner_client):
         result = hetzner_client.datacenters.get_list()
         datacenters = result.datacenters