ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-03-27 23:47:36 +00:00
Code Activity

[PR #11283/ef632145 backport][stable-12] Add more module_utils typing (#11289)

Browse source 
Add more module_utils typing (#11283)

Add more module_utils typing.

(cherry picked from commit ef632145e9)

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot] 2025-12-17 21:24:55 +01:00 • committed by GitHub
parent 8590184232
commit 21aa086ca6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 340 additions and 274 deletions
Download patch file Download diff file Expand all files Collapse all files

20
plugins/module_utils/source_control/bitbucket.py
View file

@ -5,20 +5,24 @@
from __future__ import annotations
import json
import typing as t
from ansible.module_utils.basic import env_fallback
from ansible.module_utils.urls import fetch_url, basic_auth_header
if t.TYPE_CHECKING:
from ansible.module_utils.basic import AnsibleModule
class BitbucketHelper:
BITBUCKET_API_URL = "https://api.bitbucket.org"
def __init__(self, module):
def __init__(self, module: AnsibleModule) -> None:
self.module = module
self.access_token = None
self.access_token: str | None = None
@staticmethod
def bitbucket_argument_spec():
def bitbucket_argument_spec() -> dict[str, t.Any]:
return dict(
client_id=dict(type="str", fallback=(env_fallback, ["BITBUCKET_CLIENT_ID"])),
client_secret=dict(type="str", no_log=True, fallback=(env_fallback, ["BITBUCKET_CLIENT_SECRET"])),
@ -30,14 +34,14 @@ class BitbucketHelper:
)
@staticmethod
def bitbucket_required_one_of():
def bitbucket_required_one_of() -> list[list[str]]:
return [["client_id", "client_secret", "user", "password"]]
@staticmethod
def bitbucket_required_together():
def bitbucket_required_together() -> list[list[str]]:
return [["client_id", "client_secret"], ["user", "password"]]
def fetch_access_token(self):
def fetch_access_token(self) -> None:
if self.module.params["client_id"] and self.module.params["client_secret"]:
headers = {
"Authorization": basic_auth_header(
@ -57,7 +61,9 @@ class BitbucketHelper:
else:
self.module.fail_json(msg=f"Failed to retrieve access token: {info}")
def request(self, api_url, method, data=None, headers=None):
def request(
self, api_url: str, method: str, data: bytes | str | dict | None = None, headers: dict[str, str] | None = None
):
headers = headers or {}
if self.access_token: