# and is available at http://www.eclipse.org/legal/epl-v10.html
import collections as _collections
+import jmespath
+
try:
import simplejson as _json
except ImportError: # Python2.7 calls it json.
__email__ = "vrpolak@cisco.com"
-# Internal details.
+# Internal details; look down below for Robot Keywords.
class _Hsfl(list):
def __init__(self, *args, **kwargs):
"""Put arguments to OrderedDict, sort, pass to super, cache values."""
self_unsorted = _collections.OrderedDict(*args, **kwargs)
- items_sorted = sorted(self_unsorted.items(), key=repr)
+ items_sorted = sorted(list(self_unsorted.items()), key=repr)
sup = super(_Hsfod, self) # possibly something else than OrderedDict
sup.__init__(items_sorted)
# Repr string is used for sorting, keys are more important than values.
- self.__repr = '{' + repr(self.keys()) + ':' + repr(self.values()) + '}'
+ self.__repr = (
+ "{" + repr(list(self.keys())) + ":" + repr(list(self.values())) + "}"
+ )
self.__hash = hash(self.__repr)
def __repr__(self):
Based on: http://stackoverflow.com/questions/10885238/
python-change-list-type-for-json-decoding"""
+
def __init__(self, **kwargs):
"""Initialize decoder with special array implementation."""
_json.JSONDecoder.__init__(self, **kwargs)
self.scan_once = _json.scanner.py_make_scanner(self)
-# Robot Keywords.
+# Robot Keywords; look above for internal details.
def loads_sorted(text, strict=False):
- """
- Return Python object with sorted arrays and dictionary keys.
-
- If strict is true, raise exception on parse error.
- If strict is not true, return string with error message.
- """
- try:
- object_decoded = _json.loads(text, cls=_Decoder, object_hook=_Hsfod)
- except ValueError as err:
- if strict:
- raise err
- else:
- return str(err) + '\n' + text
+ """Return Python object with sorted arrays and dictionary keys."""
+ object_decoded = _json.loads(text, cls=_Decoder, object_hook=_Hsfod)
return object_decoded
def dumps_indented(obj, indent=1):
"""
- Wrapper for json.dumps with default indentation level. Adds newline.
+ Wrapper for json.dumps with default indentation level.
The main value is that BuiltIn.Evaluate cannot easily accept Python object
as part of its argument.
Also, allows to use something different from RequestsLibrary.To_Json
+
+ """
+ pretty_json = _json.dumps(obj, separators=(",", ": "), indent=indent)
+ return pretty_json + "\n" # to avoid diff "no newline" warning line
+
+
+def sort_bits(obj, keys_with_bits=[]):
+ """
+ Rearrange string values of list bits names in alphabetical order.
+
+ This function looks at dict items with known keys.
+ If the value is string, space-separated names are sorted.
+ This function is recursive over dicts and lists.
+ Current implementation performs re-arranging in-place (to save memory),
+ so it is not required to store the return value.
+
+ The intended usage is for composite objects which contain
+ OrderedDict elements. The implementation makes sure that ordering
+ (dictated by keys) is preserved. Support for generic dicts is an added value.
+
+ Sadly, dict (at least in Python 2.7) does not have __updatevalue__(key) method
+ which would guarantee iteritems() is not affected when value is updated.
+ Current "obj[key] = value" implementation is safe for dict and OrderedDict,
+ but it may be not safe for other subclasses of dict.
+
+ TODO: Should this docstring include links to support dict and OrderedDict safety?
+ """
+ if isinstance(obj, dict):
+ for key, value in obj.items():
+ # Unicode is not str and vice versa, isinstance has to check for both.
+ # Luckily, "in" recognizes equivalent strings in different encodings.
+ # Type "bytes" is added for Python 3 compatibility.
+ if key in keys_with_bits and isinstance(value, (str, bytes)):
+ obj[key] = " ".join(sorted(value.split(" ")))
+ else:
+ sort_bits(value, keys_with_bits)
+ # A string is not a list, so there is no risk of recursion over characters.
+ elif isinstance(obj, list):
+ for item in obj:
+ sort_bits(item, keys_with_bits)
+ return obj
+
+
+def hide_volatile(obj, keys_with_volatiles=[]):
+ """
+ Takes list of keys with volatile values, and replaces them with generic "*"
+
+ :param obj: python dict from json
+ :param keys_with_volatiles: list of volatile keys
+ :return: corrected
+ """
+ if isinstance(obj, dict):
+ for key, value in obj.items():
+ # Unicode is not str and vice versa, isinstance has to check for both.
+ # Luckily, "in" recognizes equivalent strings in different encodings.
+ # Type "bytes" is added for Python 3 compatibility.
+ if key in keys_with_volatiles and isinstance(
+ value, (str, bytes, int, bool)
+ ):
+ obj[key] = "*"
+ else:
+ hide_volatile(value, keys_with_volatiles)
+ # A string is not a list, so there is no risk of recursion over characters.
+ elif isinstance(obj, list):
+ for item in obj:
+ hide_volatile(item, keys_with_volatiles)
+ return obj
+
+
+def normalize_json_text(
+ text,
+ strict=False,
+ indent=1,
+ keys_with_bits=[],
+ keys_with_volatiles=[],
+ jmes_path=None,
+):
+ """
+ Attempt to return sorted indented JSON string.
+
+ If jmes_path is set the related subset of JSON data is returned as
+ indented JSON string if the subset exists. Empty string is returned if the
+ subset doesn't exist.
+ Empty string is returned if text is not passed.
+ If parse error happens:
+ If strict is true, raise the exception.
+ If strict is not true, return original text with error message.
+ If keys_with_bits is non-empty, run sort_bits on intermediate Python object.
"""
- pretty_json = _json.dumps(obj, separators=(',', ': '), indent=indent)
- return pretty_json + '\n' # to avoid diff "no newline" warning line
+ if not text:
+ return ""
+
+ if jmes_path:
+ json_obj = _json.loads(text)
+ subset = jmespath.search(jmes_path, json_obj)
+ if not subset:
+ return ""
+ text = _json.dumps(subset)
+
+ try:
+ object_decoded = loads_sorted(text)
+ except ValueError as err:
+ if strict:
+ raise err
+ else:
+ return str(err) + "\n" + text
+ if keys_with_bits:
+ sort_bits(object_decoded, keys_with_bits)
+ if keys_with_volatiles:
+ hide_volatile(object_decoded, keys_with_volatiles)
-def normalize_json_text(text, strict=False, indent=1): # pylint likes lowercase
- """Return sorted indented JSON string, or an error message string."""
- object_decoded = loads_sorted(text, strict=strict)
pretty_json = dumps_indented(object_decoded, indent=indent)
+
return pretty_json
Code Review / integration / test.git / blobdiff