types-kafka-python 2.3.0.20260523__py3-none-any.whl

kafka-stubs/record/abc.pyi

@@ -0,0 +1,60 @@
+import abc
+
+class ABCRecord(metaclass=abc.ABCMeta):
+    @property
+    @abc.abstractmethod
+    def size_in_bytes(self): ...
+    @property
+    @abc.abstractmethod
+    def offset(self): ...
+    @property
+    @abc.abstractmethod
+    def timestamp(self): ...
+    @property
+    @abc.abstractmethod
+    def timestamp_type(self): ...
+    @property
+    @abc.abstractmethod
+    def key(self): ...
+    @property
+    @abc.abstractmethod
+    def value(self): ...
+    @property
+    @abc.abstractmethod
+    def checksum(self): ...
+    @abc.abstractmethod
+    def validate_crc(self): ...
+    @property
+    @abc.abstractmethod
+    def headers(self): ...
+
+class ABCRecordBatchBuilder(metaclass=abc.ABCMeta):
+    @abc.abstractmethod
+    def append(self, offset, timestamp, key, value, headers=None): ...
+    @abc.abstractmethod
+    def size_in_bytes(self, offset, timestamp, key, value, headers): ...
+    @abc.abstractmethod
+    def build(self): ...
+
+class ABCRecordBatch(metaclass=abc.ABCMeta):
+    @abc.abstractmethod
+    def __iter__(self): ...
+    @property
+    @abc.abstractmethod
+    def base_offset(self): ...
+    @property
+    @abc.abstractmethod
+    def size_in_bytes(self): ...
+    @property
+    @abc.abstractmethod
+    def magic(self): ...
+
+class ABCRecords(metaclass=abc.ABCMeta):
+    @abc.abstractmethod
+    def __init__(self, buffer): ...
+    @abc.abstractmethod
+    def size_in_bytes(self): ...
+    @abc.abstractmethod
+    def next_batch(self): ...
+    @abc.abstractmethod
+    def has_next(self): ...

kafka-stubs/record/default_records.pyi

@@ -0,0 +1,155 @@
+from _typeshed import Incomplete
+
+from kafka.record.abc import ABCRecord, ABCRecordBatch, ABCRecordBatchBuilder
+
+class DefaultRecordBase:
+    HEADER_STRUCT: Incomplete
+    ATTRIBUTES_OFFSET: Incomplete
+    CRC_OFFSET: Incomplete
+    AFTER_LEN_OFFSET: Incomplete
+    CODEC_MASK: int
+    CODEC_NONE: int
+    CODEC_GZIP: int
+    CODEC_SNAPPY: int
+    CODEC_LZ4: int
+    CODEC_ZSTD: int
+    TIMESTAMP_TYPE_MASK: int
+    TRANSACTIONAL_MASK: int
+    CONTROL_MASK: int
+    LOG_APPEND_TIME: int
+    CREATE_TIME: int
+    NO_PRODUCER_ID: int
+    NO_SEQUENCE: int
+    MAX_INT: int
+
+class DefaultRecordBatch(DefaultRecordBase, ABCRecordBatch):
+    def __init__(self, buffer) -> None: ...
+    @property
+    def base_offset(self): ...
+    @property
+    def size_in_bytes(self): ...
+    @property
+    def leader_epoch(self): ...
+    @property
+    def magic(self): ...
+    @property
+    def crc(self): ...
+    @property
+    def attributes(self): ...
+    @property
+    def last_offset_delta(self): ...
+    @property
+    def last_offset(self): ...
+    @property
+    def next_offset(self): ...
+    @property
+    def compression_type(self): ...
+    @property
+    def timestamp_type(self): ...
+    @property
+    def is_transactional(self): ...
+    @property
+    def is_control_batch(self): ...
+    @property
+    def first_timestamp(self): ...
+    @property
+    def max_timestamp(self): ...
+    @property
+    def producer_id(self): ...
+    def has_producer_id(self): ...
+    @property
+    def producer_epoch(self): ...
+    @property
+    def base_sequence(self): ...
+    @property
+    def has_sequence(self): ...
+    @property
+    def last_sequence(self): ...
+    @property
+    def records_count(self): ...
+    def __iter__(self): ...
+    def __next__(self): ...
+    next = __next__
+    def validate_crc(self): ...
+
+class DefaultRecord(ABCRecord):
+    def __init__(self, size_in_bytes, offset, timestamp, timestamp_type, key, value, headers) -> None: ...
+    @property
+    def size_in_bytes(self): ...
+    @property
+    def offset(self): ...
+    @property
+    def timestamp(self): ...
+    @property
+    def timestamp_type(self): ...
+    @property
+    def key(self): ...
+    @property
+    def value(self): ...
+    @property
+    def headers(self): ...
+    @property
+    def checksum(self) -> None: ...
+    def validate_crc(self): ...
+
+class ControlRecord(DefaultRecord):
+    KEY_STRUCT: Incomplete
+    def __init__(self, size_in_bytes, offset, timestamp, timestamp_type, key, value, headers) -> None: ...
+    @property
+    def version(self): ...
+    @property
+    def type(self): ...
+    @property
+    def abort(self): ...
+    @property
+    def commit(self): ...
+
+class DefaultRecordBatchBuilder(DefaultRecordBase, ABCRecordBatchBuilder):
+    MAX_RECORD_OVERHEAD: int
+    def __init__(
+        self, magic, compression_type, is_transactional, producer_id, producer_epoch, base_sequence, batch_size
+    ) -> None: ...
+    def set_producer_state(self, producer_id, producer_epoch, base_sequence, is_transactional) -> None: ...
+    @property
+    def producer_id(self): ...
+    @property
+    def producer_epoch(self): ...
+    def append(  # type: ignore[override]
+        self,
+        offset,
+        timestamp,
+        key,
+        value,
+        headers,
+        encode_varint=...,
+        size_of_varint=...,
+        get_type=...,
+        type_int=...,
+        time_time=...,
+        byte_like=...,
+        bytearray_type=...,
+        len_func=...,
+        zero_len_varint: int = 1,
+    ): ...
+    def write_header(self, use_compression_type: bool = True) -> None: ...
+    def build(self): ...
+    def size(self): ...
+    @classmethod
+    def header_size_in_bytes(cls): ...
+    @classmethod
+    def size_in_bytes(cls, offset_delta, timestamp_delta, key, value, headers): ...
+    @classmethod
+    def size_of(cls, key, value, headers): ...
+    @classmethod
+    def estimate_size_in_bytes(cls, key, value, headers): ...
+
+class DefaultRecordMetadata:
+    def __init__(self, offset, size, timestamp) -> None: ...
+    @property
+    def offset(self): ...
+    @property
+    def crc(self) -> None: ...
+    @property
+    def size(self): ...
+    @property
+    def timestamp(self): ...

