Merge branch 'main' into storage-boxes

Author: jooola

.github/workflows/lint.yml

@@ -9,7 +9,7 @@ jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Setup python
         uses: actions/setup-python@v5
@@ -25,7 +25,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Setup python
         uses: actions/setup-python@v5

.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Set up Python
         uses: actions/setup-python@v5
@@ -47,7 +47,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Download packages artifact
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v5
         with:
           name: python-packages
           path: dist/

.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
 
     name: Python ${{ matrix.python-version }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Setup python
         uses: actions/setup-python@v5

.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict

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,14 @@
 from __future__ import annotations
 
+import warnings
 from typing import TYPE_CHECKING, Any, Callable
 
 if TYPE_CHECKING:
     from .._client import Client
+    from .domain import BaseDomain
 
 
-class ClientEntityBase:
+class ResourceClientBase:
     _client: Client
 
     max_per_page: int = 50
@@ -50,14 +52,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
+    model: type[BaseDomain]
 
     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