Module contents

class heizer.HeizerConfig(config=None)

Parameters:

config (Optional[Dict[str, str]]) –

property value: Dict[str, str]

Return kafka configurations

Returns:

config – The dict contains kafka configurations

Return type:

dict

class heizer.HeizerMessage(message)

Parameters:

message (Message) –

formatted_value: Optional[Any] = None

headers: Optional[Dict[str, str]]

key: Optional[str]

message: Message

partition: int

topic: Optional[str]

value: Optional[str]

class heizer.HeizerTopic(name, partitions=None, replication_factor=1)

Parameters:

• name (str) –

• partitions (Optional[List[int]]) –

• replication_factor (int) –

name: str

property partitions: List[int]

property topic_partitions: List[TopicPartition]

class heizer.consumer(*, topics, config=<heizer.config.HeizerConfig object>, call_once=False, stopper=None, deserializer=None, is_async=False, name=None, poll_timeout=None, init_topics=True)

A decorator to create a consumer

Parameters:

• topics (List[HeizerTopic]) –

• config (HeizerConfig) –

• call_once (bool) –

• stopper (Optional[Callable[[...], bool]]) –

• deserializer (Optional[Type[BaseModel]]) –

• is_async (bool) –

• name (Optional[str]) –

• poll_timeout (int) –

• init_topics (bool) –

call_once: bool = False

config: HeizerConfig = <heizer.config.HeizerConfig object>

deserializer: Optional[Type[BaseModel]] = None

init_topics: bool = True

is_async: bool = False

name: Optional[str]

poll_timeout: int = 1

stopper: Optional[Callable[[...], bool]] = None

topics: List[HeizerTopic]

class heizer.producer(topics, config=<heizer.config.HeizerConfig object>, serializer=<function _default_serializer>, call_back=None, default_key=None, default_headers=None, key_alias=None, headers_alias=None, name=None, init_topics=True)

A decorator to create a producer

Parameters:

• topics (List[HeizerTopic]) –

• config (HeizerConfig) –

• serializer (Callable[[...], bytes]) –

• call_back (Optional[Callable[[...], Any]]) –

• default_key (Optional[str]) –

• default_headers (Optional[Dict[str, str]]) –

• key_alias (str) –

• headers_alias (str) –

• name (str) –

• init_topics (bool) –

call_back: Optional[Callable[[...], Any]] = None

config: HeizerConfig = <heizer.config.HeizerConfig object>

default_headers: Optional[Dict[str, str]] = None

default_key: Optional[str] = None

headers_alias: str = 'headers'

init_topics: bool = True

key_alias: str = 'key'

name: str

serializer()

Parameters:

value (Union[Dict[Any, Any], str, bytes]) –

Returns:

bytes

Return type:

bytes

Default Kafka message serializer, which will encode inputs to bytes

topics: List[HeizerTopic]