kafka-python 3.0.0__py3-none-any.whl

kafka/protocol/admin/transactions.py

@@ -0,0 +1,18 @@
+from ..api_message import ApiMessage
+
+
+class ListTransactionsRequest(ApiMessage): pass
+class ListTransactionsResponse(ApiMessage): pass
+
+class DescribeTransactionsRequest(ApiMessage): pass
+class DescribeTransactionsResponse(ApiMessage): pass
+
+class DescribeProducersRequest(ApiMessage): pass
+class DescribeProducersResponse(ApiMessage): pass
+
+
+__all__ = [
+    'ListTransactionsRequest', 'ListTransactionsResponse',
+    'DescribeTransactionsRequest', 'DescribeTransactionsResponse',
+    'DescribeProducersRequest', 'DescribeProducersResponse',
+]

kafka/protocol/admin/transactions.pyi

@@ -0,0 +1,311 @@
+# Generated by generate_stubs.py (Python 3.14)
+import uuid
+from typing import Any, Self
+
+from kafka.protocol.api_message import ApiMessage
+from kafka.protocol.data_container import DataContainer
+
+__all__ = ['ListTransactionsRequest', 'ListTransactionsResponse', 'DescribeTransactionsRequest', 'DescribeTransactionsResponse', 'DescribeProducersRequest', 'DescribeProducersResponse']
+
+class ListTransactionsRequest(ApiMessage):
+    state_filters: list[str]
+    producer_id_filters: list[int]
+    duration_filter: int
+    transactional_id_pattern: str | None
+    def __init__(
+        self,
+        *args: Any,
+        state_filters: list[str] = ...,
+        producer_id_filters: list[int] = ...,
+        duration_filter: int = ...,
+        transactional_id_pattern: str | None = ...,
+        version: int | None = None,
+        **kwargs: Any,
+    ) -> None: ...
+    @property
+    def version(self) -> int | None: ...
+    def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+    name: str
+    type: str
+    API_KEY: int
+    API_VERSION: int
+    valid_versions: tuple[int, int]
+    min_version: int
+    max_version: int
+    @property
+    def header(self) -> Any: ...
+    @classmethod
+    def is_request(cls) -> bool: ...
+    def expect_response(self) -> bool: ...
+    def with_header(self, correlation_id: int = 0, client_id: str = "kafka-python") -> None: ...
+
+class ListTransactionsResponse(ApiMessage):
+    class TransactionState(DataContainer):
+        transactional_id: str
+        producer_id: int
+        transaction_state: str
+        def __init__(
+            self,
+            *args: Any,
+            transactional_id: str = ...,
+            producer_id: int = ...,
+            transaction_state: str = ...,
+            version: int | None = None,
+            **kwargs: Any,
+        ) -> None: ...
+        @property
+        def version(self) -> int | None: ...
+        def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+
+    throttle_time_ms: int
+    error_code: int
+    unknown_state_filters: list[str]
+    transaction_states: list[TransactionState]
+    def __init__(
+        self,
+        *args: Any,
+        throttle_time_ms: int = ...,
+        error_code: int = ...,
+        unknown_state_filters: list[str] = ...,
+        transaction_states: list[TransactionState] = ...,
+        version: int | None = None,
+        **kwargs: Any,
+    ) -> None: ...
+    @property
+    def version(self) -> int | None: ...
+    def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+    name: str
+    type: str
+    API_KEY: int
+    API_VERSION: int
+    valid_versions: tuple[int, int]
+    min_version: int
+    max_version: int
+    @property
+    def header(self) -> Any: ...
+    @classmethod
+    def is_request(cls) -> bool: ...
+    def expect_response(self) -> bool: ...
+    def with_header(self, correlation_id: int = 0, client_id: str = "kafka-python") -> None: ...
+
+class DescribeTransactionsRequest(ApiMessage):
+    transactional_ids: list[str]
+    def __init__(
+        self,
+        *args: Any,
+        transactional_ids: list[str] = ...,
+        version: int | None = None,
+        **kwargs: Any,
+    ) -> None: ...
+    @property
+    def version(self) -> int | None: ...
+    def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+    name: str
+    type: str
+    API_KEY: int
+    API_VERSION: int
+    valid_versions: tuple[int, int]
+    min_version: int
+    max_version: int
+    @property
+    def header(self) -> Any: ...
+    @classmethod
+    def is_request(cls) -> bool: ...
+    def expect_response(self) -> bool: ...
+    def with_header(self, correlation_id: int = 0, client_id: str = "kafka-python") -> None: ...
+
+class DescribeTransactionsResponse(ApiMessage):
+    class TransactionState(DataContainer):
+        class TopicData(DataContainer):
+            topic: str
+            partitions: list[int]
+            def __init__(
+                self,
+                *args: Any,
+                topic: str = ...,
+                partitions: list[int] = ...,
+                version: int | None = None,
+                **kwargs: Any,
+            ) -> None: ...
+            @property
+            def version(self) -> int | None: ...
+            def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+
+        error_code: int
+        transactional_id: str
+        transaction_state: str
+        transaction_timeout_ms: int
+        transaction_start_time_ms: int
+        producer_id: int
+        producer_epoch: int
+        topics: list[TopicData]
+        def __init__(
+            self,
+            *args: Any,
+            error_code: int = ...,
+            transactional_id: str = ...,
+            transaction_state: str = ...,
+            transaction_timeout_ms: int = ...,
+            transaction_start_time_ms: int = ...,
+            producer_id: int = ...,
+            producer_epoch: int = ...,
+            topics: list[TopicData] = ...,
+            version: int | None = None,
+            **kwargs: Any,
+        ) -> None: ...
+        @property
+        def version(self) -> int | None: ...
+        def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+
+    throttle_time_ms: int
+    transaction_states: list[TransactionState]
+    def __init__(
+        self,
+        *args: Any,
+        throttle_time_ms: int = ...,
+        transaction_states: list[TransactionState] = ...,
+        version: int | None = None,
+        **kwargs: Any,
+    ) -> None: ...
+    @property
+    def version(self) -> int | None: ...
+    def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+    name: str
+    type: str
+    API_KEY: int
+    API_VERSION: int
+    valid_versions: tuple[int, int]
+    min_version: int
+    max_version: int
+    @property
+    def header(self) -> Any: ...
+    @classmethod
+    def is_request(cls) -> bool: ...
+    def expect_response(self) -> bool: ...
+    def with_header(self, correlation_id: int = 0, client_id: str = "kafka-python") -> None: ...
+
+class DescribeProducersRequest(ApiMessage):
+    class TopicRequest(DataContainer):
+        name: str
+        partition_indexes: list[int]
+        def __init__(
+            self,
+            *args: Any,
+            name: str = ...,
+            partition_indexes: list[int] = ...,
+            version: int | None = None,
+            **kwargs: Any,
+        ) -> None: ...
+        @property
+        def version(self) -> int | None: ...
+        def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+
+    topics: list[TopicRequest]
+    def __init__(
+        self,
+        *args: Any,
+        topics: list[TopicRequest] = ...,
+        version: int | None = None,
+        **kwargs: Any,
+    ) -> None: ...
+    @property
+    def version(self) -> int | None: ...
+    def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+    name: str
+    type: str
+    API_KEY: int
+    API_VERSION: int
+    valid_versions: tuple[int, int]
+    min_version: int
+    max_version: int
+    @property
+    def header(self) -> Any: ...
+    @classmethod
+    def is_request(cls) -> bool: ...
+    def expect_response(self) -> bool: ...
+    def with_header(self, correlation_id: int = 0, client_id: str = "kafka-python") -> None: ...
+
+class DescribeProducersResponse(ApiMessage):
+    class TopicResponse(DataContainer):
+        class PartitionResponse(DataContainer):
+            class ProducerState(DataContainer):
+                producer_id: int
+                producer_epoch: int
+                last_sequence: int
+                last_timestamp: int
+                coordinator_epoch: int
+                current_txn_start_offset: int
+                def __init__(
+                    self,
+                    *args: Any,
+                    producer_id: int = ...,
+                    producer_epoch: int = ...,
+                    last_sequence: int = ...,
+                    last_timestamp: int = ...,
+                    coordinator_epoch: int = ...,
+                    current_txn_start_offset: int = ...,
+                    version: int | None = None,
+                    **kwargs: Any,
+                ) -> None: ...
+                @property
+                def version(self) -> int | None: ...
+                def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+
+            partition_index: int
+            error_code: int
+            error_message: str | None
+            active_producers: list[ProducerState]
+            def __init__(
+                self,
+                *args: Any,
+                partition_index: int = ...,
+                error_code: int = ...,
+                error_message: str | None = ...,
+                active_producers: list[ProducerState] = ...,
+                version: int | None = None,
+                **kwargs: Any,
+            ) -> None: ...
+            @property
+            def version(self) -> int | None: ...
+            def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+
+        name: str
+        partitions: list[PartitionResponse]
+        def __init__(
+            self,
+            *args: Any,
+            name: str = ...,
+            partitions: list[PartitionResponse] = ...,
+            version: int | None = None,
+            **kwargs: Any,
+        ) -> None: ...
+        @property
+        def version(self) -> int | None: ...
+        def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+
+    throttle_time_ms: int
+    topics: list[TopicResponse]
+    def __init__(
+        self,
+        *args: Any,
+        throttle_time_ms: int = ...,
+        topics: list[TopicResponse] = ...,
+        version: int | None = None,
+        **kwargs: Any,
+    ) -> None: ...
+    @property
+    def version(self) -> int | None: ...
+    def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+    name: str
+    type: str
+    API_KEY: int
+    API_VERSION: int
+    valid_versions: tuple[int, int]
+    min_version: int
+    max_version: int
+    @property
+    def header(self) -> Any: ...
+    @classmethod
+    def is_request(cls) -> bool: ...
+    def expect_response(self) -> bool: ...
+    def with_header(self, correlation_id: int = 0, client_id: str = "kafka-python") -> None: ...

