misc collection metadata fixes (#70403)

* misc collection metadata fixes

* parse collection meta with libyaml if available
* require only Mapping for validation
* add explanatory text for _meta_yml_to_dict

* ignore custom pylint rule

* this code shouldn't import a bunch of stuff from ansible, since it's run under the import sanity test
This commit is contained in:
Matt Davis 2020-07-01 11:09:21 -07:00 committed by GitHub
parent f7078c1f8f
commit b9e38e8b55
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 5 deletions

View file

@ -0,0 +1,2 @@
bugfixes:
- collection metadata - ensure collection loader uses libyaml/CSafeLoader to parse collection metadata if available

View file

@ -4,14 +4,30 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
from yaml import safe_load
from yaml import load
try:
from yaml import CSafeLoader as SafeLoader
except ImportError:
from yaml import SafeLoader
try:
from collections.abc import Mapping # pylint: disable=ansible-bad-import-from
except ImportError:
from collections import Mapping # pylint: disable=ansible-bad-import-from
def _meta_yml_to_dict(yaml_string_data, content_id):
routing_dict = safe_load(yaml_string_data)
"""
Converts string YAML dictionary to a Python dictionary. This function may be monkeypatched to another implementation
by some tools (eg the import sanity test).
:param yaml_string_data: a bytes-ish YAML dictionary
:param content_id: a unique ID representing the content to allow other implementations to cache the output
:return: a Python dictionary representing the YAML dictionary content
"""
# NB: content_id is passed in, but not used by this implementation
routing_dict = load(yaml_string_data, Loader=SafeLoader)
if not routing_dict:
routing_dict = {}
# TODO: change this to Mapping abc?
if not isinstance(routing_dict, dict):
raise ValueError('collection metadata must be a dictionary')
if not isinstance(routing_dict, Mapping):
raise ValueError('collection metadata must be an instance of Python Mapping')
return routing_dict