Module `macrobond_data_api.common.types.revision_info`

Browse git

Classes

class RevisionInfo

Information about revisions of a time series.

Browse git

Instance variables

var error_message : str: Contains an error message in case of an error.

Browse git
var has_revisions : bool: Returns True if any revisions have been stored for this series.

Browse git
var name : str: The name of the series

Browse git
var stores_revisions : bool: Returns True if revision history is stored for this series.

Browse git
var time_stamp_of_first_revision : datetime.datetime | None: The timestamp of the first stored revision.

Browse git
var time_stamp_of_last_revision : datetime.datetime | None: The timestamps of the last strored revision.

Browse git
var vintage_time_stamps : Sequence[datetime.datetime]: A tuple with the timestams of all stored revisions in time order with the oldest first.

Browse git

Methods

def to_dict(self) ‑> RevisionInfoDict: Returns a dictionary with the information of the series revisions.

Browse git
def to_pd_data_frame(self) ‑> DataFrame: Returns a Pandas dataframe with the information about the series revisions.

Browse git

class RevisionInfoDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Browse git

Ancestors

builtins.dict

Class variables

var error_message : str
var has_revisions : bool
var name : str
var stores_revisions : bool
var time_stamp_of_first_revision : datetime.datetime | None
var time_stamp_of_last_revision : datetime.datetime | None
var vintage_time_stamps : Sequence[datetime.datetime]