Skip to content

Commit

Permalink
Add typing stubs for confluent-kafka
Browse files Browse the repository at this point in the history
  • Loading branch information
Mátyás Kuti committed Nov 15, 2023
1 parent 662a351 commit 7293345
Show file tree
Hide file tree
Showing 11 changed files with 143 additions and 3 deletions.
3 changes: 0 additions & 3 deletions mypy.ini
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,6 @@ ignore_errors = True
[mypy-aiokafka.*]
ignore_missing_imports = True

[mypy-confluent_kafka.*]
ignore_missing_imports = True

[mypy-kafka.*]
ignore_missing_imports = True

Expand Down
4 changes: 4 additions & 0 deletions stubs/confluent_kafka/__init__.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from ._model import IsolationLevel
from .cimpl import TopicPartition

__all__ = ("IsolationLevel", "TopicPartition")
1 change: 1 addition & 0 deletions stubs/confluent_kafka/_model.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
class IsolationLevel: ...
53 changes: 53 additions & 0 deletions stubs/confluent_kafka/admin/__init__.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
from ..cimpl import NewTopic
from ._config import ConfigEntry, ConfigResource, ConfigSource
from ._listoffsets import ListOffsetsResultInfo, OffsetSpec
from ._metadata import BrokerMetadata, ClusterMetadata, TopicMetadata
from ._resource import ResourceType
from concurrent.futures import Future
from confluent_kafka import IsolationLevel, TopicPartition
from typing import Callable

__all__ = (
"AdminClient",
"BrokerMetadata",
"ClusterMetadata",
"ConfigResource",
"ConfigSource",
"NewTopic",
"OffsetSpec",
"ResourceType",
"TopicMetadata",
)

class AdminClient:
def __init__(self, config: dict[str, str | int | Callable]) -> None: ...
def poll(self, timeout: float) -> int: ...
def list_topics(self, topic: str | None = None, timeout: float = -1) -> ClusterMetadata: ...
def create_topics(
self,
new_topics: list[NewTopic],
operation_timeout: float = 0,
request_timeout: float = -1,
validate_only: bool = False,
) -> dict[str, Future[None]]: ...
def alter_configs(
self,
resources: list[ConfigResource],
request_timeout: float = -1,
validate_only: bool = False,
) -> dict[str, Future[ConfigResource]]: ...
def delete_topics(
self,
topics: list[str],
operation_timeout: float = 0,
request_timeout: float = -1,
) -> dict[str, Future[None]]: ...
def list_offsets(
self,
topic_partition_offsets: dict[TopicPartition, OffsetSpec],
isolation_level: IsolationLevel | None = None,
request_timeout: float = -1,
) -> dict[TopicPartition, Future[ListOffsetsResultInfo]]: ...
def describe_configs(
self, resources: list[ConfigResource], request_timeout: float = -1
) -> dict[ConfigResource, Future[dict[str, ConfigEntry]]]: ...
18 changes: 18 additions & 0 deletions stubs/confluent_kafka/admin/_config.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
from ._resource import ResourceType
from enum import Enum

class ConfigResource:
Type = ResourceType

def __init__(
self,
restype: ResourceType,
name: str,
set_config: dict[str, str] | None = None,
) -> None: ...

class ConfigSource(Enum):
UNKNOWN_CONFIG: int
DYNAMIC_TOPIC_CONFIG: int

class ConfigEntry: ...
7 changes: 7 additions & 0 deletions stubs/confluent_kafka/admin/_listoffsets.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
class OffsetSpec:
@classmethod
def earliest(cls) -> "OffsetSpec": ...
@classmethod
def latest(cls) -> "OffsetSpec": ...

class ListOffsetsResultInfo: ...
22 changes: 22 additions & 0 deletions stubs/confluent_kafka/admin/_metadata.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
class ClusterMetadata:
def __init__(self) -> None:
self.cluster_id: str | None
self.controller_id: int
self.brokers: dict[int, BrokerMetadata]
self.topics: dict[str, TopicMetadata]
self.orig_broker_id: int
self.orig_broker_name: str | None

class BrokerMetadata: ...

class TopicMetadata:
def __init__(self) -> None:
self.topic: str
self.partitions: dict[int, PartitionMetadata]

class PartitionMetadata:
def __init__(self) -> None:
self.id: int
self.leader: int
self.replicas: list[int]
self.isrs: list[int]
4 changes: 4 additions & 0 deletions stubs/confluent_kafka/admin/_resource.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from enum import Enum

class ResourceType(Enum):
TOPIC: int
31 changes: 31 additions & 0 deletions stubs/confluent_kafka/cimpl.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
from typing import Any

class KafkaError:
_NOENT: int

def code(self) -> int: ...

class KafkaException(Exception):
def __init__(self, *args: Any, **kwargs: Any) -> None:
self.args: tuple[KafkaError]

class NewTopic:
def __init__(
self,
topic: str,
num_partitions: int = -1,
replication_factor: int = -1,
replica_assignment: list | None = None,
config: dict[str, str] | None = None,
) -> None:
self.topic: str

class TopicPartition:
def __init__(
self,
topic: str,
partition: int = -1,
offset: int = -1001,
metadata: str | None = None,
leader_epoc: int | None = None,
) -> None: ...
3 changes: 3 additions & 0 deletions stubs/confluent_kafka/error.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
from confluent_kafka.cimpl import KafkaError, KafkaException

__all__ = ("KafkaError", "KafkaException")
Empty file added stubs/confluent_kafka/py.typed
Empty file.

0 comments on commit 7293345

Please sign in to comment.