kafka/protocol/admin/users.py

@@ -0,0 +1,14 @@
+from ..api_message import ApiMessage
+
+
+class AlterUserScramCredentialsRequest(ApiMessage): pass
+class AlterUserScramCredentialsResponse(ApiMessage): pass
+
+class DescribeUserScramCredentialsRequest(ApiMessage): pass
+class DescribeUserScramCredentialsResponse(ApiMessage): pass
+
+
+__all__ = [
+    'AlterUserScramCredentialsRequest', 'AlterUserScramCredentialsResponse',
+    'DescribeUserScramCredentialsRequest', 'DescribeUserScramCredentialsResponse',
+]

kafka/protocol/admin/users.pyi

@@ -0,0 +1,223 @@
+# Generated by generate_stubs.py (Python 3.14)
+import uuid
+from typing import Any, Self
+
+from kafka.protocol.api_message import ApiMessage
+from kafka.protocol.api_data import ApiData
+from kafka.protocol.data_container import DataContainer
+
+__all__ = ['AlterUserScramCredentialsRequest', 'AlterUserScramCredentialsResponse', 'DescribeUserScramCredentialsRequest', 'DescribeUserScramCredentialsResponse']
+
+class AlterUserScramCredentialsRequest(ApiMessage):
+    class ScramCredentialDeletion(DataContainer):
+        name: str
+        mechanism: int
+        def __init__(
+            self,
+            *args: Any,
+            name: str = ...,
+            mechanism: int = ...,
+            version: int | None = None,
+            **kwargs: Any,
+        ) -> None: ...
+        @property
+        def version(self) -> int | None: ...
+        def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+
+    class ScramCredentialUpsertion(DataContainer):
+        name: str
+        mechanism: int
+        iterations: int
+        salt: bytes | ApiData
+        salted_password: bytes | ApiData
+        def __init__(
+            self,
+            *args: Any,
+            name: str = ...,
+            mechanism: int = ...,
+            iterations: int = ...,
+            salt: bytes | ApiData = ...,
+            salted_password: bytes | ApiData = ...,
+            version: int | None = None,
+            **kwargs: Any,
+        ) -> None: ...
+        @property
+        def version(self) -> int | None: ...
+        def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+
+    deletions: list[ScramCredentialDeletion]
+    upsertions: list[ScramCredentialUpsertion]
+    def __init__(
+        self,
+        *args: Any,
+        deletions: list[ScramCredentialDeletion] = ...,
+        upsertions: list[ScramCredentialUpsertion] = ...,
+        version: int | None = None,
+        **kwargs: Any,
+    ) -> None: ...
+    @property
+    def version(self) -> int | None: ...
+    def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+    name: str
+    type: str
+    API_KEY: int
+    API_VERSION: int
+    valid_versions: tuple[int, int]
+    min_version: int
+    max_version: int
+    @property
+    def header(self) -> Any: ...
+    @classmethod
+    def is_request(cls) -> bool: ...
+    def expect_response(self) -> bool: ...
+    def with_header(self, correlation_id: int = 0, client_id: str = "kafka-python") -> None: ...
+
+class AlterUserScramCredentialsResponse(ApiMessage):
+    class AlterUserScramCredentialsResult(DataContainer):
+        user: str
+        error_code: int
+        error_message: str | None
+        def __init__(
+            self,
+            *args: Any,
+            user: str = ...,
+            error_code: int = ...,
+            error_message: str | None = ...,
+            version: int | None = None,
+            **kwargs: Any,
+        ) -> None: ...
+        @property
+        def version(self) -> int | None: ...
+        def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+
+    throttle_time_ms: int
+    results: list[AlterUserScramCredentialsResult]
+    def __init__(
+        self,
+        *args: Any,
+        throttle_time_ms: int = ...,
+        results: list[AlterUserScramCredentialsResult] = ...,
+        version: int | None = None,
+        **kwargs: Any,
+    ) -> None: ...
+    @property
+    def version(self) -> int | None: ...
+    def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+    name: str
+    type: str
+    API_KEY: int
+    API_VERSION: int
+    valid_versions: tuple[int, int]
+    min_version: int
+    max_version: int
+    @property
+    def header(self) -> Any: ...
+    @classmethod
+    def is_request(cls) -> bool: ...
+    def expect_response(self) -> bool: ...
+    def with_header(self, correlation_id: int = 0, client_id: str = "kafka-python") -> None: ...
+
+class DescribeUserScramCredentialsRequest(ApiMessage):
+    class UserName(DataContainer):
+        name: str
+        def __init__(
+            self,
+            *args: Any,
+            name: str = ...,
+            version: int | None = None,
+            **kwargs: Any,
+        ) -> None: ...
+        @property
+        def version(self) -> int | None: ...
+        def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+
+    users: list[UserName] | None
+    def __init__(
+        self,
+        *args: Any,
+        users: list[UserName] | None = ...,
+        version: int | None = None,
+        **kwargs: Any,
+    ) -> None: ...
+    @property
+    def version(self) -> int | None: ...
+    def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+    name: str
+    type: str
+    API_KEY: int
+    API_VERSION: int
+    valid_versions: tuple[int, int]
+    min_version: int
+    max_version: int
+    @property
+    def header(self) -> Any: ...
+    @classmethod
+    def is_request(cls) -> bool: ...
+    def expect_response(self) -> bool: ...
+    def with_header(self, correlation_id: int = 0, client_id: str = "kafka-python") -> None: ...
+
+class DescribeUserScramCredentialsResponse(ApiMessage):
+    class DescribeUserScramCredentialsResult(DataContainer):
+        class CredentialInfo(DataContainer):
+            mechanism: int
+            iterations: int
+            def __init__(
+                self,
+                *args: Any,
+                mechanism: int = ...,
+                iterations: int = ...,
+                version: int | None = None,
+                **kwargs: Any,
+            ) -> None: ...
+            @property
+            def version(self) -> int | None: ...
+            def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+
+        user: str
+        error_code: int
+        error_message: str | None
+        credential_infos: list[CredentialInfo]
+        def __init__(
+            self,
+            *args: Any,
+            user: str = ...,
+            error_code: int = ...,
+            error_message: str | None = ...,
+            credential_infos: list[CredentialInfo] = ...,
+            version: int | None = None,
+            **kwargs: Any,
+        ) -> None: ...
+        @property
+        def version(self) -> int | None: ...
+        def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+
+    throttle_time_ms: int
+    error_code: int
+    error_message: str | None
+    results: list[DescribeUserScramCredentialsResult]
+    def __init__(
+        self,
+        *args: Any,
+        throttle_time_ms: int = ...,
+        error_code: int = ...,
+        error_message: str | None = ...,
+        results: list[DescribeUserScramCredentialsResult] = ...,
+        version: int | None = None,
+        **kwargs: Any,
+    ) -> None: ...
+    @property
+    def version(self) -> int | None: ...
+    def to_dict(self, meta: bool = False, json: bool = True) -> dict: ...
+    name: str
+    type: str
+    API_KEY: int
+    API_VERSION: int
+    valid_versions: tuple[int, int]
+    min_version: int
+    max_version: int
+    @property
+    def header(self) -> Any: ...
+    @classmethod
+    def is_request(cls) -> bool: ...
+    def expect_response(self) -> bool: ...
+    def with_header(self, correlation_id: int = 0, client_id: str = "kafka-python") -> None: ...

