fix: rename BoundModelBase to BaseBoundModel

Author: jooola

hcloud/core/__init__.py

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

hcloud/core/client.py

@@ -5,6 +5,7 @@
 
 if TYPE_CHECKING:
     from .._client import Client
+    from .domain import BaseDomain
 
 
 class BaseResourceClient:
@@ -69,10 +70,10 @@ def __init__(self, client: Client):
         super().__init__(client)
 
 
-class BoundModelBase:
-    """Bound Model Base"""
+class BaseBoundModel:
+    """Base Bound Model"""
 
-    model: Any
+    model: type[BaseDomain]
 
     def __init__(
         self,
@@ -121,3 +122,26 @@ def __eq__(self, other: Any) -> bool:
         if not isinstance(other, self.__class__):
             return NotImplemented
         return self.data_model == other.data_model
+
+
+class BoundModelBase(BaseBoundModel):
+    """
+    Kept for backward compatibility.
+
+    .. deprecated:: 2.6.0
+        Use :class:``hcloud.core.client.BaseBoundModel`` instead.
+    """
+
+    def __init__(
+        self,
+        client: BaseResourceClient,
+        data: dict,
+        complete: bool = True,
+    ):
+        warnings.warn(
+            "The 'hcloud.core.client.BoundModelBase' class is deprecated, please use the "
+            "'hcloud.core.client.BaseBoundModel' class instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        super().__init__(client, data, complete)

tests/unit/core/test_client.py

@@ -6,10 +6,10 @@
 import pytest
 
 from hcloud.actions import ActionsPageResult
-from hcloud.core import BaseDomain, BaseResourceClient, BoundModelBase, Meta
+from hcloud.core import BaseBoundModel, BaseDomain, BaseResourceClient, Meta
 
 
-class TestBoundModelBase:
+class TestBaseBoundModel:
     @pytest.fixture()
     def bound_model_class(self):
         class Model(BaseDomain):
@@ -21,7 +21,7 @@ def __init__(self, id, name="", description=""):
                 self.name = name
                 self.description = description
 
-        class BoundModel(BoundModelBase, Model):
+        class BoundModel(BaseBoundModel, Model):
             model = Model
 
         return BoundModel