AutoTransform

Documents

  • Overview
  • Components
  • Best Practices
  • Scheduled Runs
  • Managing Changes
  • Extending For Your Organization
  • Contributing To AutoTransform

Code

  • AutoTransform (autotransform)
    • Core
      • Schema Package (autotransform.schema)
      • Scripts (autotransform.scripts)
      • Config Package (autotransform.config)
      • Runner Package (autotransform.runner)
      • Item Package (autotransform.item)
      • Change Package (autotransform.change)
      • Step Package (autotransform.step)
      • Event Package (autotransform.event)
        • EventHandler (autotransform.event.handler)
        • EventNotifier (autotransform.event.notifier.base)
        • ConsoleEventNotifier (autotransform.event.notifier.console)
        • Event (autotransform.event.base)
        • LoggingLevel (autotransform.event.logginglevel)
        • EventType (autotransform.event.type)
        • Batch Related Events (autotransform.event.batch)
        • DebugEvent (autotransform.event.debug)
        • Github Related Events (autotransform.event.github)
        • Management related events (autotransform.event.manage)
        • AI Model Related Events (autotransform.event.model)
        • RunEvent (autotransform.event.run)
        • Runner Related Events (autotransform.event.runner)
        • ScheduleRunEvent (autotransform.event.schedulerun)
        • Script Related Events (autotransform.event.script)
        • Util Related Events (autotransform.event.util)
        • DebugEvent (autotransform.event.debug)
        • WarningEvent (autotransform.event.warning)
      • Utilities (autotransform.util)
      • Model Package (autotransform.model)
    • Schema Components
AutoTransform
  • AutoTransform (autotransform)
  • Event Package (autotransform.event)
  • Runner Related Events (autotransform.event.runner)
  • View page source

Runner Related Events (autotransform.event.runner)

The Runner events are used to handle events related to Runners in AutoTransform.

class autotransform.event.runner.RunnerFailedEvent(data: TData)

Bases: Event[RunnerFailedEventData]

A RunnerFailedEvent is triggered whenever a Runner fails.

static get_logging_level() → LoggingLevel

The logging level for events of this type.

Returns:

The logging detail required to log this event.

Return type:

LoggingLevel

static get_type() → EventType

Used to represent the type of Event, output to logs.

Returns:

The unique type associated with this Event.

Return type:

EventType

class autotransform.event.runner.RunnerFailedEventData

Bases: TypedDict

The data for a RunnerFailedEvent. Contains the information that will be logged when the event is triggered.

message: str
runner: Runner
class autotransform.event.runner.RunnerRunEvent(data: TData)

Bases: Event[RunnerRunEventData]

A RunnerRunEvent is triggered whenever a Runner successfully triggers a run.

static get_logging_level() → LoggingLevel

The logging level for events of this type.

Returns:

The logging detail required to log this event.

Return type:

LoggingLevel

static get_type() → EventType

Used to represent the type of Event, output to logs.

Returns:

The unique type associated with this Event.

Return type:

EventType

class autotransform.event.runner.RunnerRunEventData

Bases: TypedDict

The data for a RunnerRunEvent. Contains the information that will be logged when the event is triggered.

ref: str | None
runner: Runner
schema_name: str
class autotransform.event.runner.RunnerUpdateEvent(data: TData)

Bases: Event[RunnerUpdateEventData]

A RunnerRunEvent is triggered whenever a Runner successfully triggers an update.

static get_logging_level() → LoggingLevel

The logging level for events of this type.

Returns:

The logging detail required to log this event.

Return type:

LoggingLevel

static get_type() → EventType

Used to represent the type of Event, output to logs.

Returns:

The unique type associated with this Event.

Return type:

EventType

class autotransform.event.runner.RunnerUpdateEventData

Bases: TypedDict

The data for a RunnerUpdateEvent. Contains the information that will be logged when the event is triggered.

change: Change
ref: str | None
runner: Runner
Previous Next

© Copyright 2022, Nathan Rockenbach.

Built with Sphinx using a theme provided by Read the Docs.