saver module¶
Classes for scheduling data saves.
CSVDataSaver class¶
Subclass of DataSaver for saving data with Data.to_csv().
Superclasses
Inherited members
- Cacheable.get_ca_setup()
- Chainable.pipe()
- Configured.copy()
- Configured.equals()
- Configured.get_writeable_attrs()
- Configured.prettify()
- Configured.replace()
- Configured.resolve_merge_kwargs()
- Configured.update_config()
- DataSaver.config
- DataSaver.data
- DataSaver.init_save_kwargs
- DataSaver.rec_state
- DataSaver.save_kwargs
- DataSaver.schedule_manager
- DataSaver.update()
- DataSaver.update_every()
- DataSaver.update_kwargs
- HasSettings.get_path_setting()
- HasSettings.get_path_settings()
- HasSettings.get_setting()
- HasSettings.get_settings()
- HasSettings.has_path_setting()
- HasSettings.has_path_settings()
- HasSettings.has_setting()
- HasSettings.has_settings()
- HasSettings.reset_settings()
- HasSettings.resolve_setting()
- HasSettings.resolve_settings_paths()
- HasSettings.set_settings()
- Pickleable.decode_config()
- Pickleable.decode_config_node()
- Pickleable.dumps()
- Pickleable.encode_config()
- Pickleable.encode_config_node()
- Pickleable.file_exists()
- Pickleable.getsize()
- Pickleable.load()
- Pickleable.loads()
- Pickleable.modify_state()
- Pickleable.resolve_file_path()
- Pickleable.save()
init_save_data method¶
Save initial data.
save_data method¶
Save data.
By default, appends new data without header.
DataSaver class¶
Base class for scheduling data saves.
Subclasses DataUpdater.
Args
data:Data- Data instance.
save_kwargs:dict- Default keyword arguments for DataSaver.init_save_data() and DataSaver.save_data().
init_save_kwargs:dict- Default keyword arguments overriding
save_kwargsfor DataSaver.init_save_data(). **kwargs- Keyword arguments passed to the constructor of
DataUpdater.
Superclasses
Inherited members
- Cacheable.get_ca_setup()
- Chainable.pipe()
- Configured.copy()
- Configured.equals()
- Configured.get_writeable_attrs()
- Configured.prettify()
- Configured.replace()
- Configured.resolve_merge_kwargs()
- Configured.update_config()
- DataUpdater.config
- DataUpdater.data
- DataUpdater.rec_state
- DataUpdater.schedule_manager
- DataUpdater.update_kwargs
- HasSettings.get_path_setting()
- HasSettings.get_path_settings()
- HasSettings.get_setting()
- HasSettings.get_settings()
- HasSettings.has_path_setting()
- HasSettings.has_path_settings()
- HasSettings.has_setting()
- HasSettings.has_settings()
- HasSettings.reset_settings()
- HasSettings.resolve_setting()
- HasSettings.resolve_settings_paths()
- HasSettings.set_settings()
- Pickleable.decode_config()
- Pickleable.decode_config_node()
- Pickleable.dumps()
- Pickleable.encode_config()
- Pickleable.encode_config_node()
- Pickleable.file_exists()
- Pickleable.getsize()
- Pickleable.load()
- Pickleable.loads()
- Pickleable.modify_state()
- Pickleable.resolve_file_path()
- Pickleable.save()
Subclasses
init_save_data method¶
Save initial data.
This is an abstract method - override it to define custom logic.
init_save_kwargs property¶
Keyword arguments passed to DataSaver.init_save_data().
save_data method¶
Save data.
This is an abstract method - override it to define custom logic.
save_kwargs property¶
Keyword arguments passed to DataSaver.save_data().
update method¶
Update and save data using DataSaver.save_data().
Override to do pre- and postprocessing.
To stop this method from running again, raise CancelledError.
update_every method¶
Overrides DataUpdater to save initial data prior to updating.
DuckDBDataSaver class¶
Subclass of DataSaver for saving data with Data.to_duckdb().
Superclasses
Inherited members
- Cacheable.get_ca_setup()
- Chainable.pipe()
- Configured.copy()
- Configured.equals()
- Configured.get_writeable_attrs()
- Configured.prettify()
- Configured.replace()
- Configured.resolve_merge_kwargs()
- Configured.update_config()
- DataSaver.config
- DataSaver.data
- DataSaver.init_save_kwargs
- DataSaver.rec_state
- DataSaver.save_kwargs
- DataSaver.schedule_manager
- DataSaver.update()
- DataSaver.update_every()
- DataSaver.update_kwargs
- HasSettings.get_path_setting()
- HasSettings.get_path_settings()
- HasSettings.get_setting()
- HasSettings.get_settings()
- HasSettings.has_path_setting()
- HasSettings.has_path_settings()
- HasSettings.has_setting()
- HasSettings.has_settings()
- HasSettings.reset_settings()
- HasSettings.resolve_setting()
- HasSettings.resolve_settings_paths()
- HasSettings.set_settings()
- Pickleable.decode_config()
- Pickleable.decode_config_node()
- Pickleable.dumps()
- Pickleable.encode_config()
- Pickleable.encode_config_node()
- Pickleable.file_exists()
- Pickleable.getsize()
- Pickleable.load()
- Pickleable.loads()
- Pickleable.modify_state()
- Pickleable.resolve_file_path()
- Pickleable.save()
init_save_data method¶
Save initial data.
save_data method¶
Save data.
By default, appends new data without header.
HDFDataSaver class¶
Subclass of DataSaver for saving data with Data.to_hdf().
Superclasses
Inherited members
- Cacheable.get_ca_setup()
- Chainable.pipe()
- Configured.copy()
- Configured.equals()
- Configured.get_writeable_attrs()
- Configured.prettify()
- Configured.replace()
- Configured.resolve_merge_kwargs()
- Configured.update_config()
- DataSaver.config
- DataSaver.data
- DataSaver.init_save_kwargs
- DataSaver.rec_state
- DataSaver.save_kwargs
- DataSaver.schedule_manager
- DataSaver.update()
- DataSaver.update_every()
- DataSaver.update_kwargs
- HasSettings.get_path_setting()
- HasSettings.get_path_settings()
- HasSettings.get_setting()
- HasSettings.get_settings()
- HasSettings.has_path_setting()
- HasSettings.has_path_settings()
- HasSettings.has_setting()
- HasSettings.has_settings()
- HasSettings.reset_settings()
- HasSettings.resolve_setting()
- HasSettings.resolve_settings_paths()
- HasSettings.set_settings()
- Pickleable.decode_config()
- Pickleable.decode_config_node()
- Pickleable.dumps()
- Pickleable.encode_config()
- Pickleable.encode_config_node()
- Pickleable.file_exists()
- Pickleable.getsize()
- Pickleable.load()
- Pickleable.loads()
- Pickleable.modify_state()
- Pickleable.resolve_file_path()
- Pickleable.save()
init_save_data method¶
Save initial data.
save_data method¶
Save data.
By default, appends new data in a table format.
SQLDataSaver class¶
Subclass of DataSaver for saving data with Data.to_sql().
Superclasses
Inherited members
- Cacheable.get_ca_setup()
- Chainable.pipe()
- Configured.copy()
- Configured.equals()
- Configured.get_writeable_attrs()
- Configured.prettify()
- Configured.replace()
- Configured.resolve_merge_kwargs()
- Configured.update_config()
- DataSaver.config
- DataSaver.data
- DataSaver.init_save_kwargs
- DataSaver.rec_state
- DataSaver.save_kwargs
- DataSaver.schedule_manager
- DataSaver.update()
- DataSaver.update_every()
- DataSaver.update_kwargs
- HasSettings.get_path_setting()
- HasSettings.get_path_settings()
- HasSettings.get_setting()
- HasSettings.get_settings()
- HasSettings.has_path_setting()
- HasSettings.has_path_settings()
- HasSettings.has_setting()
- HasSettings.has_settings()
- HasSettings.reset_settings()
- HasSettings.resolve_setting()
- HasSettings.resolve_settings_paths()
- HasSettings.set_settings()
- Pickleable.decode_config()
- Pickleable.decode_config_node()
- Pickleable.dumps()
- Pickleable.encode_config()
- Pickleable.encode_config_node()
- Pickleable.file_exists()
- Pickleable.getsize()
- Pickleable.load()
- Pickleable.loads()
- Pickleable.modify_state()
- Pickleable.resolve_file_path()
- Pickleable.save()
init_save_data method¶
Save initial data.
save_data method¶
Save data.
By default, appends new data without header.