def lconf_to_float(number_str, extra_err_info):
""" Return a float of the input number_str
:param number_str: (str) string of a number: must contain a valid number to be cast to python float()
.. python-example:: Taken from the python documentation
.. code-block:: python3
>>> float('+1.23')
1.23
>>> float(' -12345\\n')
-12345.0
>>> float('1e-003')
0.001
>>> float('+1E6')
1000000.0
>>> float('-Infinity')
-inf
:param extra_err_info: (str) any additional info which will be printed if an error is raised: e.g line number, original
line ect..
:return: (float) conversion of the input number_str
:raise Err:
"""
try:
return float(number_str)
except ValueError as err:
raise Err('lconf_to_float', [
'number_str must contain a valid number to be cast to python float(). We got: <{}>'
.format(number_str),
' extra_err_info: {}'.format(extra_err_info),
' ValueError: {}'.format(err)
])
def lconf_to_datetime(date_str, extra_err_info):
""" Return a python datetime of the input date_str
:param date_str: (str) string of a datetime: format:
16 character long: `YYYY-MM-DD hh:mm` e.g. `2014-05-08 13:39`
19 character long: `YYYY-MM-DD hh:mm:ss` e.g. `2014-05-08 13:39:00`
:param extra_err_info: (str) any additional info which will be printed if an error is raised: e.g line number, original
line ect..
:return: (datetime) conversion of the input date_str
:raise Err:
"""
date_str_len = len(date_str)
if date_str_len == 16:
try:
return datetime.strptime(date_str, '%Y-%m-%d %H:%M')
except:
raise Err('lconf_to_datetime', [
'date_str must be in the format: 16 character long: `YYYY-MM-DD hh:mm`',
'OR: 19 character long: `YYYY-MM-DD hh:mm:ss`',
' We got: date_str_len: <{}> date_str: <{}>'.format(
date_str_len,
date_str), ' extra_err_info: {}'.format(extra_err_info)
])
elif date_str_len == 19:
try:
return datetime.strptime(date_str, '%Y-%m-%d %H:%M:%S')
except:
raise Err('lconf_to_datetime', [
'date_str must be in the format: 16 character long: `YYYY-MM-DD hh:mm`',
'OR: 19 character long: `YYYY-MM-DD hh:mm:ss`',
' We got: date_str_len: <{}> date_str: <{}>'.format(
date_str_len,
date_str), ' extra_err_info: {}'.format(extra_err_info)
])
else:
raise Err('lconf_to_datetime', [
'date_str must be in the format: 16 character long: `YYYY-MM-DD hh:mm`',
'OR: 19 character long: `YYYY-MM-DD hh:mm:ss`',
' We got: date_str_len: <{}> date_str: <{}>'.format(
date_str_len,
date_str), ' extra_err_info: {}'.format(extra_err_info)
])
def replace_column_names(self, new_column_names_tuple):
""" Replaces the `column_names (tuple)` with the new_column_names_tuple
:param new_column_names_tuple: (tuple) must have the same number of names as the current `column_names`
:raise Err:
"""
if new_column_names_tuple.__class__ is tuple:
if len(new_column_names_tuple) == self.column_names_counted:
self.__dict__['column_names'] = new_column_names_tuple
self.__dict__['column_names_idx_lookup'] = {
key: idx
for idx, key in enumerate(new_column_names_tuple)
}
# Check unique names
if len(self.column_names_idx_lookup
) != self.column_names_counted:
raise Err('LconfListOT.replace_column_names()', [
'All column names are not unique: Problems: <{}>'.
format(
self._helper_find_duplicates(
new_column_names_tuple)),
' new_column_names_tuple: <{}>'.format(
new_column_names_tuple)
])
else:
raise Err('LconfListOT.replace_column_names()', [
'new_column_names: <{}> must be the same number as column_names_counted: <{}>'
.format(
len(new_column_names_tuple),
self.column_names_counted,
), ' <{}>'.format(new_column_names_tuple)
])
else:
raise Err('LconfListOT.replace_column_names()', [
'new_column_names_tuple must be a <tuple> with: <{}> column_names: We got type: <{}>'
.format(new_column_names_tuple, type(new_column_names_tuple)),
' <{}>'.format(new_column_names_tuple)
])
def this_column_values(self, column_name):
""" Returns the items of all rows for the column
:param column_name: (string)
:return: (list) all items of the column for all rows
:raise Err:
"""
if column_name in self.column_names:
idx = self.column_names_idx_lookup[column_name]
return [row[idx] for row in self]
else:
raise Err('LconfListOT.this_column_values()', [
'column_name: <{}> is not a valid one.'.format(column_name),
' Registered names: <{}>'.format(self.column_names)
])
def frompickle(in_pickle_dumps):
""" Create a new `LconfRoot` from a pickled dumps.
:param in_pickle_dumps: (bytes) a pickled `LconfRoot` dumps
:return: (obj) a new LconfRoot object
:raise Err:
"""
new_obj = ploads(in_pickle_dumps)
if new_obj.__class__ is LconfRoot:
return new_obj
else:
raise Err('LconfRoot.frompickle()', [
'Error: `in_pickle_dumps` does not seem to be a `LconfRoot` object: Got type: <{}>'
.format(type(new_obj))
])
def lconf_to_bool(bool_str, extra_err_info):
""" Return `python True or False` for the input bool_str
:param bool_str: (str) must be any of: True, true, False, false
:param extra_err_info: (str) any additional info which will be printed if an error is raised: e.g line number, original
line ect..
:return: (bool) conversion of the input int_str
:raise Err:
"""
if bool_str == 'True' or bool_str == 'true':
return True
elif bool_str == 'False' or bool_str == 'false':
return False
raise Err('bool_str', [
'bool_str must be any of: True, true, False, false. We got: <{}>'.
format(bool_str), ' extra_err_info: {}'.format(extra_err_info)
])
def lconf_to_pathexpanduser(path_str, extra_err_info):
""" Return a path string if it starts with `~` expanduser else return it unchanged
:param path_str: (str) string of a path which must start with `~` or `/`
:param extra_err_info: (str) any additional info which will be printed if an error is raised: e.g line number, original
line ect..
:return: (str) if input starts with `~` expanduser else return it unchanged
:raise Err:
"""
# must start with ~ or /
if path_str[0] == '/' or path_str[0] == '~':
return path_abspath(path_expanduser(path_str))
raise Err('lconf_to_pathexpanduser', [
'path_str must start with <~> or </>. We got: <{}>'.format(
lconf_to_pathexpanduser),
' extra_err_info: {}'.format(extra_err_info)
])
def lconf_to_int(int_str, extra_err_info):
""" Return an integer of the input int_str
:param int_str: (str) string of a number must contain only digits plus optional a leading - (minus sign)
:param extra_err_info: (str) any additional info which will be printed if an error is raised: e.g line number, original
line ect..
:return: (int)conversion of the input int_str
:raise Err:
"""
# check leading -
if int_str[0] == '-':
if int_str[1:].isdigit():
return int(int_str)
elif int_str.isdigit():
return int(int_str)
raise Err('int_str', [
'int_str must contain only digits plus optional a leading - (minus sign). We got: <{}>'
.format(int_str), ' extra_err_info: {}'.format(extra_err_info)
])