Skip to content

Commit 8491fea

Browse files
authored
fix: typo in LoadBalancerHealthCheckHttp class name (hetznercloud#511)
Rename the class to fix the typo, and keep an alias for backward compatibility.
1 parent 47134e1 commit 8491fea

File tree

4 files changed

+35
-7
lines changed

4 files changed

+35
-7
lines changed

docs/api.clients.load_balancers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ LoadBalancerClient
2020
.. autoclass:: hcloud.load_balancers.domain.LoadBalancerHealthCheck
2121
:members:
2222

23-
.. autoclass:: hcloud.load_balancers.domain.LoadBalancerHealtCheckHttp
23+
.. autoclass:: hcloud.load_balancers.domain.LoadBalancerHealthCheckHttp
2424
:members:
2525

2626
.. autoclass:: hcloud.load_balancers.domain.LoadBalancerTarget

hcloud/load_balancers/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
LoadBalancerAlgorithm,
1515
LoadBalancerHealtCheckHttp,
1616
LoadBalancerHealthCheck,
17+
LoadBalancerHealthCheckHttp,
1718
LoadBalancerService,
1819
LoadBalancerServiceHttp,
1920
LoadBalancerTarget,
@@ -33,6 +34,7 @@
3334
"LoadBalancer",
3435
"LoadBalancerAlgorithm",
3536
"LoadBalancerHealtCheckHttp",
37+
"LoadBalancerHealthCheckHttp",
3638
"LoadBalancerHealthCheck",
3739
"LoadBalancerService",
3840
"LoadBalancerServiceHttp",

hcloud/load_balancers/client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
IPv6Network,
2121
LoadBalancer,
2222
LoadBalancerAlgorithm,
23-
LoadBalancerHealtCheckHttp,
2423
LoadBalancerHealthCheck,
24+
LoadBalancerHealthCheckHttp,
2525
LoadBalancerService,
2626
LoadBalancerServiceHttp,
2727
LoadBalancerTarget,
@@ -139,7 +139,7 @@ def __init__(self, client: LoadBalancersClient, data: dict, complete: bool = Tru
139139
timeout=service["health_check"]["timeout"],
140140
)
141141
if tmp_service.health_check.protocol != "tcp":
142-
tmp_service.health_check.http = LoadBalancerHealtCheckHttp(
142+
tmp_service.health_check.http = LoadBalancerHealthCheckHttp(
143143
domain=service["health_check"]["http"]["domain"],
144144
path=service["health_check"]["http"]["path"],
145145
response=service["health_check"]["http"]["response"],

hcloud/load_balancers/domain.py

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
from __future__ import annotations
22

3+
import warnings
34
from typing import TYPE_CHECKING, Any, Literal
45

56
from dateutil.parser import isoparse
@@ -256,7 +257,7 @@ class LoadBalancerHealthCheck(BaseDomain):
256257
Timeout in sec after a try is assumed as timeout
257258
:param retries: int
258259
Retries we perform until we assume a target as unhealthy
259-
:param http: LoadBalancerHealtCheckHttp
260+
:param http: LoadBalancerHealthCheckHttp
260261
HTTP Config
261262
"""
262263

@@ -267,7 +268,7 @@ def __init__(
267268
interval: int | None = None,
268269
timeout: int | None = None,
269270
retries: int | None = None,
270-
http: LoadBalancerHealtCheckHttp | None = None,
271+
http: LoadBalancerHealthCheckHttp | None = None,
271272
):
272273
self.protocol = protocol
273274
self.port = port
@@ -277,8 +278,8 @@ def __init__(
277278
self.http = http
278279

279280

280-
class LoadBalancerHealtCheckHttp(BaseDomain):
281-
"""LoadBalancerHealtCheckHttp Domain
281+
class LoadBalancerHealthCheckHttp(BaseDomain):
282+
"""LoadBalancerHealthCheckHttp Domain
282283
283284
:param domain: str
284285
Domain name to send in HTTP request. Can be null: In that case we will not send a domain name
@@ -307,6 +308,31 @@ def __init__(
307308
self.tls = tls
308309

309310

311+
class LoadBalancerHealtCheckHttp(LoadBalancerHealthCheckHttp):
312+
"""
313+
Kept for backward compatibility.
314+
315+
.. deprecated:: 2.5.4
316+
Use :class:``hcloud.load_balancers.domain.LoadBalancerHealthCheckHttp`` instead.
317+
"""
318+
319+
def __init__(
320+
self,
321+
domain: str | None = None,
322+
path: str | None = None,
323+
response: str | None = None,
324+
status_codes: list | None = None,
325+
tls: bool | None = None,
326+
):
327+
warnings.warn(
328+
"The 'hcloud.load_balancers.domain.LoadBalancerHealtCheckHttp' class is deprecated, please use the "
329+
"'hcloud.load_balancers.domain.LoadBalancerHealthCheckHttp' class instead.",
330+
DeprecationWarning,
331+
stacklevel=2,
332+
)
333+
super().__init__(domain, path, response, status_codes, tls)
334+
335+
310336
class LoadBalancerTarget(BaseDomain):
311337
"""LoadBalancerTarget Domain
312338

0 commit comments

Comments
 (0)