Skip to content

taps.record

taps/record.py

Record module-attribute 

Record: TypeAlias = Dict[str, Any]

Record type.

RecordLogger

Bases: Protocol

Record logger protocol.

log() 

log(record: Record) -> None

Log a record.

Source code in taps/record.py 
38
39
40
def log(self, record: Record) -> None:
    """Log a record."""
    ...

close() 

close() -> None

Close the logger.

Source code in taps/record.py 
42
43
44
def close(self) -> None:
    """Close the logger."""
    ...

JSONRecordLogger 

JSONRecordLogger(filepath: Path | str)

JSON lines record logger.

Logs records as JSON strings per line to a file.

Parameters:

  • filepath (Path | str) –

    Filepath to log to.

Source code in taps/record.py 
56
57
58
def __init__(self, filepath: pathlib.Path | str) -> None:
    self._filepath = pathlib.Path(filepath)
    self._handle = open(self._filepath, 'a')  # noqa: SIM115

log() 

log(record: Record) -> None

Log a record.

Source code in taps/record.py 
71
72
73
def log(self, record: Record) -> None:
    """Log a record."""
    self._handle.write(json.dumps(record) + '\n')

close() 

close() -> None

Close the logger.

Source code in taps/record.py 
75
76
77
def close(self) -> None:
    """Close the logger."""
    self._handle.close()

NullRecordLogger

Null/no-op record logger.

log() 

log(record: Record) -> None

Log a record.

Source code in taps/record.py 
94
95
96
def log(self, record: Record) -> None:
    """Log a record."""
    return

close() 

close() -> None

Close the logger.

Source code in taps/record.py 
 98
 99
100
def close(self) -> None:
    """Close the logger."""
    return