mirror of
https://github.com/ansible-collections/hetzner.hcloud.git
synced 2026-02-04 08:01:49 +00:00
chore(deps): update dependency hcloud to v2 (#523)
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [hcloud](https://togithub.com/hetznercloud/hcloud-python) ([changelog](https://togithub.com/hetznercloud/hcloud-python/blob/main/CHANGELOG.md)) | `1.35.0` -> `2.0.1` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>hetznercloud/hcloud-python (hcloud)</summary> ### [`v2.0.1`](https://togithub.com/hetznercloud/hcloud-python/blob/HEAD/CHANGELOG.md#201-2024-07-03) [Compare Source](https://togithub.com/hetznercloud/hcloud-python/compare/v2.0.0...v2.0.1) ##### Bug Fixes - `assignee_type` is required when creating a primary ip ([#​409](https://togithub.com/hetznercloud/hcloud-python/issues/409)) ([bce5e94](bce5e940e2)) - clean unused arguments in the `Client.servers.rebuild` method ([#​407](https://togithub.com/hetznercloud/hcloud-python/issues/407)) ([6d33c3c](6d33c3cff5)) - details are optional in API errors ([#​411](https://togithub.com/hetznercloud/hcloud-python/issues/411)) ([f1c6594](f1c6594dee)) - rename `trace_id` variable to `correlation_id` ([#​408](https://togithub.com/hetznercloud/hcloud-python/issues/408)) ([66a0f54](66a0f54699)) ### [`v2.0.0`](https://togithub.com/hetznercloud/hcloud-python/blob/HEAD/CHANGELOG.md#200-2024-07-03) [Compare Source](https://togithub.com/hetznercloud/hcloud-python/compare/v1.35.0...v2.0.0) ##### ⚠ BREAKING CHANGES - return full rebuild response in `Client.servers.rebuild` ([#​406](https://togithub.com/hetznercloud/hcloud-python/issues/406)) - make `datacenter` argument optional when creating a primary ip ([#​363](https://togithub.com/hetznercloud/hcloud-python/issues/363)) - remove deprecated `include_wildcard_architecture` argument in `IsosClient.get_list` and `IsosClient.get_all` ([#​402](https://togithub.com/hetznercloud/hcloud-python/issues/402)) - make `Client.request` `tries` a private argument ([#​399](https://togithub.com/hetznercloud/hcloud-python/issues/399)) - make `Client.poll_interval` a private property ([#​398](https://togithub.com/hetznercloud/hcloud-python/issues/398)) - return empty dict on empty responses in `Client.request` ([#​400](https://togithub.com/hetznercloud/hcloud-python/issues/400)) - remove deprecated `hcloud.hcloud` module ([#​401](https://togithub.com/hetznercloud/hcloud-python/issues/401)) - move `hcloud.__version__.VERSION` to `hcloud.__version__` ([#​397](https://togithub.com/hetznercloud/hcloud-python/issues/397)) ##### Features - add `trace_id` to API exceptions ([#​404](https://togithub.com/hetznercloud/hcloud-python/issues/404)) ([8375261](8375261da3)) - allow using a custom poll_interval function ([#​403](https://togithub.com/hetznercloud/hcloud-python/issues/403)) ([93eb56b](93eb56ba4d)) - make `Client.poll_interval` a private property ([#​398](https://togithub.com/hetznercloud/hcloud-python/issues/398)) ([d5f24db](d5f24db281)) - make `Client.request` `tries` a private argument ([#​399](https://togithub.com/hetznercloud/hcloud-python/issues/399)) ([428ea7e](428ea7e3be)) - move `hcloud.__version__.VERSION` to `hcloud.__version__` ([#​397](https://togithub.com/hetznercloud/hcloud-python/issues/397)) ([4e3f638](4e3f638862)), closes [#​234](https://togithub.com/hetznercloud/hcloud-python/issues/234) - remove deprecated `hcloud.hcloud` module ([#​401](https://togithub.com/hetznercloud/hcloud-python/issues/401)) ([db37e63](db37e633eb)) - remove deprecated `include_wildcard_architecture` argument in `IsosClient.get_list` and `IsosClient.get_all` ([#​402](https://togithub.com/hetznercloud/hcloud-python/issues/402)) ([6b977e2](6b977e2da5)) - return empty dict on empty responses in `Client.request` ([#​400](https://togithub.com/hetznercloud/hcloud-python/issues/400)) ([9f46adb](9f46adb946)) - return full rebuild response in `Client.servers.rebuild` ([#​406](https://togithub.com/hetznercloud/hcloud-python/issues/406)) ([1970d84](1970d84bec)) ##### Bug Fixes - make `datacenter` argument optional when creating a primary ip ([#​363](https://togithub.com/hetznercloud/hcloud-python/issues/363)) ([ebef774](ebef77464c)) ##### Dependencies - update dependency coverage to >=7.5,<7.6 ([#​386](https://togithub.com/hetznercloud/hcloud-python/issues/386)) ([5660691](5660691ebd)) - update dependency mypy to >=1.10,<1.11 ([#​387](https://togithub.com/hetznercloud/hcloud-python/issues/387)) ([35c933b](35c933bd21)) - update dependency myst-parser to v3 ([#​385](https://togithub.com/hetznercloud/hcloud-python/issues/385)) ([9f18270](9f18270489)) - update dependency pylint to >=3,<3.3 ([#​391](https://togithub.com/hetznercloud/hcloud-python/issues/391)) ([4a6f005](4a6f005cb0)) - update dependency pytest to >=8,<8.3 ([#​390](https://togithub.com/hetznercloud/hcloud-python/issues/390)) ([584a36b](584a36b658)) - update dependency sphinx to >=7.3.4,<7.4 ([#​383](https://togithub.com/hetznercloud/hcloud-python/issues/383)) ([69c2e16](69c2e16073)) - update pre-commit hook asottile/pyupgrade to v3.16.0 ([0ce5fbc](0ce5fbccba)) - update pre-commit hook pre-commit/pre-commit-hooks to v4.6.0 ([5ef25ab](5ef25ab396)) - update pre-commit hook psf/black-pre-commit-mirror to v24.4.0 ([0941fbf](0941fbfab2)) - update pre-commit hook psf/black-pre-commit-mirror to v24.4.1 ([fec08c5](fec08c5323)) - update pre-commit hook psf/black-pre-commit-mirror to v24.4.2 ([#​389](https://togithub.com/hetznercloud/hcloud-python/issues/389)) ([2b2e21f](2b2e21f613)) - update pre-commit hook pycqa/flake8 to v7.1.0 ([3bc651d](3bc651d50d)) ##### Documentation - add v2 upgrade notes ([#​405](https://togithub.com/hetznercloud/hcloud-python/issues/405)) ([c77f771](c77f771e2b)) - cx11 is name, not an id ([#​381](https://togithub.com/hetznercloud/hcloud-python/issues/381)) ([b745d40](b745d4049f)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/ansible-collections/hetzner.hcloud). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MjEuOSIsInVwZGF0ZWRJblZlciI6IjM3LjQyMS45IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: jo <ljonas@riseup.net>
This commit is contained in:
renovate[bot]
GitHub
parent
f3d697c006
commit
9adb8b3981
23 changed files with 124 additions and 148 deletions
97
plugins/module_utils/vendor/hcloud/_client.py
vendored
97
plugins/module_utils/vendor/hcloud/_client.py
vendored
|
|
@ -1,15 +1,15 @@
|
|||
from __future__ import annotations
|
||||
|
||||
import time
|
||||
from typing import NoReturn
|
||||
from typing import Protocol
|
||||
|
||||
try:
|
||||
import requests
|
||||
except ImportError:
|
||||
requests = None
|
||||
|
||||
from ._version import VERSION
|
||||
from ._exceptions import APIException
|
||||
from ._version import __version__
|
||||
from .actions import ActionsClient
|
||||
from .certificates import CertificatesClient
|
||||
from .datacenters import DatacentersClient
|
||||
|
|
@ -29,10 +29,19 @@ from .ssh_keys import SSHKeysClient
|
|||
from .volumes import VolumesClient
|
||||
|
||||
|
||||
class PollIntervalFunction(Protocol):
|
||||
def __call__(self, retries: int) -> float:
|
||||
"""
|
||||
Return a interval in seconds to wait between each API call.
|
||||
|
||||
:param retries: Number of calls already made.
|
||||
"""
|
||||
|
||||
|
||||
class Client:
|
||||
"""Base Client for accessing the Hetzner Cloud API"""
|
||||
|
||||
_version = VERSION
|
||||
_version = __version__
|
||||
_retry_wait_time = 0.5
|
||||
__user_agent_prefix = "hcloud-python"
|
||||
|
||||
|
|
@ -42,7 +51,8 @@ class Client:
|
|||
api_endpoint: str = "https://api.hetzner.cloud/v1",
|
||||
application_name: str | None = None,
|
||||
application_version: str | None = None,
|
||||
poll_interval: int = 1,
|
||||
poll_interval: int | float | PollIntervalFunction = 1.0,
|
||||
poll_max_retries: int = 120,
|
||||
timeout: float | tuple[float, float] | None = None,
|
||||
):
|
||||
"""Create a new Client instance
|
||||
|
|
@ -51,7 +61,11 @@ class Client:
|
|||
:param api_endpoint: Hetzner Cloud API endpoint
|
||||
:param application_name: Your application name
|
||||
:param application_version: Your application _version
|
||||
:param poll_interval: Interval for polling information from Hetzner Cloud API in seconds
|
||||
:param poll_interval:
|
||||
Interval in seconds to use when polling actions from the API.
|
||||
You may pass a function to compute a custom poll interval.
|
||||
:param poll_max_retries:
|
||||
Max retries before timeout when polling actions from the API.
|
||||
:param timeout: Requests timeout in seconds
|
||||
"""
|
||||
self.token = token
|
||||
|
|
@ -60,7 +74,12 @@ class Client:
|
|||
self._application_version = application_version
|
||||
self._requests_session = requests.Session()
|
||||
self._requests_timeout = timeout
|
||||
self.poll_interval = poll_interval
|
||||
|
||||
if isinstance(poll_interval, (int, float)):
|
||||
self._poll_interval_func = lambda _: poll_interval # Constant poll interval
|
||||
else:
|
||||
self._poll_interval_func = poll_interval
|
||||
self._poll_max_retries = poll_max_retries
|
||||
|
||||
self.datacenters = DatacentersClient(self)
|
||||
"""DatacentersClient Instance
|
||||
|
|
@ -174,32 +193,18 @@ class Client:
|
|||
}
|
||||
return headers
|
||||
|
||||
def _raise_exception_from_response(self, response) -> NoReturn:
|
||||
raise APIException(
|
||||
code=response.status_code,
|
||||
message=response.reason,
|
||||
details={"content": response.content},
|
||||
)
|
||||
|
||||
def _raise_exception_from_content(self, content: dict) -> NoReturn:
|
||||
raise APIException(
|
||||
code=content["error"]["code"],
|
||||
message=content["error"]["message"],
|
||||
details=content["error"]["details"],
|
||||
)
|
||||
|
||||
def request( # type: ignore[no-untyped-def]
|
||||
self,
|
||||
method: str,
|
||||
url: str,
|
||||
tries: int = 1,
|
||||
*,
|
||||
_tries: int = 1,
|
||||
**kwargs,
|
||||
) -> dict:
|
||||
"""Perform a request to the Hetzner Cloud API, wrapper around requests.request
|
||||
|
||||
:param method: HTTP Method to perform the Request
|
||||
:param url: URL of the Endpoint
|
||||
:param tries: Tries of the request (used internally, should not be set by the user)
|
||||
:param timeout: Requests timeout in seconds
|
||||
:return: Response
|
||||
"""
|
||||
|
|
@ -213,24 +218,40 @@ class Client:
|
|||
**kwargs,
|
||||
)
|
||||
|
||||
content = response.content
|
||||
correlation_id = response.headers.get("X-Correlation-Id")
|
||||
payload = {}
|
||||
try:
|
||||
if len(content) > 0:
|
||||
content = response.json()
|
||||
except (TypeError, ValueError):
|
||||
self._raise_exception_from_response(response)
|
||||
if len(response.content) > 0:
|
||||
payload = response.json()
|
||||
except (TypeError, ValueError) as exc:
|
||||
raise APIException(
|
||||
code=response.status_code,
|
||||
message=response.reason,
|
||||
details={"content": response.content},
|
||||
correlation_id=correlation_id,
|
||||
) from exc
|
||||
|
||||
if not response.ok:
|
||||
if content:
|
||||
assert isinstance(content, dict)
|
||||
if content["error"]["code"] == "rate_limit_exceeded" and tries < 5:
|
||||
time.sleep(tries * self._retry_wait_time)
|
||||
tries = tries + 1
|
||||
return self.request(method, url, tries, **kwargs)
|
||||
if not payload or "error" not in payload:
|
||||
raise APIException(
|
||||
code=response.status_code,
|
||||
message=response.reason,
|
||||
details={"content": response.content},
|
||||
correlation_id=correlation_id,
|
||||
)
|
||||
|
||||
self._raise_exception_from_content(content)
|
||||
else:
|
||||
self._raise_exception_from_response(response)
|
||||
error: dict = payload["error"]
|
||||
|
||||
# TODO: return an empty dict instead of an empty string when content == "".
|
||||
return content # type: ignore[return-value]
|
||||
if error["code"] == "rate_limit_exceeded" and _tries < 5:
|
||||
time.sleep(_tries * self._retry_wait_time)
|
||||
_tries = _tries + 1
|
||||
return self.request(method, url, _tries=_tries, **kwargs)
|
||||
|
||||
raise APIException(
|
||||
code=error["code"],
|
||||
message=error["message"],
|
||||
details=error.get("details"),
|
||||
correlation_id=correlation_id,
|
||||
)
|
||||
|
||||
return payload
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue