feat: renamed ClientEntityBase to BaseResourceClient

Author: jooola

hcloud/core/__init__.py

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

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 BaseResourceClient:
     _client: Client
 
     max_per_page: int = 50
@@ -50,6 +51,24 @@ def _get_first_by(self, **kwargs):  # type: ignore[no-untyped-def]
         return entities[0] if entities else None
 
 
+class ClientEntityBase(BaseResourceClient):
+    """
+    Kept for backward compatibility.
+
+    .. deprecated:: 2.6.0
+        Use :class:``hcloud.core.client.BaseResourceClient`` instead.
+    """
+
+    def __init__(self, client: Client):
+        warnings.warn(
+            "The 'hcloud.core.client.ClientEntityBase' class is deprecated, please use the "
+            "'hcloud.core.client.BaseResourceClient' class instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        super().__init__(client)
+
+
 class BoundModelBase:
     """Bound Model Base"""
 

tests/unit/core/test_client.py

@@ -6,7 +6,7 @@
 import pytest
 
 from hcloud.actions import ActionsPageResult
-from hcloud.core import BaseDomain, BoundModelBase, ClientEntityBase, Meta
+from hcloud.core import BaseDomain, BaseResourceClient, BoundModelBase, Meta
 
 
 class TestBoundModelBase:
@@ -99,15 +99,15 @@ def test_equality(self, bound_model_class, client):
         assert bound_model_a != bound_model_b.data_model
 
 
-class TestClientEntityBase:
+class TestBaseResourceClient:
     @pytest.fixture()
     def client_class_constructor(self):
         def constructor(json_content_function):
             class CandiesPageResult(NamedTuple):
                 candies: list[Any]
                 meta: Meta
 
-            class CandiesClient(ClientEntityBase):
+            class CandiesClient(BaseResourceClient):
                 def get_list(self, status=None, page=None, per_page=None):
                     json_content = json_content_function(page)
                     results = [
@@ -122,7 +122,7 @@ def get_list(self, status=None, page=None, per_page=None):
     @pytest.fixture()
     def client_class_with_actions_constructor(self):
         def constructor(json_content_function):
-            class CandiesClient(ClientEntityBase):
+            class CandiesClient(BaseResourceClient):
                 def get_actions_list(self, status, page=None, per_page=None):
                     json_content = json_content_function(page)
                     results = [