Skip to content

Base Types

The plainlog._base module defines the foundational types used throughout the library.

Type Aliases

Alias Description
Msg Log message content — accepts any type.
Record A log record — a plain Python dict.
level Log level — a plain int (e.g. 10, 20, 30). The human-readable name is stored as level_name on each record.
UniversalProcessorProtocol Union of ProcessorProtocol and ProcessorCloseProtocol — a processor with or without a close() method.

API Reference

RecordException

Bases: NamedTuple

Pickle-safe exception info attached to log records.

Attributes:

Name Type Description
type Optional[type[BaseException]]

The exception class, or None.
value Optional[BaseException]

The exception instance, or None.
traceback Optional[TracebackType]

The traceback object, or None. Stripped during pickling.

ProcessorProtocol

Bases: Protocol

ProcessorCloseProtocol

Bases: ProcessorProtocol, Protocol

UniversalProcessorProtocol

Record Keys

Core keys:

  • level
  • level_name
  • msg
  • name
  • created
  • process_id
  • process_name
  • exception

Additional keys added by plainlog features:

  • exc_info
  • caller_info
  • function
  • line
  • path
  • module
  • file_name
  • file_path
  • thread_id
  • thread_name

Additional user-supplied fields are also stored directly on the record.