110 lines
4.1 KiB
Python
110 lines
4.1 KiB
Python
# Copyright: (c) 2012, Jan-Piet Mens <jpmens () gmail.com>
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
from ansible.errors import AnsibleError, AnsibleAssertionError
|
|
from ansible.module_utils.six import string_types
|
|
from ansible.module_utils._text import to_native
|
|
from ansible.module_utils.common._collections_compat import MutableMapping, MutableSet, MutableSequence
|
|
from ansible.parsing.plugin_docs import read_docstring
|
|
from ansible.parsing.yaml.loader import AnsibleLoader
|
|
from ansible.utils.display import Display
|
|
|
|
display = Display()
|
|
|
|
|
|
# modules that are ok that they do not have documentation strings
|
|
BLACKLIST = {
|
|
'MODULE': frozenset(('async_wrapper',)),
|
|
'CACHE': frozenset(('base',)),
|
|
}
|
|
|
|
|
|
def merge_fragment(target, source):
|
|
|
|
for key, value in source.items():
|
|
if key in target:
|
|
# assumes both structures have same type
|
|
if isinstance(target[key], MutableMapping):
|
|
value.update(target[key])
|
|
elif isinstance(target[key], MutableSet):
|
|
value.add(target[key])
|
|
elif isinstance(target[key], MutableSequence):
|
|
value = sorted(frozenset(value + target[key]))
|
|
else:
|
|
raise Exception("Attempt to extend a documentation fragement, invalid type for %s" % key)
|
|
target[key] = value
|
|
|
|
|
|
def add_fragments(doc, filename, fragment_loader):
|
|
|
|
fragments = doc.pop('extends_documentation_fragment', [])
|
|
|
|
if isinstance(fragments, string_types):
|
|
fragments = [fragments]
|
|
|
|
# Allow the module to specify a var other than DOCUMENTATION
|
|
# to pull the fragment from, using dot notation as a separator
|
|
for fragment_slug in fragments:
|
|
fragment_slug = fragment_slug.lower()
|
|
if '.' in fragment_slug:
|
|
fragment_name, fragment_var = fragment_slug.split('.', 1)
|
|
fragment_var = fragment_var.upper()
|
|
else:
|
|
fragment_name, fragment_var = fragment_slug, 'DOCUMENTATION'
|
|
|
|
fragment_class = fragment_loader.get(fragment_name)
|
|
if fragment_class is None:
|
|
raise AnsibleAssertionError('fragment_class is None')
|
|
|
|
fragment_yaml = getattr(fragment_class, fragment_var, '{}')
|
|
fragment = AnsibleLoader(fragment_yaml, file_name=filename).get_single_data()
|
|
|
|
if 'notes' in fragment:
|
|
notes = fragment.pop('notes')
|
|
if notes:
|
|
if 'notes' not in doc:
|
|
doc['notes'] = []
|
|
doc['notes'].extend(notes)
|
|
|
|
if 'seealso' in fragment:
|
|
seealso = fragment.pop('seealso')
|
|
if seealso:
|
|
if 'seealso' not in doc:
|
|
doc['seealso'] = []
|
|
doc['seealso'].extend(seealso)
|
|
|
|
if 'options' not in fragment:
|
|
raise Exception("missing options in fragment (%s), possibly misformatted?: %s" % (fragment_name, filename))
|
|
|
|
# ensure options themselves are directly merged
|
|
if 'options' in doc:
|
|
try:
|
|
merge_fragment(doc['options'], fragment.pop('options'))
|
|
except Exception as e:
|
|
raise AnsibleError("%s options (%s) of unknown type: %s" % (to_native(e), fragment_name, filename))
|
|
else:
|
|
doc['options'] = fragment.pop('options')
|
|
|
|
# merge rest of the sections
|
|
try:
|
|
merge_fragment(doc, fragment)
|
|
except Exception as e:
|
|
raise AnsibleError("%s (%s) of unknown type: %s" % (to_native(e), fragment_name, filename))
|
|
|
|
|
|
def get_docstring(filename, fragment_loader, verbose=False, ignore_errors=False):
|
|
"""
|
|
DOCUMENTATION can be extended using documentation fragments loaded by the PluginLoader from the doc_fragments plugins.
|
|
"""
|
|
|
|
data = read_docstring(filename, verbose=verbose, ignore_errors=ignore_errors)
|
|
|
|
# add fragments to documentation
|
|
if data.get('doc', False):
|
|
add_fragments(data['doc'], filename, fragment_loader=fragment_loader)
|
|
|
|
return data['doc'], data['plainexamples'], data['returndocs'], data['metadata']
|