# (c) 2012-2014, Michael DeHaan # # 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 . from ansible.playbook.attribute import Attribute, FieldAttribute class Base(object): def __init__(self): # each class knows attributes set upon it, see Task.py for example self._attributes = dict() for (name, value) in self.__class__.__dict__.iteritems(): aname = name[1:] if isinstance(value, Attribute): self._attributes[aname] = value.default def munge(self, ds): ''' infrequently used method to do some pre-processing of legacy terms ''' return ds def load_data(self, ds): ''' walk the input datastructure and assign any values ''' assert ds is not None # we currently don't do anything with private attributes but may # later decide to filter them out of 'ds' here. ds = self.munge(ds) # walk all attributes in the class for (name, attribute) in self.__class__.__dict__.iteritems(): aname = name[1:] # process Field attributes which get loaded from the YAML if isinstance(attribute, FieldAttribute): # copy the value over unless a _load_field method is defined method = getattr(self, '_load_%s' % aname, None) if method: self._attributes[aname] = method(self, attribute) else: if aname in ds: self._attributes[aname] = ds[aname] # return the constructed object self.validate() return self def validate(self): ''' validation that is done at parse time, not load time ''' # walk all fields in the object for (name, attribute) in self.__dict__.iteritems(): # find any field attributes if isinstance(attribute, FieldAttribute): if not name.startswith("_"): raise AnsibleError("FieldAttribute %s must start with _" % name) aname = name[1:] # run validator only if present method = getattr(self, '_validate_%s' % (prefix, aname), None) if method: method(self, attribute) def post_validate(self, runner_context): ''' we can't tell that everything is of the right type until we have all the variables. Run basic types (from isa) as well as any _post_validate_ functions. ''' raise exception.NotImplementedError def __getattr__(self, needle): # return any attribute names as if they were real # optionally allowing masking by accessors if not needle.startswith("_"): method = "get_%s" % needle if method in self.__dict__: return method(self) if needle in self._attributes: return self._attributes[needle] raise AttributeError("attribute not found: %s" % needle)