kafka-stubs/record/legacy_records.pyi

@@ -0,0 +1,86 @@
+from _typeshed import Incomplete
+
+from kafka.record.abc import ABCRecord, ABCRecordBatch, ABCRecordBatchBuilder
+
+class LegacyRecordBase:
+    HEADER_STRUCT_V0: Incomplete
+    HEADER_STRUCT_V1: Incomplete
+    LOG_OVERHEAD: Incomplete
+    CRC_OFFSET: Incomplete
+    MAGIC_OFFSET: Incomplete
+    RECORD_OVERHEAD_V0: Incomplete
+    RECORD_OVERHEAD_V1: Incomplete
+    KEY_OFFSET_V0: Incomplete
+    KEY_OFFSET_V1: Incomplete
+    KEY_LENGTH: Incomplete
+    VALUE_LENGTH: Incomplete
+    CODEC_MASK: int
+    CODEC_NONE: int
+    CODEC_GZIP: int
+    CODEC_SNAPPY: int
+    CODEC_LZ4: int
+    TIMESTAMP_TYPE_MASK: int
+    LOG_APPEND_TIME: int
+    CREATE_TIME: int
+    NO_TIMESTAMP: int
+
+class LegacyRecordBatch(ABCRecordBatch, LegacyRecordBase):
+    def __init__(self, buffer, magic) -> None: ...
+    @property
+    def base_offset(self): ...
+    @property
+    def size_in_bytes(self): ...
+    @property
+    def timestamp_type(self): ...
+    @property
+    def compression_type(self): ...
+    @property
+    def magic(self): ...
+    def validate_crc(self): ...
+    def __iter__(self): ...
+
+class LegacyRecord(ABCRecord):
+    def __init__(self, magic, offset, timestamp, timestamp_type, key, value, crc, crc_bytes) -> None: ...
+    @property
+    def magic(self): ...
+    @property
+    def offset(self): ...
+    @property
+    def timestamp(self): ...
+    @property
+    def timestamp_type(self): ...
+    @property
+    def key(self): ...
+    @property
+    def value(self): ...
+    @property
+    def headers(self): ...
+    @property
+    def checksum(self): ...
+    def validate_crc(self): ...
+    @property
+    def size_in_bytes(self): ...
+
+class LegacyRecordBatchBuilder(ABCRecordBatchBuilder, LegacyRecordBase):
+    def __init__(self, magic, compression_type, batch_size) -> None: ...
+    def append(self, offset, timestamp, key, value, headers=None): ...
+    def build(self): ...
+    def size(self): ...
+    def size_in_bytes(self, offset, timestamp, key, value, headers=None): ...
+    @classmethod
+    def record_size(cls, magic, key, value): ...
+    @classmethod
+    def record_overhead(cls, magic): ...
+    @classmethod
+    def estimate_size_in_bytes(cls, magic, compression_type, key, value): ...
+
+class LegacyRecordMetadata:
+    def __init__(self, offset, crc, size, timestamp) -> None: ...
+    @property
+    def offset(self): ...
+    @property
+    def crc(self): ...
+    @property
+    def size(self): ...
+    @property
+    def timestamp(self): ...

