gnomish_army_knife package

Subpackages

• gnomish_army_knife.commands package
  • Submodules
  • gnomish_army_knife.commands.all module
    • commands()
  • gnomish_army_knife.commands.markdown module
    • add_markdown_cmd()
    • markdown_cmd()
  • gnomish_army_knife.commands.scan module
    • add_scan_cmd()
    • scan_cmd()
  • Module contents
• gnomish_army_knife.config package
  • Module contents
    • Config
• gnomish_army_knife.database package
  • Submodules
  • gnomish_army_knife.database.combat_log module
    • CombatLogState
      • CombatLogState.files
      • CombatLogState.init()
      • CombatLogState.process_event()
      • CombatLogState.process_line()
      • CombatLogState.process_log()
  • gnomish_army_knife.database.event module
    • CombatLogEvent
      • CombatLogEvent.as_json()
      • CombatLogEvent.data
      • CombatLogEvent.from_json()
      • CombatLogEvent.from_line()
      • CombatLogEvent.line
      • CombatLogEvent.log()
      • CombatLogEvent.log_handler()
      • CombatLogEvent.name
      • CombatLogEvent.timestamp
    • parse_timestamp()
  • gnomish_army_knife.database.meta module
    • ArenaMatchMetadata
      • ArenaMatchMetadata.file_path()
      • ArenaMatchMetadata.handle()
      • ArenaMatchMetadata.reset()
      • ArenaMatchMetadata.summary
  • gnomish_army_knife.database.queue module
    • CombatLogQueueHandler
      • CombatLogQueueHandler.handle()
      • CombatLogQueueHandler.register()
      • CombatLogQueueHandler.registered()
      • CombatLogQueueHandler.remove()
  • gnomish_army_knife.database.writer module
    • ArenaMatchWriter
      • ArenaMatchWriter.handle()
  • Module contents
    • ArenaMatchDb
      • ArenaMatchDb.combat_log_state_path
      • ArenaMatchDb.create_writer()
      • ArenaMatchDb.data_path()
      • ArenaMatchDb.ext
      • ArenaMatchDb.matchdb_path
• gnomish_army_knife.enums package
  • Submodules
  • gnomish_army_knife.enums.events module
    • LogEvent
      • LogEvent.COMBATANT_INFO
      • LogEvent.MATCH_END
      • LogEvent.MATCH_START
      • LogEvent.ZONE_CHANGE
  • Module contents
• gnomish_army_knife.icon package
  • Module contents
    • icon_url()
• gnomish_army_knife.macro package
  • Submodules
  • gnomish_army_knife.macro.category module
    • MacroCategory
      • MacroCategory.init()
      • MacroCategory.write_markdown_dir()
  • gnomish_army_knife.macro.database module
    • MacroDatabase
      • MacroDatabase.init()
      • MacroDatabase.load()
      • MacroDatabase.write_markdown_dir()
  • gnomish_army_knife.macro.group module
    • MacroGroup
      • MacroGroup.init()
      • MacroGroup.write_markdown()
  • Module contents
    • Macro
      • Macro.init()
      • Macro.short_markdown
• gnomish_army_knife.markdown package
  • Module contents
• gnomish_army_knife.net package
  • Submodules
  • gnomish_army_knife.net.connection module
    • CombatLogEventConnection
      • CombatLogEventConnection.default_auto_restart
      • CombatLogEventConnection.event_handler()
      • CombatLogEventConnection.forward_handler()
      • CombatLogEventConnection.init()
      • CombatLogEventConnection.queue
      • CombatLogEventConnection.watch_names
  • gnomish_army_knife.net.task module
    • LogServerTask
      • LogServerTask.dispatch()
      • LogServerTask.eloop
      • LogServerTask.init()
      • LogServerTask.log_file_reader_main()
      • LogServerTask.log_file_reader_thread
      • LogServerTask.once
      • LogServerTask.queue
      • LogServerTask.queue_saturated
      • LogServerTask.stop_extra()
      • LogServerTask.stop_reading_log
  • gnomish_army_knife.net.writer module
    • LogWriterTask
      • LogWriterTask.dispatch()
      • LogWriterTask.init()
      • LogWriterTask.writers
  • Module contents
    • CombatLogEventConnection
      • CombatLogEventConnection.default_auto_restart
      • CombatLogEventConnection.event_handler()
      • CombatLogEventConnection.forward_handler()
      • CombatLogEventConnection.init()
      • CombatLogEventConnection.queue
      • CombatLogEventConnection.watch_names
    • LogServer
      • LogServer.kind
    • LogWriter
      • LogWriter.kind
    • TcpCombatLogEvent
      • TcpCombatLogEvent.kind
    • TcpCombatLogEventConnection
    • WebsocketCombatLogEvent
      • WebsocketCombatLogEvent.kind
    • WebsocketCombatLogEventConnection
• gnomish_army_knife.paths package
  • Module contents
    • combat_log_datetime()
    • combat_log_slug()
    • path_is_combat_log()
    • wow_dir()
• gnomish_army_knife.runtime package
  • Submodules
  • gnomish_army_knife.runtime.task module
    • GakRuntimeTask
      • GakRuntimeTask.auto_finalize
      • GakRuntimeTask.event_count
      • GakRuntimeTask.init()
      • GakRuntimeTask.runtime
  • Module contents
    • GakRuntime
      • GakRuntime.cli_args()
      • GakRuntime.combat_logs
      • GakRuntime.create()
      • GakRuntime.latest_combat_log()
      • GakRuntime.retail
• gnomish_army_knife.runtimepy package
  • Module contents
    • peer_finish_then_copy()
    • send_all_events()

Submodules

gnomish_army_knife.app module

This package’s command-line entry-point application.

gnomish_army_knife.app.add_app_args(parser: ArgumentParser) → None

Add application-specific arguments to the command-line parser.

gnomish_army_knife.app.entry(args: Namespace) → int

Execute the requested task.

gnomish_army_knife.entry module

This package’s command-line entry-point (boilerplate).

gnomish_army_knife.entry.main(argv: list[str] = None) → int

Program entry-point.

gnomish_army_knife.schemas module

A module for working with schemas belonging to this package.

class gnomish_army_knife.schemas.BasicGakCodec(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

A base class for schema-backed objects.

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

Perform implementation-specific initialization.

property markdown_footer: Iterator[str]

A simple footer.

static to_slug(data: str) → str

Convert a string to a slug.

class gnomish_army_knife.schemas.GakDictCodec(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: DictCodec, MarkdownMixin

A simple wrapper for package classes that want to implement DictCodec.

default_schemas: SchemaMap | None = {'is_object': <vcorelib.schemas.json.JsonSchema object>, 'CombatLogFile': <vcorelib.schemas.json.JsonSchema object>, 'Config': <vcorelib.schemas.json.JsonSchema object>, 'MacroCategory': <vcorelib.schemas.json.JsonSchema object>, 'has_icon': <vcorelib.schemas.json.JsonSchema object>, 'MacroDatabase': <vcorelib.schemas.json.JsonSchema object>, 'Macro': <vcorelib.schemas.json.JsonSchema object>, 'CombatLogState': <vcorelib.schemas.json.JsonSchema object>, 'MacroGroup': <vcorelib.schemas.json.JsonSchema object>, 'has_macros': <vcorelib.schemas.json.JsonSchema object>}

Module contents

Useful defaults and other package metadata.