kafka-python 3.0.0__py3-none-any.whl

kafka/protocol/admin/__init__.py

@@ -0,0 +1,29 @@
+from .acl import *
+from .acl import __all__ as acl_all
+
+from .client_quotas import *
+from .client_quotas import __all__ as client_quotas_all
+
+from .cluster import *
+from .cluster import __all__ as cluster_all
+
+from .configs import *
+from .configs import __all__ as configs_all
+
+from .groups import *
+from .groups import __all__ as groups_all
+
+from .topics import *
+from .topics import __all__ as topics_all
+
+from .transactions import *
+from .transactions import __all__ as transactions_all
+
+from .users import *
+from .users import __all__ as users_all
+
+
+__all__ = (
+    acl_all + client_quotas_all + cluster_all + configs_all
+    + groups_all + topics_all + transactions_all + users_all
+)

kafka/protocol/admin/acl.py

@@ -0,0 +1,83 @@
+from enum import IntEnum
+
+from ..api_message import ApiMessage
+
+
+class CreateAclsRequest(ApiMessage): pass
+class CreateAclsResponse(ApiMessage): pass
+
+class DeleteAclsRequest(ApiMessage): pass
+class DeleteAclsResponse(ApiMessage): pass
+
+class DescribeAclsRequest(ApiMessage): pass
+class DescribeAclsResponse(ApiMessage): pass
+
+
+class ACLResourceType(IntEnum):
+    """Type of kafka resource to set ACL for
+
+    The ANY value is only valid in a filter context
+    """
+    UNKNOWN = 0
+    ANY = 1
+    TOPIC = 2
+    GROUP = 3
+    CLUSTER = 4
+    TRANSACTIONAL_ID = 5
+    DELEGATION_TOKEN = 6
+
+
+class ACLOperation(IntEnum):
+    """Type of operation
+
+    The ANY value is only valid in a filter context
+    """
+    UNKNOWN = 0
+    ANY = 1
+    ALL = 2
+    READ = 3
+    WRITE = 4
+    CREATE = 5
+    DELETE = 6
+    ALTER = 7
+    DESCRIBE = 8
+    CLUSTER_ACTION = 9
+    DESCRIBE_CONFIGS = 10
+    ALTER_CONFIGS = 11
+    IDEMPOTENT_WRITE = 12
+    CREATE_TOKENS = 13
+    DESCRIBE_TOKENS = 14
+
+
+class ACLPermissionType(IntEnum):
+    """An enumerated type of permissions
+
+    The ANY value is only valid in a filter context
+    """
+    UNKNOWN = 0
+    ANY = 1
+    DENY = 2
+    ALLOW = 3
+
+
+class ACLResourcePatternType(IntEnum):
+    """An enumerated type of resource patterns
+
+    More details on the pattern types and how they work
+    can be found in KIP-290 (Support for prefixed ACLs)
+    https://cwiki.apache.org/confluence/display/KAFKA/KIP-290%3A+Support+for+Prefixed+ACLs
+    """
+    UNKNOWN = 0
+    ANY = 1
+    MATCH = 2
+    LITERAL = 3
+    PREFIXED = 4
+
+
+__all__ = [
+    'CreateAclsRequest', 'CreateAclsResponse',
+    'DeleteAclsRequest', 'DeleteAclsResponse',
+    'DescribeAclsRequest', 'DescribeAclsResponse',
+    'ACLResourceType', 'ACLOperation',
+    'ACLPermissionType', 'ACLResourcePatternType',
+]

kafka/protocol/admin/acl.pyi

