Skip to content

StubProcessor

Bases: IDMixin

Tiles processor that passes the tiles through

Experimental

StubProcessor is experimental since 1.4.0 and may change without notice.

Implements the TilesProcessor protocol.

PARAMETER DESCRIPTION
delay

Delay in seconds

TYPE: float DEFAULT: 0.0

jitter

Jitter in seconds

TYPE: float DEFAULT: 0.0

id property

RETURNS DESCRIPTION
uuid.UUID

ID

from_config classmethod

Creates a stub processor from the configuration.

PARAMETER DESCRIPTION
config

Configuration

TYPE: StubProcessorConfig

RETURNS DESCRIPTION
StubProcessor

Stub processor

__call__

Passes through the tiles.

PARAMETER DESCRIPTION
tiles

Tiles

TYPE: Tiles

RETURNS DESCRIPTION
Tiles

Tiles


StubProcessorConfig

Bases: pydantic.BaseModel

Configuration for the from_config class method of StubProcessor

Usage

You can create the configuration from a config file.

config.yaml
package: 'aviary'
name: 'StubProcessor'
config:
  delay: 0.
  jitter: 0.
ATTRIBUTE DESCRIPTION
delay

Delay in seconds - defaults to 0.

TYPE: float

jitter

Jitter in seconds - defaults to 0.

TYPE: float