kio 0.0.0a0__tar.gz

kio-0.0.0a0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

kio-0.0.0a0/MANIFEST.in

@@ -0,0 +1,17 @@
+recursive-exclude .github *
+recursive-exclude docs *
+recursive-exclude tests *
+recursive-exclude codegen *
+recursive-exclude container *
+recursive-exclude benchmarks *
+exclude .editorconfig
+exclude *.yaml
+exclude *.yml
+exclude Makefile
+exclude setup.cfg
+recursive-include src py.typed
+recursive-include src *.py
+include LICENSE
+include NOTICE
+include README.md
+include pyproject.toml

kio-0.0.0a0/NOTICE

@@ -0,0 +1 @@
+Copyright 2022–2023 Aiven Ltd

kio-0.0.0a0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.1
+Name: kio
+Version: 0.0.0a0
+Summary: Python data types for the Apache Kafka® Protocol.
+Author-email: Anton Agestam <anton.agestam@aiven.io>
+License: Apache-2.0 license
+Project-URL: Source Repository, https://github.com/Aiven-Open/kio
+Project-URL: Bug Tracker, https://github.com/Aiven-Open/kio/issues
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Typing :: Typed
+Classifier: Topic :: Database
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown; charset=UTF-8
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: typing-extensions>=4.6.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: pytest-icdiff; extra == "test"
+Requires-Dist: pytest-random-order; extra == "test"
+Requires-Dist: hypothesis>=6.61.0; extra == "test"
+Requires-Dist: coverage; extra == "test"
+Provides-Extra: codegen
+Requires-Dist: pydantic<2,>=1.10.4; extra == "codegen"
+Requires-Dist: requests; extra == "codegen"
+Requires-Dist: pre-commit; extra == "codegen"
+Provides-Extra: all
+Requires-Dist: kio[test]; extra == "all"
+Requires-Dist: kio[codegen]; extra == "all"
+
+<h1 align=center>kio</h1>
+
+<p align=center>
+    <a href=https://github.com/aiven/kio/actions?query=workflow%3ACI+branch%3Amain><img src=https://github.com/aiven/kio/workflows/CI/badge.svg alt="CI Build Status"></a>
+</p>
+
+<p align=center>
+    Python data types for the Apache Kafka® Protocol.
+</p>
+
+## Features
+
+- Exposes immutable dataclass entities for all protocol messages, generated from the
+  [same source][schema-source] as used internally in Apache Kafka®.
+- Message classes are simply light-weight data containers and does not inherit anything
+  or expose any methods other than a vanilla dataclass. Encoding and decoding is enabled
+  by making all the necessary details about Kafka encoding introspectable.
+- Supports encoding and decoding of messages through `IO[bytes]`.
+- Test suite with focus on roundtrip property tests using Hypothesis.
+
+[schema-source]:
+  https://github.com/apache/kafka/tree/trunk/clients/src/main/resources/common/message
+
+## Development
+
+Install development requirements.
+
+```shell
+$ python3 -m pip install -e .[all]
+```
+
+The test suite contains integration tests that expects to be able to connect to an
+Apache Kafka® instance running on `127.0.0.1:9092`. There is a Docker Compose file in
+`container/compose.yml` that you can use to conveniently start up an instance.
+
+```shell
+$ docker compose --file=container/compose.yml up -d
+```
+
+Run tests.
+
+```shell
+$ python3 -X dev -m pytest --cov
+```
+
+Setup pre-commit to run on push.
+
+```shell
+$ pre-commit install -t pre-push
+```
+
+Fetch, generate, and format schema.
+
+```shell
+$ make build-schema
+```

kio-0.0.0a0/README.md

@@ -0,0 +1,56 @@
+<h1 align=center>kio</h1>
+
+<p align=center>
+    <a href=https://github.com/aiven/kio/actions?query=workflow%3ACI+branch%3Amain><img src=https://github.com/aiven/kio/workflows/CI/badge.svg alt="CI Build Status"></a>
+</p>
+
+<p align=center>
+    Python data types for the Apache Kafka® Protocol.
+</p>
+
+## Features
+
+- Exposes immutable dataclass entities for all protocol messages, generated from the
+  [same source][schema-source] as used internally in Apache Kafka®.
+- Message classes are simply light-weight data containers and does not inherit anything
+  or expose any methods other than a vanilla dataclass. Encoding and decoding is enabled
+  by making all the necessary details about Kafka encoding introspectable.
+- Supports encoding and decoding of messages through `IO[bytes]`.
+- Test suite with focus on roundtrip property tests using Hypothesis.
+
+[schema-source]:
+  https://github.com/apache/kafka/tree/trunk/clients/src/main/resources/common/message
+
+## Development
+
+Install development requirements.
+
+```shell
+$ python3 -m pip install -e .[all]
+```
+
+The test suite contains integration tests that expects to be able to connect to an
+Apache Kafka® instance running on `127.0.0.1:9092`. There is a Docker Compose file in
+`container/compose.yml` that you can use to conveniently start up an instance.
+
+```shell
+$ docker compose --file=container/compose.yml up -d
+```
+
+Run tests.
+
+```shell
+$ python3 -X dev -m pytest --cov
+```
+
+Setup pre-commit to run on push.
+
+```shell
+$ pre-commit install -t pre-push
+```
+
+Fetch, generate, and format schema.
+
+```shell
+$ make build-schema
+```