kafka/protocol/api_data.py

@@ -0,0 +1,125 @@
+import io
+import weakref
+
+from kafka.util import classproperty
+
+from .data_container import DataContainer, SlotsBuilder
+from .schemas import BaseField, StructField, load_json
+from .schemas.fields.codecs import Int16, Int32
+
+
+class JsonSchemaData(SlotsBuilder):
+    def __new__(metacls, name, bases, attrs, **kw):
+        if kw.get('init', True):
+            json = load_json(name, package=kw.get('load_json'))
+            if 'json_patch' in attrs:
+                json = attrs['json_patch'].__func__(metacls, json)
+            attrs['_json'] = json
+            attrs['_struct'] = StructField(json)
+            if 'doc' in json:
+                attrs['__doc__'] = attrs.get('__doc__', '') + "\nNotes from json schema:\n" + json.get('doc')
+            attrs['__license__'] = json.get('license')
+        return super().__new__(metacls, name, bases, attrs, **kw)
+
+    def __init__(cls, name, bases, attrs, **kw):
+        super().__init__(name, bases, attrs, **kw)
+        if kw.get('init', True):
+            cls._struct.set_data_class(weakref.proxy(cls))
+
+
+class ApiData(DataContainer, metaclass=JsonSchemaData, init=False):
+    def __init_subclass__(cls, **kw):
+        super().__init_subclass__(**kw)
+        if kw.get('init', True):
+            # pylint: disable=E1101
+            assert cls._json is not None
+            assert cls._json['type'] == 'data'
+            cls._flexible_versions = BaseField.parse_versions(cls._json['flexibleVersions'])
+            cls._valid_versions = BaseField.parse_versions(cls._json['validVersions'])
+
+    def __init__(self, *args, **kwargs):
+        if len(args) > 0 and isinstance(args[0], int) and 'version' not in kwargs:
+            kwargs['version'] = args[0]
+            args = tuple(args[1:])
+        super().__init__(*args, **kwargs)
+
+    @classproperty
+    def name(cls): # pylint: disable=E0213
+        return cls._json['name'] # pylint: disable=E1101
+
+    @classproperty
+    def type(cls): # pylint: disable=E0213
+        return cls._json['type'] # pylint: disable=E1101
+
+    @classproperty
+    def json(cls): # pylint: disable=E0213
+        return cls._json # pylint: disable=E1101
+
+    @classproperty
+    def valid_versions(cls): # pylint: disable=E0213
+        return cls._valid_versions
+
+    @classproperty
+    def min_version(cls): # pylint: disable=E0213
+        return 0
+
+    @classproperty
+    def max_version(cls): # pylint: disable=E0213
+        if cls._valid_versions is not None:
+            return cls._valid_versions[1] # pylint: disable=E1136
+        return None
+
+    @classmethod
+    def flexible_version_q(cls, version):
+        if cls._flexible_versions is not None:
+            if cls._flexible_versions[0] <= version <= cls._flexible_versions[1]: # pylint: disable=E1136
+                return True
+        return False
+
+    @classproperty
+    def header_class(cls): # pylint: disable=E0213
+        return Int16
+
+    def encode_header(self, flexible=False):
+        assert self._version is not None
+        return self.header_class.encode(self._version)
+
+    @classmethod
+    def parse_header(cls, data):
+        return cls.header_class.decode(data) # pylint: disable-msg=no-member
+
+    def encode(self, version=None, header=True, framed=False):
+        if version is not None:
+            self._version = version
+        elif self._version is None:
+            raise ValueError('Version required to encode data')
+        flexible = self.flexible_version_q(self._version)
+        encoded = self._struct.encode(self, version=self._version, compact=flexible, tagged=flexible)
+        if not header and not framed:
+            return encoded
+        bits = [encoded]
+        if header:
+            bits.insert(0, self.encode_header(flexible=flexible))
+        if framed:
+            bits.insert(0, Int32.encode(sum(map(len, bits))))
+        return b''.join(bits)
+
+    @classmethod
+    def decode(cls, data, version=None, header=True, framed=False):
+        if not header:
+            if version is None:
+                raise ValueError('Version required to decode data')
+            elif not 0 <= version <= cls.max_version:
+                raise ValueError('Invalid version %s (max version is %s).' % (version, cls.max_version))
+        if isinstance(data, bytes):
+            data = io.BytesIO(data)
+        if framed:
+            size = Int32.decode(data)
+        if header:
+            decoded_version = cls.parse_header(data)
+            if version is not None:
+                if version > decoded_version:
+                    raise ValueError('Version mismatch: found v%d, expected v%d' % (decoded_version, version))
+            version = min(decoded_version, cls.max_version)
+        flexible = cls.flexible_version_q(version)
+        return cls._struct.decode(data, version=version, compact=flexible, tagged=flexible)