edges_analysis.gsdata.history.Stamp

class edges_analysis.gsdata.history.Stamp(message: str = '', function: str = '', parameters: dict = _Nothing.NOTHING, versions: dict = _Nothing.NOTHING, timestamp: datetime = _Nothing.NOTHING)[source]

Class representing a historical record of a process applying to an object.

Parameters:

  • message (str) – A message describing the process. Optional – either this or the function must be defined.

  • function (str) – The name of the function that was applied. Optional – either this or the message must be defined.

  • parameter(s) – The parameters passed to the function. Optional – if function is defined, this should be specified.

  • versions (dict) – A dictionary of the versions of the software used to perform the process. Created by default when the History is created.

  • timestamp (datetime.datetime) – A datetime object corresponding to the time the process was performed. By default, this is set to the time that the Stamp object is created.

Methods

__init__([message, function, parameters, ...])

Method generated by attrs for class Stamp.

from_repr(repr_string)

Create a Stamp object from a string representation.

from_yaml_dict(d)

Create a Stamp object from a dictionary representing a history record.

pretty()

Return a rich-compatible string representation of the history record.

Attributes

message

function

parameters

versions

timestamp