collection

Module Contents

class DataStruct_Interface[source]
abstract save(self, filename)[source]

Save the datastructure to filename

abstract static load(filename, **kwargs)[source]

Load the datastructure from filename

get_info(self)[source]

Get simple string describing the datastructure

set_info(self, info)[source]

Set simple string describing the datastructure

static get_extension()[source]

File extension used for datastructure

__str__(self)[source]
class AutosaveStruct(dataStruct, filename='', change_filename_if_exists=True)[source]

Structure that provides automated save of DataStructures

__str__(self)[source]
get_filename(self)[source]

Get set filename

set_filename(self, filename, change_filename_if_exists)[source]
Parameters
  • filename – Filename to set

  • change_filename_if_exists – If already exists, create a new filename

stop_autosave(self)[source]

Stop autosave

start_autosave(self, timer_autosave)[source]

Start autosave

save(self, safe_save=True)[source]

Save

get_datastruct(self)[source]

Return :class:’~DataStruct_Interface’

__getstate__(self)[source]
__setstate__(self, state)[source]
class ListDataStruct(compress_save=False)[source]

Bases: optimeed.core.collection.DataStruct_Interface

_INFO_STR = info
_DATA_STR = data
_COMPRESS_SAVE_STR = module_tree
save(self, filename)[source]

Save data using json format. The data to be saved are automatically detected, see obj_to_json()

_format_str_save(self)[source]

Save data using json format. The data to be saved are automatically detected, see obj_to_json()

static load(filename, theClass=None)[source]

Load the file filename.

Parameters
  • filename – file to load

  • theClass – optional. Can be used to fix unpickling errors.

Returns

self-like object

static _jsondata_to_obj(item, theClass=None)[source]
add_data(self, data_in)[source]

Add a data to the list

get_data(self)[source]

Get full list of datas

set_data(self, theData)[source]

Set full list of datas

set_data_at_index(self, data_in, index)[source]

Replace data at specific index

set_attribute_data(self, the_attribute, the_value)[source]

Set attribute to all data

set_attribute_equation(self, attribute_name, equation_str)[source]

Advanced method to set the value of attribute_name from equation_str

Parameters
  • attribute_name – string (name of the attribute to set)

  • equation_str – formatted equation, check applyEquation()

Returns

get_list_attributes(self, attributeName)[source]

Get the value of attributeName of all the data in the Collection

Parameters

attributeName – string (name of the attribute to get)

Returns

list

delete_points_at_indices(self, indices)[source]

Delete several elements from the Collection

Parameters

indices – list of indices to delete

export_xls(self, excelFilename, excelsheet='Sheet1', mode='w')[source]

Export the collection to excel. It only exports the direct attributes.

Parameters
  • excelFilename – filename of the excel

  • excelsheet – name of the sheet

  • mode – ‘w’ to erase existing file, ‘a’ to append sheetname to existing file

merge(self, collection)[source]

Merge a collection with the current collection

Parameters

collectionCollection to merge