mypy.metastore.MetadataStore

class documentation

class MetadataStore: (source)

Known subclasses: mypy.metastore.FilesystemMetadataStore, mypy.metastore.SqliteMetadataStore

View In Hierarchy

Generic interface for metadata storage.

Method commit If the backing store requires a commit, do it.
Method getmtime Read the mtime of a metadata entry..
Method list_all Undocumented
Method read Read the contents of a metadata entry.
Method remove Delete a metadata entry
Method write Write a metadata entry.
@abstractmethod
def commit(self): (source)
overridden in mypy.metastore.FilesystemMetadataStore, mypy.metastore.SqliteMetadataStore

If the backing store requires a commit, do it. But N.B. that this is not *guaranteed* to do anything, and there is no guarantee that changes are not made until it is called.

@abstractmethod
def getmtime(self, name: str) -> float: (source)
overridden in mypy.metastore.FilesystemMetadataStore, mypy.metastore.SqliteMetadataStore

Read the mtime of a metadata entry.. Raises FileNotFound if the entry does not exist.

@abstractmethod
def list_all(self) -> Iterable[str]: (source)
overridden in mypy.metastore.FilesystemMetadataStore, mypy.metastore.SqliteMetadataStore

Undocumented

@abstractmethod
def read(self, name: str) -> str: (source)
overridden in mypy.metastore.FilesystemMetadataStore, mypy.metastore.SqliteMetadataStore

Read the contents of a metadata entry. Raises FileNotFound if the entry does not exist.

@abstractmethod
def remove(self, name: str): (source)
overridden in mypy.metastore.FilesystemMetadataStore, mypy.metastore.SqliteMetadataStore

Delete a metadata entry

@abstractmethod
def write(self, name: str, data: str, mtime: float|None = None) -> bool: (source)
overridden in mypy.metastore.FilesystemMetadataStore, mypy.metastore.SqliteMetadataStore

Write a metadata entry. If mtime is specified, set it as the mtime of the entry. Otherwise, the current time is used. Returns True if the entry is successfully written, False otherwise.