1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
import collections.abc as c
import typing as t
from ansible.module_utils._internal import _datatag
if t.TYPE_CHECKING:
from ansible.inventory.manager import InventoryManager
from ansible.parsing.dataloader import DataLoader
from ansible._internal._templating._jinja_common import Marker
from ansible.vars.manager import VariableManager
__all__ = ['HostVars', 'HostVarsVars']
class HostVars(c.Mapping):
"""A read-only wrapper to enable on-demand templating of a specific host's variables under that host's variable context."""
def __init__(self, inventory: InventoryManager, variable_manager: VariableManager, loader: DataLoader) -> None:
self._inventory = inventory
self._loader = loader
self._variable_manager = variable_manager
variable_manager._hostvars = self
def raw_get(self, host_name: str) -> dict[str, t.Any] | Marker:
"""
Similar to __getitem__, however the returned data is not run through
the templating engine to expand variables in the hostvars.
"""
# does not use inventory.hosts, so it can create localhost on demand
host = self._inventory.get_host(host_name)
if host is None:
from ansible._internal._templating import _jinja_bits
return _jinja_bits._undef(f"hostvars[{host_name!r}]")
return self._variable_manager.get_vars(host=host, include_hostvars=False)
def __getitem__(self, key: str) -> HostVarsVars | Marker:
data = self.raw_get(key)
from ansible._internal._templating import _jinja_bits
if isinstance(data, _jinja_bits.Marker):
return data
return HostVarsVars(data, loader=self._loader, host=key)
def __contains__(self, item: object) -> bool:
# does not use inventory.hosts, so it can create localhost on demand
return self._inventory.get_host(item) is not None
def __iter__(self) -> t.Iterator[str]:
yield from self._inventory.hosts
def __len__(self) -> int:
return len(self._inventory.hosts)
def __deepcopy__(self, memo: t.Any) -> HostVars:
# this object may be stored in a var dict that is itself deep copied, but since the underlying data
# is supposed to be immutable, we don't need to actually copy the data
return self
class HostVarsVars(c.Mapping):
"""A read-only view of a specific host's vars that will template on access under that host's variable context."""
def __init__(self, variables: dict[str, t.Any], loader: DataLoader | None, host: str) -> None:
from ansible._internal._templating import _engine
self._vars = variables
self._templar = _engine.TemplateEngine(variables=variables, loader=loader)
self._host = host
def __getitem__(self, key: str) -> t.Any:
return self._templar.template(self._vars[key])
def __contains__(self, item: object) -> bool:
return item in self._vars
def __iter__(self) -> t.Iterator[str]:
yield from self._vars
def __len__(self) -> int:
return len(self._vars)
def __repr__(self) -> str:
return f'HostVarsVars({self._host=!r}, ...)'
def __deepcopy__(self, memo: t.Any) -> HostVarsVars:
# this may be stored in a var dict that is itself deep copied, but since the underlying data
# is supposed to be immutable, we don't need to actually copy the data
return self
# DTFIX-FUTURE: is there a better way to add this to the ignorable types in the module_utils code
_datatag._untaggable_types.update({HostVars, HostVarsVars})
|