kafka-stubs/record/memory_records.pyi

@@ -0,0 +1,44 @@
+from _typeshed import Incomplete
+
+from kafka.record.abc import ABCRecords
+
+class MemoryRecords(ABCRecords):
+    LENGTH_OFFSET: Incomplete
+    LOG_OVERHEAD: Incomplete
+    MAGIC_OFFSET: Incomplete
+    MIN_SLICE: Incomplete
+    def __init__(self, bytes_data) -> None: ...
+    def size_in_bytes(self): ...
+    def valid_bytes(self): ...
+    def has_next(self): ...
+    def next_batch(self, _min_slice=26, _magic_offset=16): ...
+    def __iter__(self): ...
+    def __next__(self): ...
+    next = __next__
+
+class MemoryRecordsBuilder:
+    def __init__(
+        self,
+        magic,
+        compression_type,
+        batch_size,
+        offset: int = 0,
+        transactional: bool = False,
+        producer_id: int = -1,
+        producer_epoch: int = -1,
+        base_sequence: int = -1,
+    ) -> None: ...
+    def skip(self, offsets_to_skip) -> None: ...
+    def append(self, timestamp, key, value, headers=[]): ...
+    def set_producer_state(self, producer_id, producer_epoch, base_sequence, is_transactional) -> None: ...
+    @property
+    def producer_id(self): ...
+    @property
+    def producer_epoch(self): ...
+    def records(self): ...
+    def close(self) -> None: ...
+    def size_in_bytes(self): ...
+    def compression_rate(self): ...
+    def is_full(self): ...
+    def next_offset(self): ...
+    def buffer(self): ...

kafka-stubs/record/util.pyi

@@ -0,0 +1,5 @@
+def encode_varint(value, write): ...
+def size_of_varint(value): ...
+def decode_varint(buffer, pos: int = 0): ...
+def calc_crc32c(memview, _crc32c=...): ...
+def calc_crc32(memview): ...

kafka-stubs/sasl/__init__.pyi

@@ -0,0 +1,6 @@
+from _typeshed import Incomplete
+
+SASL_MECHANISMS: Incomplete
+
+def register_sasl_mechanism(name, klass, overwrite: bool = False) -> None: ...
+def get_sasl_mechanism(name): ...

kafka-stubs/sasl/abc.pyi

@@ -0,0 +1,14 @@
+import abc
+
+class SaslMechanism(metaclass=abc.ABCMeta):
+    @abc.abstractmethod
+    def __init__(self, **config): ...
+    @abc.abstractmethod
+    def auth_bytes(self): ...
+    @abc.abstractmethod
+    def receive(self, auth_bytes): ...
+    @abc.abstractmethod
+    def is_done(self): ...
+    @abc.abstractmethod
+    def is_authenticated(self): ...
+    def auth_details(self): ...

kafka-stubs/sasl/gssapi.pyi

@@ -0,0 +1,16 @@
+from _typeshed import Incomplete
+
+from kafka.sasl.abc import SaslMechanism
+
+class SaslMechanismGSSAPI(SaslMechanism):
+    SASL_QOP_AUTH: int
+    SASL_QOP_AUTH_INT: int
+    SASL_QOP_AUTH_CONF: int
+    gssapi_name: Incomplete
+    auth_id: Incomplete
+    def __init__(self, **config) -> None: ...
+    def auth_bytes(self): ...
+    def receive(self, auth_bytes) -> None: ...
+    def is_done(self): ...
+    def is_authenticated(self): ...
+    def auth_details(self): ...

kafka-stubs/sasl/msk.pyi

