gsplot.MetadataSnapshot#

class MetadataSnapshot(package_version, *, schema_version=1, commit=None, config_digest=None, labels=None)#

Bases: object

Immutable, privacy-bounded metadata for one explicit output.

Parameters:

  • package_version (str) – Public package version string.

  • schema_version (Literal[1]) – Supported metadata schema identity, currently integer 1.

  • commit (str | None) – Optional bounded public commit label; no machine path is inferred.

  • config_digest (str | None) – Optional bounded public digest supplied by the caller.

  • labels (collections.abc.Mapping[str, str] | None) – Optional string-to-string public labels, copied and frozen at construction.

Notes

Instances contain only explicitly supplied, bounded values. They never collect environment variables, usernames, hostnames, paths, or files.

Examples

>>> import gsplot as gs
>>> snapshot = gs.MetadataSnapshot(package_version=gs.__version__)
>>> snapshot.schema_version
1
__init__(package_version, *, schema_version=1, commit=None, config_digest=None, labels=None)#
Parameters:

  • package_version (str)

  • schema_version (Literal[1])

  • commit (str | None)

  • config_digest (str | None)

  • labels (Mapping[str, str] | None)

Return type:

None

Methods

__init_subclass__

This method is called when a class is subclassed.

__new__(**kwargs)

__subclasshook__

Abstract classes can override this to customize issubclass().