# Copyright 2022 Confluent Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from enum import Enum, IntEnum
from typing import Iterable, Iterator, List, Optional, Union
from .. import cimpl
from ..cimpl import Message, TopicPartition
[docs]
class Node:
"""
Represents node information.
Used by :class:`ConsumerGroupDescription`
Parameters
----------
id: int
The node id of this node.
id_string:
String representation of the node id.
host:
The host name for this node.
port: int
The port for this node.
rack: str
The rack for this node.
"""
def __init__(self, id: int, host: str, port: int, rack: Optional[str] = None) -> None:
self.id = id
self.id_string = str(id)
self.host = host
self.port = port
self.rack = rack
def __str__(self) -> str:
return f"({self.id}) {self.host}:{self.port} {f'(Rack - {self.rack})' if self.rack else ''}"
[docs]
class ConsumerGroupTopicPartitions:
"""
Represents consumer group and its topic partition information.
Used by :meth:`AdminClient.list_consumer_group_offsets` and
:meth:`AdminClient.alter_consumer_group_offsets`.
Parameters
----------
group_id: str
Id of the consumer group.
topic_partitions: list(TopicPartition)
List of topic partitions information.
"""
def __init__(self, group_id: str, topic_partitions: Optional[List[TopicPartition]] = None) -> None:
self.group_id = group_id
self.topic_partitions = topic_partitions
[docs]
class ConsumerGroupState(Enum):
"""
Enumerates the different types of Consumer Group State.
Note that the state :py:attr:`UNKOWN` (typo one) is deprecated and will be removed in
future major release. Use :py:attr:`UNKNOWN` instead.
"""
#: State is not known or not set
UNKNOWN = cimpl.CONSUMER_GROUP_STATE_UNKNOWN
#: .. deprecated:: 2.3.0
#:
#: Use :py:attr:`UNKNOWN` instead.
UNKOWN = UNKNOWN
#: Preparing rebalance for the consumer group.
PREPARING_REBALANCING = cimpl.CONSUMER_GROUP_STATE_PREPARING_REBALANCE
#: Consumer Group is completing rebalancing.
COMPLETING_REBALANCING = cimpl.CONSUMER_GROUP_STATE_COMPLETING_REBALANCE
#: Consumer Group is stable.
STABLE = cimpl.CONSUMER_GROUP_STATE_STABLE
#: Consumer Group is dead.
DEAD = cimpl.CONSUMER_GROUP_STATE_DEAD
#: Consumer Group is empty.
EMPTY = cimpl.CONSUMER_GROUP_STATE_EMPTY
def __lt__(self, other: object) -> bool:
if not isinstance(other, ConsumerGroupState):
return NotImplemented
return self.value < other.value
class ConsumerGroupType(Enum):
"""
Enumerates the different types of Consumer Group Type.
Values:
-------
"""
#: Type is not known or not set
UNKNOWN = cimpl.CONSUMER_GROUP_TYPE_UNKNOWN
#: Consumer Type
CONSUMER = cimpl.CONSUMER_GROUP_TYPE_CONSUMER
#: Classic Type
CLASSIC = cimpl.CONSUMER_GROUP_TYPE_CLASSIC
def __lt__(self, other: object) -> bool:
if not isinstance(other, ConsumerGroupType):
return NotImplemented
return self.value < other.value
[docs]
class TopicCollection:
"""
Represents collection of topics in the form of different identifiers
for the topic.
Parameters
----------
topic_names: list(str)
List of topic names.
"""
def __init__(self, topic_names: List[str]) -> None:
self.topic_names = topic_names
[docs]
class TopicPartitionInfo:
"""
Represents partition information.
Used by :class:`TopicDescription`.
Parameters
----------
id : int
Id of the partition.
leader : Node
Leader broker for the partition.
replicas: list(Node)
Replica brokers for the partition.
isr: list(Node)
In-Sync-Replica brokers for the partition.
"""
def __init__(self, id: int, leader: Node, replicas: List[Node], isr: List[Node]) -> None:
self.id = id
self.leader = leader
self.replicas = replicas
self.isr = isr
[docs]
class IsolationLevel(Enum):
"""
Enum for Kafka isolation levels.
Values:
-------
"""
READ_UNCOMMITTED = cimpl.ISOLATION_LEVEL_READ_UNCOMMITTED #: Receive all the offsets.
READ_COMMITTED = cimpl.ISOLATION_LEVEL_READ_COMMITTED #: Skip offsets belonging to an aborted transaction.
def __lt__(self, other: object) -> bool:
if not isinstance(other, IsolationLevel):
return NotImplemented
return self.value < other.value
[docs]
class ElectionType(Enum):
"""
Enumerates the different types of leader elections.
Values:
-------
"""
#: Preferred election
PREFERRED = cimpl.ELECTION_TYPE_PREFERRED
#: Unclean election
UNCLEAN = cimpl.ELECTION_TYPE_UNCLEAN
def __lt__(self, other: object) -> bool:
if not isinstance(other, ElectionType):
return NotImplemented
return self.value < other.value
[docs]
class AcknowledgeType(IntEnum):
"""
Share Consumer acknowledgement type used to tell the broker how to
handle a polled message in explicit acknowledgement mode.
Values:
-------
"""
#: Record was processed successfully — broker will not redeliver it.
ACCEPT = cimpl.SHARE_ACKNOWLEDGE_TYPE_ACCEPT
#: Could not process — Release it for another delivery attempt
RELEASE = cimpl.SHARE_ACKNOWLEDGE_TYPE_RELEASE
#: Could not process - Do not release for another delivery attempt
REJECT = cimpl.SHARE_ACKNOWLEDGE_TYPE_REJECT
[docs]
class Messages:
"""Batch of messages returned by :meth:`ShareConsumer.poll`.
Read-only sequence supporting iteration, len(), indexing, and slicing,
plus the count(), is_empty(), and records() accessors.
"""
def __init__(self, messages: Iterable[Message] = ()) -> None:
self._records = list(messages)
@classmethod
def _from_list(cls, records: List[Message]) -> "Messages":
"""Wrap an already-built record list as a batch, without copying it.
:param list records: messages to adopt as the batch contents
"""
# C poll already built the list -- take it as-is, no second copy.
obj = cls.__new__(cls)
obj._records = records
return obj
[docs]
def records(self) -> List[Message]:
"""Copy of the messages in this batch.
:rtype: list
"""
# Hand out a copy so callers can't mutate the batch.
return list(self._records)
[docs]
def count(self) -> int:
"""Number of messages in this batch.
:rtype: int
"""
return len(self._records)
[docs]
def is_empty(self) -> bool:
"""Whether this batch contains no messages.
:rtype: bool
"""
return not self._records
def __len__(self) -> int:
return len(self._records)
def __iter__(self) -> Iterator[Message]:
return iter(self._records)
def __getitem__(self, index: Union[int, slice]) -> "Union[Message, Messages]":
# Slices stay Messages -- a bare list would quietly lose the accessors.
if isinstance(index, slice):
return self._from_list(self._records[index])
return self._records[index]
def __repr__(self) -> str:
return f"Messages({self._records!r})"