fix: rename ClientEntityBase to ResourceClientBase (#532)

This rename will reduce confusion in the future when reading the code.
The `ClientEntity` name does not refer to anything.

This is scoped as a fix because the class is public.

Author: jooola

hcloud/actions/client.py

@@ -4,7 +4,7 @@
 import warnings
 from typing import TYPE_CHECKING, Any, NamedTuple
 
-from ..core import BoundModelBase, ClientEntityBase, Meta
+from ..core import BoundModelBase, Meta, ResourceClientBase
 from .domain import Action, ActionFailedException, ActionTimeoutException
 
 if TYPE_CHECKING:
@@ -50,7 +50,7 @@ class ActionsPageResult(NamedTuple):
     meta: Meta
 
 
-class ResourceActionsClient(ClientEntityBase):
+class ResourceActionsClient(ResourceClientBase):
     _resource: str
 
     def __init__(self, client: Client, resource: str | None):

hcloud/certificates/client.py

@@ -3,7 +3,7 @@
 from typing import TYPE_CHECKING, Any, NamedTuple
 
 from ..actions import ActionsPageResult, BoundAction, ResourceActionsClient
-from ..core import BoundModelBase, ClientEntityBase, Meta
+from ..core import BoundModelBase, Meta, ResourceClientBase
 from .domain import (
     Certificate,
     CreateManagedCertificateResponse,
@@ -103,7 +103,7 @@ class CertificatesPageResult(NamedTuple):
     meta: Meta
 
 
-class CertificatesClient(ClientEntityBase):
+class CertificatesClient(ResourceClientBase):
     _client: Client
 
     actions: ResourceActionsClient

hcloud/core/__init__.py

@@ -1,13 +1,14 @@
 from __future__ import annotations
 
-from .client import BoundModelBase, ClientEntityBase
+from .client import BoundModelBase, ClientEntityBase, ResourceClientBase
 from .domain import BaseDomain, DomainIdentityMixin, Meta, Pagination
 
 __all__ = [
+    "BaseDomain",
     "BoundModelBase",
     "ClientEntityBase",
-    "BaseDomain",
     "DomainIdentityMixin",
     "Meta",
     "Pagination",
+    "ResourceClientBase",
 ]

hcloud/core/client.py

@@ -1,12 +1,13 @@
 from __future__ import annotations
 
+import warnings
 from typing import TYPE_CHECKING, Any, Callable
 
 if TYPE_CHECKING:
     from .._client import Client
 
 
-class ClientEntityBase:
+class ResourceClientBase:
     _client: Client
 
     max_per_page: int = 50
@@ -50,14 +51,32 @@ def _get_first_by(self, **kwargs):  # type: ignore[no-untyped-def]
         return entities[0] if entities else None
 
 
+class ClientEntityBase(ResourceClientBase):
+    """
+    Kept for backward compatibility.
+
+    .. deprecated:: 2.6.0
+        Use :class:``hcloud.core.client.ResourceClientBase`` instead.
+    """
+
+    def __init__(self, client: Client):
+        warnings.warn(
+            "The 'hcloud.core.client.ClientEntityBase' class is deprecated, please use the "
+            "'hcloud.core.client.ResourceClientBase' class instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        super().__init__(client)
+
+
 class BoundModelBase:
     """Bound Model Base"""
 
     model: Any
 
     def __init__(
         self,
-        client: ClientEntityBase,
+        client: ResourceClientBase,
         data: dict,
         complete: bool = True,
     ):

hcloud/datacenters/client.py

@@ -2,7 +2,7 @@
 
 from typing import TYPE_CHECKING, Any, NamedTuple
 
-from ..core import BoundModelBase, ClientEntityBase, Meta
+from ..core import BoundModelBase, Meta, ResourceClientBase
 from ..locations import BoundLocation
 from ..server_types import BoundServerType
 from .domain import Datacenter, DatacenterServerTypes
@@ -55,7 +55,7 @@ class DatacentersPageResult(NamedTuple):
     meta: Meta
 
 
-class DatacentersClient(ClientEntityBase):
+class DatacentersClient(ResourceClientBase):
     _client: Client
 
     def get_by_id(self, id: int) -> BoundDatacenter:

hcloud/firewalls/client.py

@@ -3,7 +3,7 @@
 from typing import TYPE_CHECKING, Any, NamedTuple
 
 from ..actions import ActionsPageResult, BoundAction, ResourceActionsClient
-from ..core import BoundModelBase, ClientEntityBase, Meta
+from ..core import BoundModelBase, Meta, ResourceClientBase
 from .domain import (
     CreateFirewallResponse,
     Firewall,
@@ -183,7 +183,7 @@ class FirewallsPageResult(NamedTuple):
     meta: Meta
 
 
-class FirewallsClient(ClientEntityBase):
+class FirewallsClient(ResourceClientBase):
     _client: Client
 
     actions: ResourceActionsClient

hcloud/floating_ips/client.py

@@ -3,7 +3,7 @@
 from typing import TYPE_CHECKING, Any, NamedTuple
 
 from ..actions import ActionsPageResult, BoundAction, ResourceActionsClient
-from ..core import BoundModelBase, ClientEntityBase, Meta
+from ..core import BoundModelBase, Meta, ResourceClientBase
 from ..locations import BoundLocation
 from .domain import CreateFloatingIPResponse, FloatingIP
 
@@ -139,7 +139,7 @@ class FloatingIPsPageResult(NamedTuple):
     meta: Meta
 
 
-class FloatingIPsClient(ClientEntityBase):
+class FloatingIPsClient(ResourceClientBase):
     _client: Client
 
     actions: ResourceActionsClient

hcloud/images/client.py

@@ -4,7 +4,7 @@
 from typing import TYPE_CHECKING, Any, NamedTuple
 
 from ..actions import ActionsPageResult, BoundAction, ResourceActionsClient
-from ..core import BoundModelBase, ClientEntityBase, Meta
+from ..core import BoundModelBase, Meta, ResourceClientBase
 from .domain import Image
 
 if TYPE_CHECKING:
@@ -112,7 +112,7 @@ class ImagesPageResult(NamedTuple):
     meta: Meta
 
 
-class ImagesClient(ClientEntityBase):
+class ImagesClient(ResourceClientBase):
     _client: Client
 
     actions: ResourceActionsClient

hcloud/isos/client.py

@@ -2,7 +2,7 @@
 
 from typing import TYPE_CHECKING, Any, NamedTuple
 
-from ..core import BoundModelBase, ClientEntityBase, Meta
+from ..core import BoundModelBase, Meta, ResourceClientBase
 from .domain import Iso
 
 if TYPE_CHECKING:
@@ -20,7 +20,7 @@ class IsosPageResult(NamedTuple):
     meta: Meta
 
 
-class IsosClient(ClientEntityBase):
+class IsosClient(ResourceClientBase):
     _client: Client
 
     def get_by_id(self, id: int) -> BoundIso:

hcloud/load_balancer_types/client.py

@@ -2,7 +2,7 @@
 
 from typing import TYPE_CHECKING, Any, NamedTuple
 
-from ..core import BoundModelBase, ClientEntityBase, Meta
+from ..core import BoundModelBase, Meta, ResourceClientBase
 from .domain import LoadBalancerType
 
 if TYPE_CHECKING:
@@ -20,7 +20,7 @@ class LoadBalancerTypesPageResult(NamedTuple):
     meta: Meta
 
 
-class LoadBalancerTypesClient(ClientEntityBase):
+class LoadBalancerTypesClient(ResourceClientBase):
     _client: Client
 
     def get_by_id(self, id: int) -> BoundLoadBalancerType: