DataStoreDirectory#
- class DataStoreDirectory(*args, **kwargs)#
- Attributes
- completed
- describe
- limit
- logs
- members
mode
string that references datastore mode, override in subclass constructor
- not_completed
source
string that references the data store, override in subclass constructor
summary_logs
returns a table summarising log files
summary_not_completed
returns a table summarising not completed results
Methods
md5
(unique_id)- Parameters
read
(unique_id)reads data corresponding to identifier
write
(*, unique_id, data)writes a completed record ending with .suffix
write_not_completed
(*, unique_id, data)writes a not completed record as json
drop_not_completed
validate
write_log
- property completed: list[cogent3.app.data_store.DataMember]#
- property describe: cogent3.app.typing.TabularType#
- drop_not_completed(*, unique_id: str = '') None #
- property limit#
- property logs: list[cogent3.app.data_store.DataMember]#
- md5(unique_id: str) Optional[str] #
- Parameters
- unique_id
name of data store member
- Returns
- md5 checksum for the member, if available, None otherwise
- property members: list[cogent3.app.data_store.DataMemberABC]#
- property mode: cogent3.app.data_store.Mode#
string that references datastore mode, override in subclass constructor
- property not_completed: list[cogent3.app.data_store.DataMember]#
- read(unique_id: str) str #
reads data corresponding to identifier
- property source: str | pathlib.Path#
string that references the data store, override in subclass constructor
- property summary_logs: cogent3.app.typing.TabularType#
returns a table summarising log files
- property summary_not_completed: cogent3.app.typing.TabularType#
returns a table summarising not completed results
- validate() cogent3.app.typing.TabularType #
- write(*, unique_id: str, data: str) cogent3.app.data_store.DataMember #
writes a completed record ending with .suffix
- Parameters
- unique_id
unique identifier
- data
text data to be written
- Returns
- a member for this record
Notes
Drops any not-completed member corresponding to this identifier
- write_log(*, unique_id: str, data: str) None #
- write_not_completed(*, unique_id: str, data: str) cogent3.app.data_store.DataMember #
writes a not completed record as json
- Parameters
- unique_id
unique identifier
- data
text data to be written
- Returns
- a member for this record