Top

heronpy module

Heron's top level library

'''Heron's top level library'''
__all__ = ['api_constants', 'bolt', 'component', 'custom_grouping', 'global_metrics',
           'metrics', 'serializer', 'spout', 'stream', 'task_hook', 'topology',
           'topology_context', 'tuple']

# Load basic topology modules
from .stream import Stream, Grouping
from .topology import Topology, TopologyBuilder
from .topology_context import TopologyContext

# Load spout and bolt
from .bolt import Bolt
from .spout import Spout

Sub-modules

heronpy.api_constants

api_constants.py: defines api constants for topology config

heronpy.bolt

API module for heron bolt

heronpy.component

module for base component

heronpy.custom_grouping

custom_grouping.py: interface module for custom grouping

heronpy.global_metrics

Singleton class which exposes a simple globally available counter for heron jobs.

It serves the same functionality as GlobalMetrics.java

heronpy.metrics

metrics.py: common heron metric

heronpy.serializer

serializer.py: common python serializer for heron

heronpy.spout

API module for heron spout

heronpy.stream

stream.py: module for defining Stream and Grouping for python topology

heronpy.task_hook

task_hook.py: modules for supporting task hooks for topology

heronpy.topology

topology.py: module for defining python topologies

heronpy.topology_context

topology_context.py

heronpy.tuple

tuple.py: heron's default data type