# See the License for the specific language governing permissions and
# limitations under the License.
-import logging
-from osm_common.dbbase import DbException, DbBase
-from osm_common.dbmongo import deep_update
+from copy import deepcopy
from http import HTTPStatus
+import logging
from uuid import uuid4
-from copy import deepcopy
+
+from osm_common.dbbase import DbBase, DbException
+from osm_common.dbmongo import deep_update
+
__author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
class DbMemory(DbBase):
-
- def __init__(self, logger_name='db', lock=False):
- super().__init__(logger_name, lock)
+ def __init__(self, logger_name="db", lock=False):
+ super().__init__(logger_name=logger_name, lock=lock)
self.db = {}
def db_connect(self, config):
return db_filter
def _find(self, table, q_filter):
-
def recursive_find(key_list, key_next_index, content, oper, target):
if key_next_index == len(key_list) or content is None:
try:
if oper in ("eq", "cont"):
if isinstance(target, list):
if isinstance(content, list):
- return any(content_item in target for content_item in content)
+ return any(
+ content_item in target for content_item in content
+ )
return content in target
elif isinstance(content, list):
return target in content
elif oper in ("neq", "ne", "ncont"):
if isinstance(target, list):
if isinstance(content, list):
- return all(content_item not in target for content_item in content)
+ return all(
+ content_item not in target
+ for content_item in content
+ )
return content not in target
elif isinstance(content, list):
return target not in content
elif oper == "lte":
return content <= target
else:
- raise DbException("Unknown filter operator '{}' in key '{}'".
- format(oper, ".".join(key_list)), http_code=HTTPStatus.BAD_REQUEST)
+ raise DbException(
+ "Unknown filter operator '{}' in key '{}'".format(
+ oper, ".".join(key_list)
+ ),
+ http_code=HTTPStatus.BAD_REQUEST,
+ )
except TypeError:
return False
elif isinstance(content, dict):
- return recursive_find(key_list, key_next_index + 1, content.get(key_list[key_next_index]), oper,
- target)
+ return recursive_find(
+ key_list,
+ key_next_index + 1,
+ content.get(key_list[key_next_index]),
+ oper,
+ target,
+ )
elif isinstance(content, list):
look_for_match = True # when there is a match return immediately
- if (target is None) != (oper in ("neq", "ne", "ncont")): # one True and other False (Xor)
- look_for_match = False # when there is not a match return immediately
+ if (target is None) != (
+ oper in ("neq", "ne", "ncont")
+ ): # one True and other False (Xor)
+ look_for_match = (
+ False # when there is not a match return immediately
+ )
for content_item in content:
if key_list[key_next_index] == "ANYINDEX" and isinstance(v, dict):
for k2, v2 in target.items():
k_new_list = k2.split(".")
new_operator = "eq"
- if k_new_list[-1] in ("eq", "ne", "gt", "gte", "lt", "lte", "cont", "ncont", "neq"):
+ if k_new_list[-1] in (
+ "eq",
+ "ne",
+ "gt",
+ "gte",
+ "lt",
+ "lte",
+ "cont",
+ "ncont",
+ "neq",
+ ):
new_operator = k_new_list.pop()
- if not recursive_find(k_new_list, 0, content_item, new_operator, v2):
+ if not recursive_find(
+ k_new_list, 0, content_item, new_operator, v2
+ ):
matches = False
break
else:
- matches = recursive_find(key_list, key_next_index, content_item, oper, target)
+ matches = recursive_find(
+ key_list, key_next_index, content_item, oper, target
+ )
if matches == look_for_match:
return matches
- if key_list[key_next_index].isdecimal() and int(key_list[key_next_index]) < len(content):
- matches = recursive_find(key_list, key_next_index + 1, content[int(key_list[key_next_index])],
- oper, target)
+ if key_list[key_next_index].isdecimal() and int(
+ key_list[key_next_index]
+ ) < len(content):
+ matches = recursive_find(
+ key_list,
+ key_next_index + 1,
+ content[int(key_list[key_next_index])],
+ oper,
+ target,
+ )
if matches == look_for_match:
return matches
return not look_for_match
for k, v in q_filter.items():
k_list = k.split(".")
operator = "eq"
- if k_list[-1] in ("eq", "ne", "gt", "gte", "lt", "lte", "cont", "ncont", "neq"):
+ if k_list[-1] in (
+ "eq",
+ "ne",
+ "gt",
+ "gte",
+ "lt",
+ "lte",
+ "cont",
+ "ncont",
+ "neq",
+ ):
operator = k_list.pop()
matches = recursive_find(k_list, 0, row, operator, v)
if not matches:
if not fail_on_more:
return deepcopy(row)
if result:
- raise DbException("Found more than one entry with filter='{}'".format(q_filter),
- HTTPStatus.CONFLICT.value)
+ raise DbException(
+ "Found more than one entry with filter='{}'".format(
+ q_filter
+ ),
+ HTTPStatus.CONFLICT.value,
+ )
result = row
if not result and fail_on_empty:
- raise DbException("Not found entry with filter='{}'".format(q_filter), HTTPStatus.NOT_FOUND)
+ raise DbException(
+ "Not found entry with filter='{}'".format(q_filter),
+ HTTPStatus.NOT_FOUND,
+ )
return deepcopy(result)
except Exception as e: # TODO refine
raise DbException(str(e))
break
else:
if fail_on_empty:
- raise DbException("Not found entry with filter='{}'".format(q_filter), HTTPStatus.NOT_FOUND)
+ raise DbException(
+ "Not found entry with filter='{}'".format(q_filter),
+ HTTPStatus.NOT_FOUND,
+ )
return None
del self.db[table][i]
return {"deleted": 1}
except Exception as e: # TODO refine
raise DbException(str(e))
- def _update(self, db_item, update_dict, unset=None, pull=None, push=None, push_list=None, pull_list=None):
+ def _update(
+ self,
+ db_item,
+ update_dict,
+ unset=None,
+ pull=None,
+ push=None,
+ push_list=None,
+ pull_list=None,
+ ):
"""
Modifies an entry at database
:param db_item: entry of the table to update
whole array
:return: True if database has been changed, False if not; Exception on error
"""
+
def _iterate_keys(k, db_nested, populate=True):
k_list = k.split(".")
k_item_prev = k_list[0]
if isinstance(db_nested[k_item_prev], dict):
if k_item not in db_nested[k_item_prev]:
if not populate:
- raise DbException("Cannot set '{}', not existing '{}'".format(k, k_item))
+ raise DbException(
+ "Cannot set '{}', not existing '{}'".format(k, k_item)
+ )
populated = True
db_nested[k_item_prev][k_item] = None
elif isinstance(db_nested[k_item_prev], list) and k_item.isdigit():
k_item = int(k_item)
if k_item >= len(db_nested[k_item_prev]):
if not populate:
- raise DbException("Cannot set '{}', index too large '{}'".format(k, k_item))
+ raise DbException(
+ "Cannot set '{}', index too large '{}'".format(
+ k, k_item
+ )
+ )
populated = True
- db_nested[k_item_prev] += [None] * (k_item - len(db_nested[k_item_prev]) + 1)
+ db_nested[k_item_prev] += [None] * (
+ k_item - len(db_nested[k_item_prev]) + 1
+ )
elif db_nested[k_item_prev] is None:
if not populate:
- raise DbException("Cannot set '{}', not existing '{}'".format(k, k_item))
+ raise DbException(
+ "Cannot set '{}', not existing '{}'".format(k, k_item)
+ )
populated = True
db_nested[k_item_prev] = {k_item: None}
else: # number, string, boolean, ... or list but with not integer key
- raise DbException("Cannot set '{}' on existing '{}={}'".format(k, k_item_prev,
- db_nested[k_item_prev]))
+ raise DbException(
+ "Cannot set '{}' on existing '{}={}'".format(
+ k, k_item_prev, db_nested[k_item_prev]
+ )
+ )
db_nested = db_nested[k_item_prev]
k_item_prev = k_item
return db_nested, k_item_prev, populated
if unset:
for dot_k in unset:
try:
- dict_to_update, key_to_update, _ = _iterate_keys(dot_k, db_item, populate=False)
+ dict_to_update, key_to_update, _ = _iterate_keys(
+ dot_k, db_item, populate=False
+ )
del dict_to_update[key_to_update]
updated = True
- except Exception:
- pass
+ except Exception as unset_error:
+ self.logger.error(f"{unset_error} occured while updating DB.")
if pull:
for dot_k, v in pull.items():
try:
- dict_to_update, key_to_update, _ = _iterate_keys(dot_k, db_item, populate=False)
- except Exception:
+ dict_to_update, key_to_update, _ = _iterate_keys(
+ dot_k, db_item, populate=False
+ )
+ except Exception as pull_error:
+ self.logger.error(f"{pull_error} occured while updating DB.")
continue
+
if key_to_update not in dict_to_update:
continue
if not isinstance(dict_to_update[key_to_update], list):
- raise DbException("Cannot pull '{}'. Target is not a list".format(dot_k))
+ raise DbException(
+ "Cannot pull '{}'. Target is not a list".format(dot_k)
+ )
while v in dict_to_update[key_to_update]:
dict_to_update[key_to_update].remove(v)
updated = True
if pull_list:
for dot_k, v in pull_list.items():
if not isinstance(v, list):
- raise DbException("Invalid content at pull_list, '{}' must be an array".format(dot_k),
- http_code=HTTPStatus.BAD_REQUEST)
+ raise DbException(
+ "Invalid content at pull_list, '{}' must be an array".format(
+ dot_k
+ ),
+ http_code=HTTPStatus.BAD_REQUEST,
+ )
try:
- dict_to_update, key_to_update, _ = _iterate_keys(dot_k, db_item, populate=False)
- except Exception:
+ dict_to_update, key_to_update, _ = _iterate_keys(
+ dot_k, db_item, populate=False
+ )
+ except Exception as iterate_error:
+ self.logger.error(
+ f"{iterate_error} occured while iterating keys in db update."
+ )
continue
+
if key_to_update not in dict_to_update:
continue
if not isinstance(dict_to_update[key_to_update], list):
- raise DbException("Cannot pull_list '{}'. Target is not a list".format(dot_k))
+ raise DbException(
+ "Cannot pull_list '{}'. Target is not a list".format(dot_k)
+ )
for single_v in v:
while single_v in dict_to_update[key_to_update]:
dict_to_update[key_to_update].remove(single_v)
updated = True
if push:
for dot_k, v in push.items():
- dict_to_update, key_to_update, populated = _iterate_keys(dot_k, db_item)
- if isinstance(dict_to_update, dict) and key_to_update not in dict_to_update:
+ dict_to_update, key_to_update, populated = _iterate_keys(
+ dot_k, db_item
+ )
+ if (
+ isinstance(dict_to_update, dict)
+ and key_to_update not in dict_to_update
+ ):
dict_to_update[key_to_update] = [v]
updated = True
elif populated and dict_to_update[key_to_update] is None:
dict_to_update[key_to_update] = [v]
updated = True
elif not isinstance(dict_to_update[key_to_update], list):
- raise DbException("Cannot push '{}'. Target is not a list".format(dot_k))
+ raise DbException(
+ "Cannot push '{}'. Target is not a list".format(dot_k)
+ )
else:
dict_to_update[key_to_update].append(v)
updated = True
if push_list:
for dot_k, v in push_list.items():
if not isinstance(v, list):
- raise DbException("Invalid content at push_list, '{}' must be an array".format(dot_k),
- http_code=HTTPStatus.BAD_REQUEST)
- dict_to_update, key_to_update, populated = _iterate_keys(dot_k, db_item)
- if isinstance(dict_to_update, dict) and key_to_update not in dict_to_update:
+ raise DbException(
+ "Invalid content at push_list, '{}' must be an array".format(
+ dot_k
+ ),
+ http_code=HTTPStatus.BAD_REQUEST,
+ )
+ dict_to_update, key_to_update, populated = _iterate_keys(
+ dot_k, db_item
+ )
+ if (
+ isinstance(dict_to_update, dict)
+ and key_to_update not in dict_to_update
+ ):
dict_to_update[key_to_update] = v.copy()
updated = True
elif populated and dict_to_update[key_to_update] is None:
dict_to_update[key_to_update] = v.copy()
updated = True
elif not isinstance(dict_to_update[key_to_update], list):
- raise DbException("Cannot push '{}'. Target is not a list".format(dot_k),
- http_code=HTTPStatus.CONFLICT)
+ raise DbException(
+ "Cannot push '{}'. Target is not a list".format(dot_k),
+ http_code=HTTPStatus.CONFLICT,
+ )
else:
dict_to_update[key_to_update] += v
updated = True
except Exception as e: # TODO refine
raise DbException(str(e))
- def set_one(self, table, q_filter, update_dict, fail_on_empty=True, unset=None, pull=None, push=None,
- push_list=None, pull_list=None):
+ def set_one(
+ self,
+ table,
+ q_filter,
+ update_dict,
+ fail_on_empty=True,
+ unset=None,
+ pull=None,
+ push=None,
+ push_list=None,
+ pull_list=None,
+ ):
"""
Modifies an entry at database
:param table: collection or table
"""
with self.lock:
for i, db_item in self._find(table, self._format_filter(q_filter)):
- updated = self._update(db_item, update_dict, unset=unset, pull=pull, push=push, push_list=push_list,
- pull_list=pull_list)
+ updated = self._update(
+ db_item,
+ update_dict,
+ unset=unset,
+ pull=pull,
+ push=push,
+ push_list=push_list,
+ pull_list=pull_list,
+ )
return {"updated": 1 if updated else 0}
else:
if fail_on_empty:
- raise DbException("Not found entry with _id='{}'".format(q_filter), HTTPStatus.NOT_FOUND)
+ raise DbException(
+ "Not found entry with _id='{}'".format(q_filter),
+ HTTPStatus.NOT_FOUND,
+ )
return None
- def set_list(self, table, q_filter, update_dict, unset=None, pull=None, push=None, push_list=None, pull_list=None):
+ def set_list(
+ self,
+ table,
+ q_filter,
+ update_dict,
+ unset=None,
+ pull=None,
+ push=None,
+ push_list=None,
+ pull_list=None,
+ ):
"""Modifies al matching entries at database. Same as push. Do not fail if nothing matches"""
with self.lock:
updated = 0
found = 0
for _, db_item in self._find(table, self._format_filter(q_filter)):
found += 1
- if self._update(db_item, update_dict, unset=unset, pull=pull, push=push, push_list=push_list,
- pull_list=pull_list):
+ if self._update(
+ db_item,
+ update_dict,
+ unset=unset,
+ pull=pull,
+ push=push,
+ push_list=push_list,
+ pull_list=pull_list,
+ ):
updated += 1
# if not found and fail_on_empty:
# raise DbException("Not found entry with '{}'".format(q_filter), HTTPStatus.NOT_FOUND)
break
else:
if fail_on_empty:
- raise DbException("Not found entry with _id='{}'".format(_id), HTTPStatus.NOT_FOUND)
+ raise DbException(
+ "Not found entry with _id='{}'".format(_id),
+ HTTPStatus.NOT_FOUND,
+ )
return None
self.db[table][i] = deepcopy(indata)
return {"updated": 1}
raise DbException(str(e))
-if __name__ == '__main__':
+if __name__ == "__main__":
# some test code
db = DbMemory()
db.create("test", {"_id": 1, "data": 1})