summaryrefslogtreecommitdiffstats
path: root/lib/ansible/module_utils/common/yaml.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/module_utils/common/yaml.py')
-rw-r--r--lib/ansible/module_utils/common/yaml.py48
1 files changed, 48 insertions, 0 deletions
diff --git a/lib/ansible/module_utils/common/yaml.py b/lib/ansible/module_utils/common/yaml.py
new file mode 100644
index 0000000..e79cc09
--- /dev/null
+++ b/lib/ansible/module_utils/common/yaml.py
@@ -0,0 +1,48 @@
+# (c) 2020 Matt Martz <matt@sivel.net>
+# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+
+"""
+This file provides ease of use shortcuts for loading and dumping YAML,
+preferring the YAML compiled C extensions to reduce duplicated code.
+"""
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+from functools import partial as _partial
+
+HAS_LIBYAML = False
+
+try:
+ import yaml as _yaml
+except ImportError:
+ HAS_YAML = False
+else:
+ HAS_YAML = True
+
+if HAS_YAML:
+ try:
+ from yaml import CSafeLoader as SafeLoader
+ from yaml import CSafeDumper as SafeDumper
+ from yaml.cyaml import CParser as Parser
+
+ HAS_LIBYAML = True
+ except (ImportError, AttributeError):
+ from yaml import SafeLoader # type: ignore[misc]
+ from yaml import SafeDumper # type: ignore[misc]
+ from yaml.parser import Parser # type: ignore[misc]
+
+ yaml_load = _partial(_yaml.load, Loader=SafeLoader)
+ yaml_load_all = _partial(_yaml.load_all, Loader=SafeLoader)
+
+ yaml_dump = _partial(_yaml.dump, Dumper=SafeDumper)
+ yaml_dump_all = _partial(_yaml.dump_all, Dumper=SafeDumper)
+else:
+ SafeLoader = object # type: ignore[assignment,misc]
+ SafeDumper = object # type: ignore[assignment,misc]
+ Parser = object # type: ignore[assignment,misc]
+
+ yaml_load = None # type: ignore[assignment]
+ yaml_load_all = None # type: ignore[assignment]
+ yaml_dump = None # type: ignore[assignment]
+ yaml_dump_all = None # type: ignore[assignment]