mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-02-04 07:51:50 +00:00
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>
58 lines
1.8 KiB
Python
58 lines
1.8 KiB
Python
# Copyright (c) 2023, Alexei Znamensky <russoz@gmail.com>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import annotations
|
|
|
|
import typing as t
|
|
|
|
from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
|
|
|
|
if t.TYPE_CHECKING:
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
|
|
_alias_state_map = dict(
|
|
present="alias",
|
|
absent="unalias",
|
|
info="aliases",
|
|
)
|
|
|
|
_state_map = dict(
|
|
present="install",
|
|
absent="remove",
|
|
enabled="enable",
|
|
disabled="disable",
|
|
refresh="refresh",
|
|
)
|
|
|
|
|
|
def snap_runner(module: AnsibleModule, **kwargs) -> CmdRunner:
|
|
runner = CmdRunner(
|
|
module,
|
|
"snap",
|
|
arg_formats=dict(
|
|
state_alias=cmd_runner_fmt.as_map(_alias_state_map), # snap_alias only
|
|
name=cmd_runner_fmt.as_list(),
|
|
alias=cmd_runner_fmt.as_list(), # snap_alias only
|
|
state=cmd_runner_fmt.as_map(_state_map),
|
|
_list=cmd_runner_fmt.as_fixed("list"),
|
|
_set=cmd_runner_fmt.as_fixed("set"),
|
|
get=cmd_runner_fmt.as_fixed(["get", "-d"]),
|
|
classic=cmd_runner_fmt.as_bool("--classic"),
|
|
channel=cmd_runner_fmt.as_func(lambda v: [] if v == "stable" else ["--channel", f"{v}"]),
|
|
options=cmd_runner_fmt.as_list(),
|
|
info=cmd_runner_fmt.as_fixed("info"),
|
|
dangerous=cmd_runner_fmt.as_bool("--dangerous"),
|
|
version=cmd_runner_fmt.as_fixed("version"),
|
|
),
|
|
check_rc=False,
|
|
**kwargs,
|
|
)
|
|
return runner
|
|
|
|
|
|
def get_version(runner: CmdRunner) -> dict[str, list[str]]:
|
|
with runner("version") as ctx:
|
|
rc, out, err = ctx.run()
|
|
return dict(x.split() for x in out.splitlines() if len(x.split()) == 2)
|