@@ -0,0 +1,375 @@
+# Generated by generate_stubs.py (Python 3.14)
+import uuid
+from typing import Any, Self
+
+from enum import IntEnum
+from kafka.protocol.api_message import ApiMessage
+from kafka.protocol.data_container import DataContainer
+
+__all__ = ['CreateAclsRequest', 'CreateAclsResponse', 'DeleteAclsRequest', 'DeleteAclsResponse', 'DescribeAclsRequest', 'DescribeAclsResponse', 'ACLResourceType', 'ACLOperation', 'ACLPermissionType', 'ACLResourcePatternType']
+
+class CreateAclsRequest(ApiMessage):
+    class AclCreation(DataContainer):
+        resource_type: int
+        resource_name: str
+        resource_pattern_type: int
+        principal: str
+        host: str
+        operation: int
+        permission_type: int
+        def __init__(
+            self,
+            *args: Any,
+            resource_type: int = ...,
+            resource_name: str = ...,
+            resource_pattern_type: int = ...,
+            principal: str = ...,
+            host: str = ...,
+            operation: int = ...,
+            permission_type: 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: ...
+
+    creations: list[AclCreation]
+    def __init__(
+        self,
+        *args: Any,
+        creations: list[AclCreation] = ...,
+        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 CreateAclsResponse(ApiMessage):
+    class AclCreationResult(DataContainer):
+        error_code: int
+        error_message: str | None
+        def __init__(
+            self,
+            *args: Any,
+            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[AclCreationResult]
+    def __init__(
+        self,
+        *args: Any,
+        throttle_time_ms: int = ...,
+        results: list[AclCreationResult] = ...,
+        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 DeleteAclsRequest(ApiMessage):
+    class DeleteAclsFilter(DataContainer):
+        resource_type_filter: int
+        resource_name_filter: str | None
+        pattern_type_filter: int
+        principal_filter: str | None
+        host_filter: str | None
+        operation: int
+        permission_type: int
+        def __init__(
+            self,
+            *args: Any,
+            resource_type_filter: int = ...,
+            resource_name_filter: str | None = ...,
+            pattern_type_filter: int = ...,
+            principal_filter: str | None = ...,
+            host_filter: str | None = ...,
+            operation: int = ...,
+            permission_type: 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: ...
+
+    filters: list[DeleteAclsFilter]
+    def __init__(
+        self,
+        *args: Any,
+        filters: list[DeleteAclsFilter] = ...,
+        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 DeleteAclsResponse(ApiMessage):
+    class DeleteAclsFilterResult(DataContainer):
+        class DeleteAclsMatchingAcl(DataContainer):
+            error_code: int
+            error_message: str | None
+            resource_type: int
+            resource_name: str
+            pattern_type: int
+            principal: str
+            host: str
+            operation: int
+            permission_type: int
+            def __init__(
+                self,
+                *args: Any,
+                error_code: int = ...,
+                error_message: str | None = ...,
+                resource_type: int = ...,
+                resource_name: str = ...,
+                pattern_type: int = ...,
+                principal: str = ...,
+                host: str = ...,
+                operation: int = ...,
+                permission_type: 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
+        error_message: str | None
+        matching_acls: list[DeleteAclsMatchingAcl]
+        def __init__(
+            self,
+            *args: Any,
+            error_code: int = ...,
+            error_message: str | None = ...,
+            matching_acls: list[DeleteAclsMatchingAcl] = ...,
+            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
+    filter_results: list[DeleteAclsFilterResult]
+    def __init__(
+        self,
+        *args: Any,
+        throttle_time_ms: int = ...,
+        filter_results: list[DeleteAclsFilterResult] = ...,
+        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 DescribeAclsRequest(ApiMessage):
+    resource_type_filter: int
+    resource_name_filter: str | None
+    pattern_type_filter: int
+    principal_filter: str | None
+    host_filter: str | None
+    operation: int
+    permission_type: int
+    def __init__(
+        self,
+        *args: Any,
+        resource_type_filter: int = ...,
+        resource_name_filter: str | None = ...,
+        pattern_type_filter: int = ...,
+        principal_filter: str | None = ...,
+        host_filter: str | None = ...,
+        operation: int = ...,
+        permission_type: 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: ...
+    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 DescribeAclsResponse(ApiMessage):
+    class DescribeAclsResource(DataContainer):
+        class AclDescription(DataContainer):
+            principal: str
+            host: str
+            operation: int
+            permission_type: int
+            def __init__(
+                self,
+                *args: Any,
+                principal: str = ...,
+                host: str = ...,
+                operation: int = ...,
+                permission_type: 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: ...
+
+        resource_type: int
+        resource_name: str
+        pattern_type: int
+        acls: list[AclDescription]
+        def __init__(
+            self,
+            *args: Any,
+            resource_type: int = ...,
+            resource_name: str = ...,
+            pattern_type: int = ...,
+            acls: list[AclDescription] = ...,
+            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
+    resources: list[DescribeAclsResource]
+    def __init__(
+        self,
+        *args: Any,
+        throttle_time_ms: int = ...,
+        error_code: int = ...,
+        error_message: str | None = ...,
+        resources: list[DescribeAclsResource] = ...,
+        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 ACLResourceType(IntEnum):
+    UNKNOWN: int
+    ANY: int
+    TOPIC: int
+    GROUP: int
+    CLUSTER: int
+    TRANSACTIONAL_ID: int
+    DELEGATION_TOKEN: int
+
+class ACLOperation(IntEnum):
+    UNKNOWN: int
+    ANY: int
+    ALL: int
+    READ: int
+    WRITE: int
+    CREATE: int
+    DELETE: int
+    ALTER: int
+    DESCRIBE: int
+    CLUSTER_ACTION: int
+    DESCRIBE_CONFIGS: int
+    ALTER_CONFIGS: int
+    IDEMPOTENT_WRITE: int
+    CREATE_TOKENS: int
+    DESCRIBE_TOKENS: int
+
+class ACLPermissionType(IntEnum):
+    UNKNOWN: int
+    ANY: int
+    DENY: int
+    ALLOW: int
+
+class ACLResourcePatternType(IntEnum):
+    UNKNOWN: int
+    ANY: int
+    MATCH: int
+    LITERAL: int
+    PREFIXED: int

kafka/protocol/admin/client_quotas.py

@@ -0,0 +1,14 @@
+from ..api_message import ApiMessage
+
+
+class AlterClientQuotasRequest(ApiMessage): pass
+class AlterClientQuotasResponse(ApiMessage): pass
+
+class DescribeClientQuotasRequest(ApiMessage): pass
+class DescribeClientQuotasResponse(ApiMessage): pass
+
+
+__all__ = [
+    'AlterClientQuotasRequest', 'AlterClientQuotasResponse',
+    'DescribeClientQuotasRequest', 'DescribeClientQuotasResponse',
+]