@@ -0,0 +1,33 @@
+from _typeshed import Incomplete
+
+from kafka.sasl.abc import SaslMechanism
+
+log: Incomplete
+
+class SaslMechanismAwsMskIam(SaslMechanism):
+    host: Incomplete
+    def __init__(self, **config) -> None: ...
+    def auth_bytes(self): ...
+    def receive(self, auth_bytes) -> None: ...
+    def is_done(self): ...
+    def is_authenticated(self): ...
+    def auth_details(self): ...
+
+class AwsMskIamClient:
+    UNRESERVED_CHARS: Incomplete
+    algorithm: str
+    expires: str
+    hashfunc: Incomplete
+    headers: Incomplete
+    version: str
+    service: str
+    action: Incomplete
+    datestamp: Incomplete
+    timestamp: Incomplete
+    host: Incomplete
+    access_key: Incomplete
+    secret_key: Incomplete
+    region: Incomplete
+    token: Incomplete
+    def __init__(self, host, access_key, secret_key, region, token=None) -> None: ...
+    def first_message(self): ...

kafka-stubs/sasl/oauth.pyi

@@ -0,0 +1,23 @@
+import abc
+from _typeshed import Incomplete
+
+from kafka.sasl.abc import SaslMechanism
+
+log: Incomplete
+
+class SaslMechanismOAuth(SaslMechanism):
+    token_provider: Incomplete
+    def __init__(self, **config) -> None: ...
+    def auth_bytes(self): ...
+    def receive(self, auth_bytes) -> None: ...
+    def is_done(self): ...
+    def is_authenticated(self): ...
+    def auth_details(self): ...
+
+ABC: Incomplete
+
+class AbstractTokenProvider(ABC, metaclass=abc.ABCMeta):
+    def __init__(self, **config) -> None: ...
+    @abc.abstractmethod
+    def token(self): ...
+    def extensions(self): ...

kafka-stubs/sasl/plain.pyi

@@ -0,0 +1,15 @@
+from _typeshed import Incomplete
+
+from kafka.sasl.abc import SaslMechanism
+
+log: Incomplete
+
+class SaslMechanismPlain(SaslMechanism):
+    username: Incomplete
+    password: Incomplete
+    def __init__(self, **config) -> None: ...
+    def auth_bytes(self): ...
+    def receive(self, auth_bytes) -> None: ...
+    def is_done(self): ...
+    def is_authenticated(self): ...
+    def auth_details(self): ...

kafka-stubs/sasl/scram.pyi

@@ -0,0 +1,40 @@
+from _typeshed import Incomplete
+
+from kafka.sasl.abc import SaslMechanism
+
+log: Incomplete
+
+def xor_bytes(left, right): ...
+
+class SaslMechanismScram(SaslMechanism):
+    username: Incomplete
+    mechanism: Incomplete
+    def __init__(self, **config) -> None: ...
+    def auth_bytes(self): ...
+    def receive(self, auth_bytes): ...
+    def is_done(self): ...
+    def is_authenticated(self): ...
+    def auth_details(self): ...
+
+class ScramClient:
+    MECHANISMS: Incomplete
+    nonce: Incomplete
+    auth_message: bytes
+    salted_password: Incomplete
+    user: Incomplete
+    password: Incomplete
+    hashfunc: Incomplete
+    hashname: Incomplete
+    stored_key: Incomplete
+    client_key: Incomplete
+    client_signature: Incomplete
+    client_proof: Incomplete
+    server_key: Incomplete
+    server_signature: Incomplete
+    def __init__(self, user, password, mechanism) -> None: ...
+    def first_message(self): ...
+    def process_server_first_message(self, server_first_message) -> None: ...
+    def hmac(self, key, msg): ...
+    def create_salted_password(self, salt, iterations) -> None: ...
+    def final_message(self): ...
+    def process_server_final_message(self, server_final_message) -> None: ...

kafka-stubs/sasl/sspi.pyi

@@ -0,0 +1,17 @@
+from _typeshed import Incomplete
+
+from kafka.sasl.abc import SaslMechanism
+
+log: Incomplete
+
+class SaslMechanismSSPI(SaslMechanism):
+    SASL_QOP_AUTH: int
+    SASL_QOP_AUTH_INT: int
+    SASL_QOP_AUTH_CONF: int
+    auth_id: Incomplete
+    def __init__(self, **config) -> None: ...
+    def auth_bytes(self): ...
+    def receive(self, auth_bytes) -> None: ...
+    def is_done(self): ...
+    def is_authenticated(self): ...
+    def auth_details(self): ...

