Input-Output

Dealing with lists and dictionaries and pandas…

Functions

module to deal with lists, dictionaries and pandas

dol: dict of lists
lod: list of dicts
pddf: pandas dataframe

class lists_and_dicts_and_pandas_etc <<(M,#FF7700)>> {
.. functions ..
+ convert_lod_to_dol(list_of_dicts)
+ convert_dol_to_lod(dict_of_lists)
+ convert_lod_to_md_table(list_of_dicts)
+ convert_lod_to_pddf(list_of_dicts)
+ convert_dict_to_quantity_value(dict)
}

streng.common.io.lists_and_dicts_and_pandas_etc.convert_dict_to_quantity_value(dict)[source]
Parameters

dict (dict) – a dictionary

Returns

a list of dicts with quantity-value pairs

Return type

list

streng.common.io.lists_and_dicts_and_pandas_etc.convert_dol_to_lod(dict_of_lists)[source]

converts dict of lists –> list of dicts

streng.common.io.lists_and_dicts_and_pandas_etc.convert_lod_to_dol(list_of_dicts)[source]

converts list of dicts –> dict of lists

streng.common.io.lists_and_dicts_and_pandas_etc.convert_lod_to_md_table(list_of_dicts, table_format='pipe', float_fmt='.3E')[source]
streng.common.io.lists_and_dicts_and_pandas_etc.convert_lod_to_pddf(list_of_dicts)[source]

Converts a list of dictionaries to a pandas dataframe

Parameters

list_of_dicts – a list of dictionaries

Returns

Return type

pandas.DataFrame

Classes

Classes for managing output results

class streng.common.io.output.OutputExtended(outputTables: Dict[str, streng.common.io.output.OutputTable] = <factory>, outputStrings: Dict[str, streng.common.io.output.OutputString] = <factory>)[source]

A class for multiple outputs

class OutputExtended {
.. members ..
+ outputTables: Dict[str, OutputTable] = field(default_factory=dict)
+ outputStrings: Dict[str, OutputString] = field(default_factory=dict)
.. properties ..
+ print_all_outputStrings()
.. methods ..
+ save_tofile_all_outputStrings()
}

outputTables

A dictionary of OutputTables with a string key

Type

dict[str, OutputTable]

outputStrings

A dictionary of OutputStrings with a string key

Type

dict[str, OutputString]

save_tofile_all_outputStrings(pathfilename)[source]
outputStrings: Dict[str, streng.common.io.output.OutputString]
outputTables: Dict[str, streng.common.io.output.OutputTable]
property print_all_outputStrings
class streng.common.io.output.OutputString(data: List[str] = <factory>)[source]

An output given as a list of strings

class OutputString {
.. members ..
+ data: List[str] = field(default_factory=list)
}

data

A list of strings

Type

List[str]

data: List[str]
class streng.common.io.output.OutputTable(data: List[dict] = <factory>)[source]

An output table given as a list of dictionaries.

class OutputTable {
.. members ..
+ data: List[dict] = field(default_factory=list)
.. properties ..
+ to_markdown()
+ to_panda_dataframe()
.. methods ..
+ retrieve()
+ retrieve_column_to_list()
+ to_quantity_value()
}

It can be converted for presentation (or usage) as a pandas dataframe or a markdown table

data

A list of dictionaries

Type

List[dict]

retrieve(search_field, search_value, find_field)[source]
retrieve_column_to_list(column_name)[source]
to_quantity_value(selected_row=0)[source]
data: List[dict]
property to_markdown

Converts data (list of dicts) to a markdown table using tabulate.

Returns

a markdown table

Return type

str

property to_panda_dataframe

Converts data to a pandas dataframe

Returns

a pandas dataframe

Return type

pd.DataFrame

Jupyter Notebooks