gnomish_army_knife.database package

Submodules

gnomish_army_knife.database.combat_log module

A module implementing a combat-log state data structure.

class gnomish_army_knife.database.combat_log.CombatLogState(data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]] = None, schemas: SchemaMap = None, dest_attr: str = 'data', verify: bool = True)

Bases: GakDictCodec, BasicDictCodec, LoggerMixin

The top-level configuration object for the package.

property files: dict[str, Any]

Get combat log file data.

init(data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]]) → None

Initialize this instance.

process_event(key: str, event: CombatLogEvent) → None

Process a combat-log event.

process_line(key: str, line: str, log_date: datetime) → None

Process a line from a combat log file.

process_log(path: Path, stop: Event = None) → None

Process a combat log file.

gnomish_army_knife.database.event module

A module implementing interfaces for combat log events.

class gnomish_army_knife.database.event.CombatLogEvent(timestamp: datetime, name: str, data: list[str], line: str)

Bases: NamedTuple

A simple container for combat log events.

as_json() → dict[str, Any]

Create a JSON serializable dictionary from this instance.

data: list[str]

Alias for field number 2

static from_json(data: dict[str, Any]) → CombatLogEvent

Create an event from JSON message data.

static from_line(line: str) → CombatLogEvent

Create an event from a string line.

line: str

Alias for field number 3

log(logger: Logger | LoggerAdapter[Any], level: int = 20) → None

Log this event.

static log_handler(logger: Logger | LoggerAdapter[Any]) → Callable[[CombatLogEvent], None]

Create a simple event handler.

name: str

Alias for field number 1

timestamp: datetime

Alias for field number 0

gnomish_army_knife.database.event.parse_timestamp(data: str) → datetime

Parse a timestamp string from a combat log line.

gnomish_army_knife.database.meta module

A module implementing an arena-match metadata interface.

class gnomish_army_knife.database.meta.ArenaMatchMetadata

Bases: LoggerMixin

A class implementing an arena-match metadata interface.

file_path(base: Path, suffix: str = '.txt') → Path | None

Get a file path this match could be written to. This path should be unique for any match that occurs on live servers.

handle(event: CombatLogEvent) → bool

Attempt to glean new metadata from this event. Returns whether or not the end of a match has been captured.

reset() → None

Reset metadata state.

property summary: str

A summary string for this match.

gnomish_army_knife.database.queue module

A module implementing a simple queue-handler event interface.

class gnomish_army_knife.database.queue.CombatLogQueueHandler

Bases: object

A simple mixin class for handling combat log events via per-event handlers and queue handlers.

handle(event: CombatLogEvent) → None

Handle a combat-log event.

register(queue: Queue[CombatLogEvent]) → int

Register a queue.

registered(queue: Queue[CombatLogEvent]) → Iterator[None]

Register a queue as a managed context.

remove(index: int) → bool

Remove a previously registered queue.

gnomish_army_knife.database.writer module

A module implementing an arena-match file-writing interface.

class gnomish_army_knife.database.writer.ArenaMatchWriter(root: Path | str | None)

Bases: LoggerMixin

A class capable of writing individual arena match events to disk.

async handle(event: CombatLogEvent) → bool

Returns true if the arena-match-writer consumed the event.

Module contents

A module implementing a database interface for the package.

class gnomish_army_knife.database.ArenaMatchDb(stack: ExitStack, root: Path)

Bases: LoggerMixin

A class implementing a top-level program database interface.

property combat_log_state_path: Path

Get the path to the combat-log state data.

create_writer() → ArenaMatchWriter

Create an arena-match writer interface.

data_path(name: str) → Path

Get the path to a data file.

ext = 'json'

property matchdb_path: Path

The path to the matchdb directory.