"nested_alter" and update of "nested_update" (#16)
* Update lookup_api.py moved the typecheck of the value argument to the wrapper function. * added tests for nested_update Test * pep8 format standards moded _call_callback out of the nested_alter Method Raised an Exception is no list is provided but treas_as_elemenet is false treat_list_as_element:bool renamed to treat_as_element:bool and set default to True * Auto commit via script * Create CONTRIBUTORS.rst * Rename CONTRIBUTORS.rst to CONTRIBUTING.rst * Update CONTRIBUTING.rst * Fix for issue #17 (#18) * Fix for issue #17 * Updating version (and) Adding Travis CI support * Adding Build status to README * changed the type annotation of the input document (removed it) removed the output type hint change the Readme * Update lookup_api.py moved the typecheck of the value argument to the wrapper function. * added tests for nested_update Test * pep8 format standards moded _call_callback out of the nested_alter Method Raised an Exception is no list is provided but treas_as_elemenet is false treat_list_as_element:bool renamed to treat_as_element:bool and set default to True * changed the type annotation of the input document (removed it) removed the output type hint change the Readme
This commit is contained in:
Salfiii
parent
0e8723b822
commit
4f37d265c8
5 changed files with 670 additions and 91 deletions
|
|
@ -1,3 +1,3 @@
|
|||
from .nested_lookup import nested_lookup, get_all_keys, get_occurrence_of_key,\
|
||||
get_occurrence_of_value
|
||||
from .lookup_api import nested_update, nested_delete
|
||||
from .lookup_api import nested_update, nested_delete, nested_alter
|
||||
|
|
|
|||
|
|
@ -1,14 +1,16 @@
|
|||
import copy
|
||||
import warnings
|
||||
from six import iteritems
|
||||
from nested_lookup import nested_lookup
|
||||
|
||||
|
||||
def nested_delete(document, key, in_place=False):
|
||||
def nested_delete(document, key: str, in_place: bool = False):
|
||||
if not in_place:
|
||||
document = copy.deepcopy(document)
|
||||
return _nested_delete(document=document, key=key)
|
||||
|
||||
|
||||
def _nested_delete(document, key):
|
||||
def _nested_delete(document, key: str) -> dict:
|
||||
"""
|
||||
Method to delete a key->value pair from a nested document
|
||||
Args:
|
||||
|
|
@ -22,35 +24,187 @@ def _nested_delete(document, key):
|
|||
for list_items in document:
|
||||
_nested_delete(document=list_items, key=key)
|
||||
elif isinstance(document, dict):
|
||||
if document.get(key) is not None:
|
||||
if document.get(key):
|
||||
del document[key]
|
||||
for dict_key, dict_value in iteritems(document):
|
||||
_nested_delete(document=dict_value, key=key)
|
||||
return document
|
||||
|
||||
|
||||
def nested_update(document, key, value, in_place=False):
|
||||
if not in_place:
|
||||
document = copy.deepcopy(document)
|
||||
return _nested_update(document=document, key=key, value=value)
|
||||
|
||||
|
||||
def _nested_update(document, key, value):
|
||||
def nested_update(document, key: str, value: object,
|
||||
in_place: bool = False,
|
||||
treat_as_element: bool = True):
|
||||
"""
|
||||
Method to update a key->value pair in a nested document
|
||||
Args:
|
||||
document: Might be List of Dicts (or) Dict of Lists (or)
|
||||
Dict of List of Dicts etc...
|
||||
Dict of List of Dicts etc...
|
||||
key: Key to update the value
|
||||
value: Value to set
|
||||
in_place (bool):
|
||||
True: modify the dict in place;
|
||||
False: create a deep copy of the dict and modify it
|
||||
Defaults to False
|
||||
treat_list_element (bool):
|
||||
True: if a list is provided as "value", the function trys
|
||||
to match the list elements to the occurences of the key.
|
||||
If the key occures more often than the provided list has
|
||||
elements, the first element gets recycled.
|
||||
False: the provided list is treated as one scalar value and
|
||||
will be set as value to every key that matches.
|
||||
Defaults to True (because of backwards portability of the package).
|
||||
Return:
|
||||
Returns a document that has updated key, value pair.
|
||||
"""
|
||||
|
||||
# check if a list or scalar value is provided and create a list
|
||||
# from the scalar value
|
||||
# check the length of the list and provide it to _nested_update
|
||||
if not treat_as_element and not isinstance(value, list):
|
||||
raise Exception('You need to pass value as list if you opt for' +
|
||||
'this feature')
|
||||
elif treat_as_element:
|
||||
value = [value]
|
||||
|
||||
val_len = len(value)
|
||||
|
||||
if not in_place:
|
||||
document = copy.deepcopy(document)
|
||||
return _nested_update(document=document, key=key, value=value,
|
||||
val_len=val_len)
|
||||
|
||||
|
||||
def _nested_update(document, key: str, value: object,
|
||||
val_len: int, run: int = 0):
|
||||
"""
|
||||
Method to update a key->value pair in a nested document
|
||||
Args:
|
||||
document: Might be List of Dicts (or) Dict of Lists (or)
|
||||
Dict of List of Dicts etc...
|
||||
key (str): Key to update the value
|
||||
value (list): value(s) which should be used for replacement purpouse
|
||||
val_len (int): lenght of the value element
|
||||
run (int): holds the number of findings for the given key.
|
||||
Every time the key is found, run = run + 1. If the list value[run]
|
||||
exists,
|
||||
the corresponding element is used for replacement purpouse.
|
||||
Defaults to 0.
|
||||
Return:
|
||||
Returns a document that has updated key, value pair.
|
||||
"""
|
||||
if isinstance(document, list):
|
||||
for list_items in document:
|
||||
_nested_update(document=list_items, key=key, value=value)
|
||||
_nested_update(document=list_items, key=key, value=value,
|
||||
val_len=val_len, run=run)
|
||||
elif isinstance(document, dict):
|
||||
if document.get(key) is not None:
|
||||
document[key] = value
|
||||
if document.get(key):
|
||||
# check if a value with the coresponding index exists and
|
||||
# use it otherwise recycle the intially given value
|
||||
if run < val_len:
|
||||
val = value[run]
|
||||
else:
|
||||
run = 0
|
||||
val = value[run]
|
||||
document[key] = val
|
||||
run = run + 1
|
||||
for dict_key, dict_value in iteritems(document):
|
||||
_nested_update(document=dict_value, key=key, value=value)
|
||||
_nested_update(document=dict_value, key=key, value=value,
|
||||
val_len=val_len, run=run)
|
||||
return document
|
||||
|
||||
|
||||
def nested_alter(document, key: str, callback_function=None,
|
||||
function_parameters: list = None, conversion_function=None,
|
||||
wild_alter: bool = False, in_place: bool = True):
|
||||
"""
|
||||
Method to alter all values of the occurences of the key "key".
|
||||
The provided callback_function is used to alter the scalar values
|
||||
Args:
|
||||
document: Might be List of Dicts (or) Dict of Lists (or)
|
||||
Dict of List of Dicts etc...
|
||||
key: Key to update the value
|
||||
callback_function :A callback function which alters a scalar value
|
||||
HINT: You should be aware that not every element might be of
|
||||
the same type, please check this in your function!
|
||||
function_parameters (list):
|
||||
If the callback_function has additional input arguments except
|
||||
the scalar value, please specify those in this list.
|
||||
conversion_function: A conversion function like str() which should be
|
||||
applied to every found value before it is passed to the
|
||||
"callback_function"
|
||||
wild_alter: Find matching elements via wild-match by the given keys
|
||||
and alter those.
|
||||
HINT: Keep in mind that the wild-match might return unexpected types!
|
||||
in_place (bool):
|
||||
True: modify the dict in place;
|
||||
False: create a deep copy of the dict and modify it
|
||||
Defaults to False
|
||||
Return:
|
||||
Returns a document that has updated key, value pair.
|
||||
"""
|
||||
# check if a list or scalar value is provided and create a list from
|
||||
# the scalar value
|
||||
# check the length of the list and provide it to _nested_update
|
||||
if isinstance(key, list):
|
||||
key_len = len(key)
|
||||
else:
|
||||
key = [key]
|
||||
key_len = len(key)
|
||||
|
||||
if not in_place:
|
||||
document = copy.deepcopy(document)
|
||||
return _nested_alter(document=document, keys=key,
|
||||
callback_function=callback_function,
|
||||
function_parameters=function_parameters,
|
||||
conversion_function=conversion_function,
|
||||
wild_alter=wild_alter,
|
||||
in_place=in_place, key_len=key_len)
|
||||
|
||||
|
||||
def _call_callback(value_list: list, callback_function,
|
||||
function_parameters: list, conversion_function):
|
||||
"""
|
||||
internal helper to call the callback function
|
||||
"""
|
||||
return_list = []
|
||||
# loop over all values
|
||||
for value in value_list:
|
||||
# apply the conversion function
|
||||
if conversion_function is not None:
|
||||
value = conversion_function(value)
|
||||
# if functions arguments are present, expand the list to variables
|
||||
# via the magic operator *
|
||||
if function_parameters:
|
||||
trans_val = callback_function(value, *function_parameters)
|
||||
else:
|
||||
trans_val = callback_function(value)
|
||||
# append the transformed element to the list
|
||||
return_list.append(trans_val)
|
||||
return return_list
|
||||
|
||||
|
||||
def _nested_alter(document, keys, callback_function,
|
||||
function_parameters: list, conversion_function,
|
||||
wild_alter: bool, in_place: bool, key_len: int):
|
||||
"""
|
||||
"""
|
||||
# return data if no callback_function is provided
|
||||
if callback_function is None:
|
||||
warnings.warn("Please provide a callback_function to nested_alter().")
|
||||
return document
|
||||
|
||||
# iterate over all given keys in the list
|
||||
for key in keys:
|
||||
# try to find the key:
|
||||
findings = nested_lookup(key, document, with_keys=True, wild=wild_alter)
|
||||
for k, v in findings.items():
|
||||
trans_val = _call_callback(v, callback_function,
|
||||
function_parameters,
|
||||
conversion_function)
|
||||
# use the transformed value and apply the update to the key
|
||||
# (dont treat the lists as elements here)
|
||||
document = nested_update(document, k, trans_val,
|
||||
in_place=in_place,
|
||||
treat_as_element=False)
|
||||
|
||||
return document
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue