Source code for punchbowl.data.history
from __future__ import annotations
from datetime import UTC, datetime
from collections import namedtuple
from astropy.io.fits import Header
from dateutil.parser import parse as parse_datetime
HistoryEntry = namedtuple("HistoryEntry", "datetime, source, comment")
[docs]
class History:
"""Representation of the history of edits done to a PUNCH data object."""
def __init__(self) -> None:
"""Create blank history."""
self._entries: list[HistoryEntry] = []
[docs]
def add_entry(self, entry: HistoryEntry) -> None:
"""
Add an entry to the History log.
Parameters
----------
entry : HistoryEntry
A HistoryEntry object to add to the History log
Returns
-------
None
"""
self._entries.append(entry)
[docs]
def add_now(self, source: str, comment: str) -> None:
"""
Add a new history entry at the current time.
Parameters
----------
source : str
what module of the code the history entry originates from
comment : str
a note of what the history comment means
Returns
-------
None
"""
self._entries.append(HistoryEntry(datetime.now(UTC), source, comment))
[docs]
def clear(self) -> None:
"""
Clear all the history entries so the History is blank.
Returns
-------
None
"""
self._entries = []
[docs]
def clear_entries_from_source(self, source: str) -> None:
"""Clear all history entries from a given source."""
self._entries = [entry for entry in self._entries if entry.source != source]
[docs]
def __getitem__(self, index: int) -> HistoryEntry:
"""
Given an index, return the requested HistoryEntry.
Parameters
----------
index : int
numerical index of the history entry, increasing number typically indicates an older entry
Returns
-------
HistoryEntry
history at specified `index`
"""
return self._entries[index]
[docs]
def most_recent(self) -> HistoryEntry:
"""
Get the most recent HistoryEntry, i.e. the youngest.
Returns
-------
HistoryEntry
returns HistoryEntry that is the youngest
"""
return self._entries[-1]
[docs]
def __len__(self) -> int:
"""Get length."""
return len(self._entries)
[docs]
def __str__(self) -> str:
"""
Format a string combining all the history entries.
Returns
-------
str
a combined record of the history entries
"""
return "\n".join([f"{e.datetime:%Y-%m-%dT%H:%M:%S} => {e.source} => {e.comment}|" for e in self._entries])
[docs]
def __iter__(self) -> History:
"""Iterate."""
self.current_index = 0
return self
[docs]
def __hash__(self) -> int:
"""Hash a history object."""
return sum([hash(e) for e in self._entries])
[docs]
def __next__(self) -> HistoryEntry:
"""Get next."""
if self.current_index >= len(self):
raise StopIteration
entry = self._entries[self.current_index]
self.current_index += 1
return entry
[docs]
def __eq__(self, other: History) -> bool:
"""Check equality of two History objects."""
if not isinstance(other, History):
msg = f"Can only check equality between two history objects, found History and {type(other)}"
raise TypeError(msg)
return self._entries == other._entries