kio-0.0.0a0/pyproject.toml

@@ -0,0 +1,173 @@
+[project]
+name = "kio"
+authors = [
+  { name="Anton Agestam", email="anton.agestam@aiven.io" },
+]
+description = "Python data types for the Apache Kafka® Protocol."
+license = {text = "Apache-2.0 license"}
+requires-python = ">=3.11"
+classifiers = [
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.11",
+  "Typing :: Typed",
+  "Topic :: Database",
+]
+dynamic = ["version", "readme"]
+dependencies = [
+  "typing-extensions>=4.6.0",
+]
+
+[project.optional-dependencies]
+test = [
+  "pytest",
+  "pytest-asyncio",
+  "pytest-icdiff",
+  "pytest-random-order",
+  "hypothesis>=6.61.0",
+  "coverage",
+]
+codegen = [
+  "pydantic>=1.10.4,<2",
+  "requests",
+  "pre-commit",
+]
+all = [
+  "kio[test]",
+  "kio[codegen]",
+]
+
+[project.urls]
+"Source Repository" = "https://github.com/Aiven-Open/kio"
+"Bug Tracker" = "https://github.com/Aiven-Open/kio/issues"
+
+[build-system]
+requires = ["setuptools>=68.1.2", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.dynamic]
+version = {attr = "kio.__version__"}
+readme = {file = "README.md", content-type = "text/markdown; charset=UTF-8"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+namespaces = false
+
+
+[tool.black]
+target-version = ["py311"]
+
+
+[tool.pytest.ini_options]
+testpaths = ["tests", "src"]
+addopts = """\
+--doctest-modules \
+--random-order-bucket=global \
+--durations=5 \
+"""
+asyncio_mode = "auto"
+# Promote warnings to errors.
+filterwarnings = [
+  "error",
+  'ignore: ast\.[A-z]+ is deprecated:DeprecationWarning',
+  'ignore: Attribute s is deprecated and will be removed:DeprecationWarning',
+]
+
+
+[tool.ruff]
+fix = true
+target-version = "py311"
+extend-select = [
+  # bugbear
+  "B",
+  # comprehensions
+  "C4",
+  # mccabe
+  "C90",
+  # bandit
+  "S",
+  # blind exception
+  # Bare excepts are caught without this, but this also catches `except Exception: ...`.
+  "BLE",
+  # builtins
+  "A",
+  # Enforce valid noqa comments.
+  "RUF100",
+  # isort
+  "I",
+  # pycodestyle
+  "W",
+  # pyupgrade
+  "UP",
+  # debugger
+  "T10",
+  # print
+  "T20",
+  # quotes
+  "Q",
+  # simplify
+  "SIM",
+  # tidy imports
+  # We use this to only outlaw relative _parent_ imports, other relative imports are OK.
+  "TID",
+]
+extend-ignore = [
+  # There's no reason to outlaw asserts.
+  # https://stackoverflow.com/a/68429294/1220706
+  "S101",
+  # Ignore line-length. This is enforced by black, but all cases cannot be handled.
+  # Ideally we'd only suppress this in generated files.
+  "E501",
+  # Allow function calls in argument defaults.
+  "B008",
+]
+
+[tool.ruff.isort]
+force-single-line = true
+known-first-party = ["kio", "tests", "codegen"]
+
+[tool.ruff.mccabe]
+max-complexity = 10
+
+[tool.ruff.flake8-tidy-imports]
+ban-relative-imports = "parents"
+
+
+[tool.importlinter]
+root_packages = ["kio", "codegen", "tests"]
+
+[[tool.importlinter.contracts]]
+name = "kio.schema.* does not depend on kio.serial.*"
+type = "forbidden"
+source_modules = "kio.schema"
+forbidden_modules = "kio.serial"
+
+[[tool.importlinter.contracts]]
+name = "kio does not depend on codegen"
+type = "forbidden"
+source_modules = "kio"
+forbidden_modules = "codegen"
+
+[[tool.importlinter.contracts]]
+name = "kio does not depend on tests"
+type = "forbidden"
+source_modules = "kio"
+forbidden_modules = "tests"
+
+[[tool.importlinter.contracts]]
+name = "codegen does not depend on tests"
+type = "forbidden"
+source_modules = "codegen"
+forbidden_modules = "tests"
+
+[[tool.importlinter.contracts]]
+name = "kio.static.primitive is independent"
+type = "forbidden"
+source_modules = "kio.static.primitive"
+forbidden_modules = ["kio.*", "kio.schema.*"]

kio-0.0.0a0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

kio-0.0.0a0/src/kio/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.0a0"

kio-0.0.0a0/src/kio/_utils.py

@@ -0,0 +1,16 @@
+# Work-around for broken support for cache decorators in
+# https://github.com/python/typeshed/issues/6347
+# https://stackoverflow.com/a/73517689
+from typing import TYPE_CHECKING
+from typing import TypeVar
+
+__all__ = ("cache",)
+
+if TYPE_CHECKING:
+    _C = TypeVar("_C")
+
+    def cache(c: _C) -> _C:
+        return c
+
+else:
+    from functools import cache

kio-0.0.0a0/src/kio/schema/add_offsets_to_txn/v0/__init__.py

@@ -0,0 +1,7 @@
+from .request import AddOffsetsToTxnRequest
+from .response import AddOffsetsToTxnResponse
+
+__all__ = (
+    "AddOffsetsToTxnRequest",
+    "AddOffsetsToTxnResponse",
+)

kio-0.0.0a0/src/kio/schema/add_offsets_to_txn/v0/request.py

@@ -0,0 +1,33 @@
+"""
+Generated from AddOffsetsToTxnRequest.json.
+
+https://github.com/apache/kafka/tree/3.5.1/clients/src/main/resources/common/message/AddOffsetsToTxnRequest.json
+"""
+
+# ruff: noqa: A003
+
+from dataclasses import dataclass
+from dataclasses import field
+from typing import ClassVar
+
+from kio.schema.request_header.v1.header import RequestHeader
+from kio.schema.types import GroupId
+from kio.schema.types import ProducerId
+from kio.schema.types import TransactionalId
+from kio.static.primitive import i16
+
+
+@dataclass(frozen=True, slots=True, kw_only=True)
+class AddOffsetsToTxnRequest:
+    __version__: ClassVar[i16] = i16(0)
+    __flexible__: ClassVar[bool] = False
+    __api_key__: ClassVar[i16] = i16(25)
+    __header_schema__: ClassVar[type[RequestHeader]] = RequestHeader
+    transactional_id: TransactionalId = field(metadata={"kafka_type": "string"})
+    """The transactional id corresponding to the transaction."""
+    producer_id: ProducerId = field(metadata={"kafka_type": "int64"})
+    """Current producer id in use by the transactional id."""
+    producer_epoch: i16 = field(metadata={"kafka_type": "int16"})
+    """Current epoch associated with the producer id."""
+    group_id: GroupId = field(metadata={"kafka_type": "string"})
+    """The unique group identifier."""

kio-0.0.0a0/src/kio/schema/add_offsets_to_txn/v0/response.py

@@ -0,0 +1,28 @@
+"""
+Generated from AddOffsetsToTxnResponse.json.
+
+https://github.com/apache/kafka/tree/3.5.1/clients/src/main/resources/common/message/AddOffsetsToTxnResponse.json
+"""
+
+# ruff: noqa: A003
+
+from dataclasses import dataclass
+from dataclasses import field
+from typing import ClassVar
+
+from kio.schema.response_header.v0.header import ResponseHeader
+from kio.static.constants import ErrorCode
+from kio.static.primitive import i16
+from kio.static.primitive import i32Timedelta
+
+
+@dataclass(frozen=True, slots=True, kw_only=True)
+class AddOffsetsToTxnResponse:
+    __version__: ClassVar[i16] = i16(0)
+    __flexible__: ClassVar[bool] = False
+    __api_key__: ClassVar[i16] = i16(25)
+    __header_schema__: ClassVar[type[ResponseHeader]] = ResponseHeader
+    throttle_time: i32Timedelta = field(metadata={"kafka_type": "timedelta_i32"})
+    """Duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota."""
+    error_code: ErrorCode = field(metadata={"kafka_type": "error_code"})
+    """The response error code, or 0 if there was no error."""

kio-0.0.0a0/src/kio/schema/add_offsets_to_txn/v1/__init__.py

@@ -0,0 +1,7 @@
+from .request import AddOffsetsToTxnRequest
+from .response import AddOffsetsToTxnResponse
+
+__all__ = (
+    "AddOffsetsToTxnRequest",
+    "AddOffsetsToTxnResponse",
+)