1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-02-04 07:51:50 +00:00
community.general/plugins/module_utils/xfconf.py
Felix Fontein c7f6a28d89
Add basic typing for module_utils (#11222)
* Add basic typing for module_utils.

* Apply some suggestions.

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

* 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.

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

* 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 commit 9973af3dbe.

* Add noqa.

---------

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
2025-12-01 20:40:06 +01:00

48 lines
1.6 KiB
Python

# Copyright (c) 2022, 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.module_utils.parsing.convert_bool import boolean
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
@cmd_runner_fmt.unpack_args
def _values_fmt(values, value_types):
result = []
for value, value_type in zip(values, value_types):
if value_type == "bool":
value = "true" if boolean(value) else "false"
result.extend(["--type", f"{value_type}", "--set", f"{value}"])
return result
def xfconf_runner(module: AnsibleModule, **kwargs) -> CmdRunner:
runner = CmdRunner(
module,
command="xfconf-query",
arg_formats=dict(
channel=cmd_runner_fmt.as_opt_val("--channel"),
property=cmd_runner_fmt.as_opt_val("--property"),
force_array=cmd_runner_fmt.as_bool("--force-array"),
reset=cmd_runner_fmt.as_bool("--reset"),
create=cmd_runner_fmt.as_bool("--create"),
list_arg=cmd_runner_fmt.as_bool("--list"),
values_and_types=_values_fmt,
version=cmd_runner_fmt.as_fixed("--version"),
),
**kwargs,
)
return runner
def get_xfconf_version(runner: CmdRunner) -> str:
with runner("version") as ctx:
rc, out, err = ctx.run()
return out.splitlines()[0].split()[1]