mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-02-04 16:01:55 +00:00
377a599372
Add basic typing for module_utils (#11222) * Add basic typing for module_utils. * Apply some suggestions. * Make pass again. * Add more types as suggested. * Normalize extra imports. * Add more type hints. * Improve typing. * Add changelog fragment. * Reduce changelog. * Apply suggestions from code review. * Fix typo. * Cleanup. * Improve types and make type checking happy. * Let's see whether older Pythons barf on this. * Revert "Let's see whether older Pythons barf on this." This reverts commit9973af3dbe. * Add noqa. --------- (cherry picked from commitc7f6a28d89) Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
47 lines
1.3 KiB
Python
47 lines
1.3 KiB
Python
# Copyright (c) 2018, Ansible Project
|
|
# Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
|
|
# SPDX-License-Identifier: BSD-2-Clause
|
|
|
|
from __future__ import annotations
|
|
|
|
import traceback
|
|
import typing as t
|
|
|
|
from ansible.module_utils.basic import env_fallback, missing_required_lib
|
|
|
|
if t.TYPE_CHECKING:
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
HAS_HEROKU = False
|
|
HEROKU_IMP_ERR = None
|
|
try:
|
|
import heroku3
|
|
|
|
HAS_HEROKU = True
|
|
except ImportError:
|
|
HEROKU_IMP_ERR = traceback.format_exc()
|
|
|
|
|
|
class HerokuHelper:
|
|
def __init__(self, module: AnsibleModule) -> None:
|
|
self.module = module
|
|
self.check_lib()
|
|
self.api_key = module.params["api_key"]
|
|
|
|
def check_lib(self) -> None:
|
|
if not HAS_HEROKU:
|
|
self.module.fail_json(msg=missing_required_lib("heroku3"), exception=HEROKU_IMP_ERR)
|
|
|
|
@staticmethod
|
|
def heroku_argument_spec() -> dict[str, t.Any]:
|
|
return dict(
|
|
api_key=dict(fallback=(env_fallback, ["HEROKU_API_KEY", "TF_VAR_HEROKU_API_KEY"]), type="str", no_log=True)
|
|
)
|
|
|
|
def get_heroku_client(self):
|
|
client = heroku3.from_key(self.api_key)
|
|
|
|
if not client.is_authenticated:
|
|
self.module.fail_json(msg="Heroku authentication failure, please check your API Key")
|
|
|
|
return client
|