openflexure_microscope_server.things.timelapse.TimelapseGalleryDBEngine

class documentation

class TimelapseGalleryDBEngine(OFMGalleryDBEngine): (source)

The database engine to back gallery interactions for timelapse.

Method	`data_path_for`	Return the full datafile path for a given timelapse directory path.
Class Variable	`card_type`	Undocumented
Method	`_create_viewer_data`	Create the viewer data for the GalleryEntryModel.
Method	`_delete_endpoint`	Return the endpoint for deleting an entry (relative to the base URL).
Method	`_download_buttons`	Create the download buttons for the timelapse.
Method	`_generate_entry`	Create a GalleryEntry for an item based on the data on disk.
Method	`_hash`	Create a unique hash for a timelapse, by hashing the JSON file.
Method	`_list_all_items_on_file_system`	List all the timelapses in this Thing's data directory.

Method	`__init__`	Initialise the database engine.
Method	`add`	Add an item to the gallery database.
Method	`delete`	Delete an item from the gallery database.
Method	`dispose`	Dispose of the active connections for this database engine.
Method	`entry_to_base_model`	Convert GalleryEntry to GalleryEntryModel.
Method	`fullpath_to_normpath`	Convert the abs native path to the relative posix path for the database.
Method	`get`	Get a single item from the gallery database.
Method	`get_all_entries`	Get a list of all Gallery Entries.
Method	`get_all_entries_as_base_model`	Get a list of entries as a base model for the API.
Method	`get_all_paths`	Get a list of the paths for all gallery items.
Method	`normpath_to_fullpath`	Convert the relative posix path from the database to the abs native path.
Method	`rebuild`	Rebuild a single gallery entry as it has changed on disk.
Method	`session`	Yield a database session. Commit on completion, rollback on error.
Method	`sync_db_with_file_system`	Sync the database with the file system.
Class Variable	`gallery_info_model`	Undocumented
Method	`_card_actions`	Create the action buttons for this entry's card.
Method	`_card_messages`	Create the messages for this entry's card.
Method	`_mounted_path`	Return the mount point for the normalised path.
Instance Variable	`_data_dir`	Undocumented
Instance Variable	`_engine`	Undocumented
Instance Variable	`_thing`	Undocumented

def data_path_for(self, path: str) -> str: (source) ¶

Return the full datafile path for a given timelapse directory path.

Parameters
path:`str`	The relative path for the directory (primary key).

Returns
`str`	The timelapse datafile path.

overrides openflexure_microscope_server.gallery_db.OFMGalleryDBEngine.card_type

Undocumented

def _create_viewer_data(self, entry: GalleryEntry) -> DirectoryViewerData | None: (source) ¶

overrides openflexure_microscope_server.gallery_db.OFMGalleryDBEngine._create_viewer_data

Create the viewer data for the GalleryEntryModel.

Parameters
entry:`GalleryEntry`	The GalleryEntry from the database for this item.

Returns
`DirectoryViewerData \| None`	Undocumented

def _delete_endpoint(self, path: str) -> str: (source) ¶

overrides openflexure_microscope_server.gallery_db.OFMGalleryDBEngine._delete_endpoint

Return the endpoint for deleting an entry (relative to the base URL).

Parameters
path:`str`	The normalised relative posixpath for the item. This is the primary key of the GalleryEntry table.

Returns
`str`	Undocumented

def _download_buttons(self, entry: GalleryEntry) -> list[ui.DownloadButton]: (source) ¶

overrides openflexure_microscope_server.gallery_db.OFMGalleryDBEngine._download_buttons

Create the download buttons for the timelapse.

def _generate_entry(self, path: str, gallery_added_data: dict | None = None) -> GalleryEntry: (source) ¶

overrides openflexure_microscope_server.gallery_db.OFMGalleryDBEngine._generate_entry

Create a GalleryEntry for an item based on the data on disk.

Parameters
path:`str`	The normalised relative posixpath for the item. This is the primary key of the GalleryEntry table.
gallery_added_data:`dict \| None`	Any data added by the gallery. This can be used to persist gallery added data even if item is modified on disk.

Returns
`GalleryEntry`	A GalleryEntry for the item.

def _hash(self, path: str) -> str: (source) ¶

overrides openflexure_microscope_server.gallery_db.OFMGalleryDBEngine._hash

Create a unique hash for a timelapse, by hashing the JSON file.

This hashing function may update once timelapse can process files into a GIF or video.

Parameters
path:`str`	The normalised relative posixpath for the item to hash, in this case, the timelapse directory. This is the primary key of the GalleryEntry table.

Returns
`str`	A unique identifier to check if the item has changed.

def _list_all_items_on_file_system(self) -> list[str]: (source) ¶

overrides openflexure_microscope_server.gallery_db.OFMGalleryDBEngine._list_all_items_on_file_system

List all the timelapses in this Thing's data directory.

Returns
`list[str]`	A list of paths.