The pyedb.generic.data_handlers library

Summary

Functions

format_decimals	Parameters:
random_string	Generate a random string
unique_string_list	Return a unique list of strings from an element list.
string_list	Parameters:
ensure_list	Parameters:
from_rkm	Convert an RKM code string to a string with a decimal point.
str_to_bool	Convert a "True" or "False" string to its corresponding Boolean value.
float_units	Retrieve units for a value.
json_to_dict	Load Json File to a dictionary.

Attributes

unit_val

Module detail

data_handlers.format_decimals(el)

Parameters:

el

Returns:

data_handlers.random_string(length=6, only_digits=False, char_set=None)

Generate a random string

Parameters:

length

length of the random string (Default value = 6)

only_digitsbool, optional

True if only digits are to be included.

char_setstr, optional

Custom character set to pick the characters from. By default chooses from ASCII and digit characters or just digits if only_digits is True.

Returns:

type

random string

data_handlers.unique_string_list(element_list, only_string=True)

Return a unique list of strings from an element list.

Parameters:

element_list

only_string

(Default value = True)

Returns:

data_handlers.string_list(element_list)

Parameters:

element_list

Returns:

data_handlers.ensure_list(element_list)

Parameters:

element_list

Returns:

data_handlers.from_rkm(code)

Convert an RKM code string to a string with a decimal point.

Parameters:

codestr

RKM code string.

Returns:

str

String with a decimal point and an R value.

Examples

>>> from_rkm("R47")
'0.47'

>>> from_rkm("4R7")
'4.7'

>>> from_rkm("470R")
'470'

>>> from_rkm("4K7")
'4.7k'

>>> from_rkm("47K")
'47k'

>>> from_rkm("47K3")
'47.3k'

>>> from_rkm("470K")
'470k'

>>> from_rkm("4M7")
'4.7M'

data_handlers.str_to_bool(s)

Convert a "True" or "False" string to its corresponding Boolean value.

If the passed arguments are not relevant in the context of conversion, the argument itself is returned. This method can be called using the map() function to ensure conversion of Boolean strings in a list.

Parameters:

s: str

Returns:

bool or str

The method is not case-sensitive. - True is returned if the input is "true", "1",

“yes”`, or "y",

• False is returned if the input is "false", "no", "n, or "0".

• Otherwise, the input value is passed through the method unchanged.

data_handlers.float_units(val_str, units='')

Retrieve units for a value.

Parameters:

val_strstr

Name of the float value.

unitsstr, optional

The default is "".

Returns:

data_handlers.json_to_dict(fn)

Load Json File to a dictionary.

Parameters:

fnstr

json file full path.

Returns:

dict

data_handlers.unit_val