plynx.utils.common

Common utils

Module Contents

plynx.utils.common.SearchParameter

plynx.utils.common.SEARCH_RGX

plynx.utils.common.TRUES = ['true', 't']

plynx.utils.common.FALSES = ['false', 'f']

plynx.utils.common.to_object_id(_id: Union[ObjectId, str, None]) → ObjectId

Create ObjectId based on str, or return original value.

class plynx.utils.common.JSONEncoder

Bases: json.JSONEncoder

Handles some of the built in types

default(self, o)

plynx.utils.common.zipdir(path: str, zf: zipfile.ZipFile)

Walk in zip file

plynx.utils.common.parse_search_string(search_string: str) → Tuple[Dict, str]

Separate keywords fro mserach string

plynx.utils.common.query_yes_no(question: str, default: str = 'yes') → bool

Ask a yes/no question via input() and return their answer.

Args:

question (str): String that is presented to the user. default (str): ‘yes’ or ‘no’ default value

The ‘answer’ return value is True for ‘yes’ or False for ‘no’.

plynx.utils.common.str_to_bool(val: Union[str, bool]) → bool

Convert string value to boolean

plynx.utils.common.update_dict_recursively(dest: Dict[Any, Any], donor: Dict[Any, Any]) → Dict[Any, Any]

Update dictionary in place