diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 16:04:21 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 16:04:21 +0000 |
commit | 8a754e0858d922e955e71b253c139e071ecec432 (patch) | |
tree | 527d16e74bfd1840c85efd675fdecad056c54107 /lib/ansible/parsing/utils/yaml.py | |
parent | Initial commit. (diff) | |
download | ansible-core-8a754e0858d922e955e71b253c139e071ecec432.tar.xz ansible-core-8a754e0858d922e955e71b253c139e071ecec432.zip |
Adding upstream version 2.14.3.upstream/2.14.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'lib/ansible/parsing/utils/yaml.py')
-rw-r--r-- | lib/ansible/parsing/utils/yaml.py | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/lib/ansible/parsing/utils/yaml.py b/lib/ansible/parsing/utils/yaml.py new file mode 100644 index 0000000..91e37f9 --- /dev/null +++ b/lib/ansible/parsing/utils/yaml.py @@ -0,0 +1,84 @@ +# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com> +# Copyright: (c) 2017, Ansible Project +# Copyright: (c) 2018, Ansible Project +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +# Make coding more python3-ish +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +import json + +from yaml import YAMLError + +from ansible.errors import AnsibleParserError +from ansible.errors.yaml_strings import YAML_SYNTAX_ERROR +from ansible.module_utils._text import to_native +from ansible.parsing.yaml.loader import AnsibleLoader +from ansible.parsing.yaml.objects import AnsibleBaseYAMLObject +from ansible.parsing.ajson import AnsibleJSONDecoder + + +__all__ = ('from_yaml',) + + +def _handle_error(json_exc, yaml_exc, file_name, show_content): + ''' + Optionally constructs an object (AnsibleBaseYAMLObject) to encapsulate the + file name/position where a YAML exception occurred, and raises an AnsibleParserError + to display the syntax exception information. + ''' + + # if the YAML exception contains a problem mark, use it to construct + # an object the error class can use to display the faulty line + err_obj = None + if hasattr(yaml_exc, 'problem_mark'): + err_obj = AnsibleBaseYAMLObject() + err_obj.ansible_pos = (file_name, yaml_exc.problem_mark.line + 1, yaml_exc.problem_mark.column + 1) + + n_yaml_syntax_error = YAML_SYNTAX_ERROR % to_native(getattr(yaml_exc, 'problem', u'')) + n_err_msg = 'We were unable to read either as JSON nor YAML, these are the errors we got from each:\n' \ + 'JSON: %s\n\n%s' % (to_native(json_exc), n_yaml_syntax_error) + + raise AnsibleParserError(n_err_msg, obj=err_obj, show_content=show_content, orig_exc=yaml_exc) + + +def _safe_load(stream, file_name=None, vault_secrets=None): + ''' Implements yaml.safe_load(), except using our custom loader class. ''' + + loader = AnsibleLoader(stream, file_name, vault_secrets) + try: + return loader.get_single_data() + finally: + try: + loader.dispose() + except AttributeError: + pass # older versions of yaml don't have dispose function, ignore + + +def from_yaml(data, file_name='<string>', show_content=True, vault_secrets=None, json_only=False): + ''' + Creates a python datastructure from the given data, which can be either + a JSON or YAML string. + ''' + new_data = None + + try: + # in case we have to deal with vaults + AnsibleJSONDecoder.set_secrets(vault_secrets) + + # we first try to load this data as JSON. + # Fixes issues with extra vars json strings not being parsed correctly by the yaml parser + new_data = json.loads(data, cls=AnsibleJSONDecoder) + except Exception as json_exc: + + if json_only: + raise AnsibleParserError(to_native(json_exc), orig_exc=json_exc) + + # must not be JSON, let the rest try + try: + new_data = _safe_load(data, file_name=file_name, vault_secrets=vault_secrets) + except YAMLError as yaml_exc: + _handle_error(json_exc, yaml_exc, file_name, show_content) + + return new_data |