diff options
Diffstat (limited to 'lib/ansible/vars/hostvars.py')
-rw-r--r-- | lib/ansible/vars/hostvars.py | 155 |
1 files changed, 155 insertions, 0 deletions
diff --git a/lib/ansible/vars/hostvars.py b/lib/ansible/vars/hostvars.py new file mode 100644 index 0000000..e6679ef --- /dev/null +++ b/lib/ansible/vars/hostvars.py @@ -0,0 +1,155 @@ +# (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/>. + +# Make coding more python3-ish +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +from collections.abc import Mapping + +from ansible.template import Templar, AnsibleUndefined + +STATIC_VARS = [ + 'ansible_version', + 'ansible_play_hosts', + 'ansible_dependent_role_names', + 'ansible_play_role_names', + 'ansible_role_names', + 'inventory_hostname', + 'inventory_hostname_short', + 'inventory_file', + 'inventory_dir', + 'groups', + 'group_names', + 'omit', + 'playbook_dir', + 'play_hosts', + 'role_names', + 'ungrouped', +] + +__all__ = ['HostVars', 'HostVarsVars'] + + +# Note -- this is a Mapping, not a MutableMapping +class HostVars(Mapping): + ''' A special view of vars_cache that adds values from the inventory when needed. ''' + + def __init__(self, inventory, variable_manager, loader): + self._inventory = inventory + self._loader = loader + self._variable_manager = variable_manager + variable_manager._hostvars = self + + def set_variable_manager(self, variable_manager): + self._variable_manager = variable_manager + variable_manager._hostvars = self + + def set_inventory(self, inventory): + self._inventory = inventory + + def _find_host(self, host_name): + # does not use inventory.hosts so it can create localhost on demand + return self._inventory.get_host(host_name) + + def raw_get(self, host_name): + ''' + Similar to __getitem__, however the returned data is not run through + the templating engine to expand variables in the hostvars. + ''' + host = self._find_host(host_name) + if host is None: + return AnsibleUndefined(name="hostvars['%s']" % host_name) + + return self._variable_manager.get_vars(host=host, include_hostvars=False) + + def __setstate__(self, state): + self.__dict__.update(state) + + # Methods __getstate__ and __setstate__ of VariableManager do not + # preserve _loader and _hostvars attributes to improve pickle + # performance and memory utilization. Since HostVars holds values + # of those attributes already, assign them if needed. + if self._variable_manager._loader is None: + self._variable_manager._loader = self._loader + + if self._variable_manager._hostvars is None: + self._variable_manager._hostvars = self + + def __getitem__(self, host_name): + data = self.raw_get(host_name) + if isinstance(data, AnsibleUndefined): + return data + return HostVarsVars(data, loader=self._loader) + + def set_host_variable(self, host, varname, value): + self._variable_manager.set_host_variable(host, varname, value) + + def set_nonpersistent_facts(self, host, facts): + self._variable_manager.set_nonpersistent_facts(host, facts) + + def set_host_facts(self, host, facts): + self._variable_manager.set_host_facts(host, facts) + + def __contains__(self, host_name): + # does not use inventory.hosts so it can create localhost on demand + return self._find_host(host_name) is not None + + def __iter__(self): + for host in self._inventory.hosts: + yield host + + def __len__(self): + return len(self._inventory.hosts) + + def __repr__(self): + out = {} + for host in self._inventory.hosts: + out[host] = self.get(host) + return repr(out) + + def __deepcopy__(self, memo): + # We do not need to deepcopy because HostVars is immutable, + # however we have to implement the method so we can deepcopy + # variables' dicts that contain HostVars. + return self + + +class HostVarsVars(Mapping): + + def __init__(self, variables, loader): + self._vars = variables + self._loader = loader + + def __getitem__(self, var): + templar = Templar(variables=self._vars, loader=self._loader) + foo = templar.template(self._vars[var], fail_on_undefined=False, static_vars=STATIC_VARS) + return foo + + def __contains__(self, var): + return (var in self._vars) + + def __iter__(self): + for var in self._vars.keys(): + yield var + + def __len__(self): + return len(self._vars.keys()) + + def __repr__(self): + templar = Templar(variables=self._vars, loader=self._loader) + return repr(templar.template(self._vars, fail_on_undefined=False, static_vars=STATIC_VARS)) |