kafka-stubs/serializer/__init__.pyi

@@ -0,0 +1 @@
+from kafka.serializer.abstract import Deserializer as Deserializer, Serializer as Serializer

kafka-stubs/serializer/abstract.pyi

@@ -0,0 +1,15 @@
+import abc
+
+class Serializer(metaclass=abc.ABCMeta):
+    __meta__ = abc.ABCMeta
+    def __init__(self, **config) -> None: ...
+    @abc.abstractmethod
+    def serialize(self, topic, value): ...
+    def close(self) -> None: ...
+
+class Deserializer(metaclass=abc.ABCMeta):
+    __meta__ = abc.ABCMeta
+    def __init__(self, **config) -> None: ...
+    @abc.abstractmethod
+    def deserialize(self, topic, bytes_): ...
+    def close(self) -> None: ...

kafka-stubs/socks5_wrapper.pyi

@@ -0,0 +1,25 @@
+from _typeshed import Incomplete
+
+log: Incomplete
+
+class ProxyConnectionStates:
+    DISCONNECTED: str
+    CONNECTING: str
+    NEGOTIATE_PROPOSE: str
+    NEGOTIATING: str
+    AUTHENTICATING: str
+    REQUEST_SUBMIT: str
+    REQUESTING: str
+    READ_ADDRESS: str
+    COMPLETE: str
+
+class Socks5Wrapper:
+    def __init__(self, proxy_url, afi) -> None: ...
+    @classmethod
+    def is_inet_4_or_6(cls, gai): ...
+    @classmethod
+    def dns_lookup(cls, host, port, afi=...): ...
+    @classmethod
+    def use_remote_lookup(cls, proxy_url): ...
+    def socket(self, family, sock_type): ...
+    def connect_ex(self, addr): ...

kafka-stubs/structs.pyi

@@ -0,0 +1,53 @@
+from _typeshed import Incomplete
+from typing import NamedTuple
+
+class TopicPartition(NamedTuple):
+    topic: str
+    partition: int
+
+class BrokerMetadata(NamedTuple):
+    nodeId: int
+    host: str
+    port: int
+    rack: str | None
+
+class PartitionMetadata(NamedTuple):
+    topic: str
+    partition: int
+    leader: int
+    leader_epoch: int | None
+    replicas: list[int]
+    isr: list[int]
+    offline_replicas: list[int]
+    error: Incomplete
+
+class OffsetAndMetadata(NamedTuple):
+    offset: int
+    metadata: str
+    leader_epoch: int
+
+class OffsetAndTimestamp(NamedTuple):
+    offset: int
+    timestamp: int
+    leader_epoch: int
+
+class MemberInformation(NamedTuple):
+    member_id: str
+    client_id: str
+    client_host: str
+    member_metadata: Incomplete
+    member_assignment: Incomplete
+
+class GroupInformation(NamedTuple):
+    error_code: int
+    group: str
+    state: str
+    protocol_type: str
+    protocol: str
+    members: list[MemberInformation]
+    authorized_operations: list[str]
+
+class RetryOptions(NamedTuple):
+    limit: int
+    backoff_ms: int
+    retry_on_timeouts: bool

kafka-stubs/util.pyi

@@ -0,0 +1,38 @@
+from _typeshed import Incomplete
+from collections.abc import Callable
+from typing import ParamSpec, TypeVar
+
+_P = ParamSpec("_P")
+_T = TypeVar("_T")
+
+MAX_INT: Incomplete
+TO_SIGNED: Incomplete
+
+def crc32(data): ...
+
+class Timer:
+    def __init__(self, timeout_ms, error_message=None, start_at=None) -> None: ...
+    @property
+    def expired(self): ...
+    @property
+    def timeout_ms(self): ...
+    @property
+    def elapsed_ms(self): ...
+    def maybe_raise(self) -> None: ...
+
+TOPIC_MAX_LENGTH: int
+TOPIC_LEGAL_CHARS: Incomplete
+
+def ensure_valid_topic_name(topic) -> None: ...
+
+class WeakMethod:
+    target: Incomplete
+    method: Incomplete
+    def __init__(self, object_dot_method) -> None: ...
+    def __call__(self, *args, **kwargs): ...
+    def __hash__(self): ...
+    def __eq__(self, other): ...
+
+class Dict(dict[Incomplete, Incomplete]): ...
+
+def synchronized(func: Callable[_P, _T]) -> Callable[_P, _T]: ...

kafka-stubs/version.pyi

@@ -0,0 +1 @@
+__version__: str