openkache 0.1.3__py3-none-win_amd64.whl

openkache-0.1.3.data/purelib/openkache/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

openkache-0.1.3.data/purelib/openkache/__init__.py

@@ -0,0 +1,75 @@
+"""Python client for the OpenKache cache server."""
+
+from ._client import (
+    Client,
+    OpenKacheClient,
+    OpenKacheError,
+    OpenKacheIncompatibleServerError,
+    OpenKacheResourceLimitError,
+    OpenKacheUnknownMutationError,
+    OpenKacheValueError,
+    SetOutcome,
+    ValueRepresentation,
+)
+from ._value import (
+    Array,
+    ArrayValue,
+    ByteString,
+    ByteStringValue,
+    Float,
+    FloatValue,
+    Integer,
+    IntegerValue,
+    Map,
+    MapValue,
+    StructuredValueError,
+    TextString,
+    TextStringValue,
+    UNDEFINED,
+    Undefined,
+    UndefinedValue,
+    Value,
+    ValueErrorKind,
+    ValueLimits,
+    decode_value,
+    encode_value,
+    model_equal,
+    to_native,
+    to_value,
+)
+
+__all__ = [
+    "Array",
+    "ArrayValue",
+    "ByteString",
+    "ByteStringValue",
+    "Client",
+    "Float",
+    "FloatValue",
+    "Integer",
+    "IntegerValue",
+    "Map",
+    "MapValue",
+    "OpenKacheClient",
+    "OpenKacheError",
+    "OpenKacheIncompatibleServerError",
+    "OpenKacheResourceLimitError",
+    "OpenKacheUnknownMutationError",
+    "OpenKacheValueError",
+    "SetOutcome",
+    "ValueRepresentation",
+    "StructuredValueError",
+    "TextString",
+    "TextStringValue",
+    "UNDEFINED",
+    "Undefined",
+    "UndefinedValue",
+    "Value",
+    "ValueErrorKind",
+    "ValueLimits",
+    "decode_value",
+    "encode_value",
+    "model_equal",
+    "to_native",
+    "to_value",
+]

openkache-0.1.3.data/purelib/openkache/_client.py

@@ -0,0 +1,422 @@
+"""Small synchronous client for the OpenKache cache server.
+
+Mapped keys use the shared key contract and values travel through
+``StructuredValue-CBOR-v1``.
+"""
+
+from __future__ import annotations
+
+import socket
+from enum import StrEnum
+from typing import Final, Literal, NoReturn, overload
+
+from ._generated.smithy_contract import (
+    SMITHY_MAX_CANONICAL_KEY_BYTES,
+    SMITHY_FFI_RESULT_CREATED,
+    SMITHY_FFI_RESULT_DELETED,
+    SMITHY_FFI_RESULT_NOT_DELETED,
+    SMITHY_FFI_RESULT_NOT_FOUND,
+    SMITHY_FFI_RESULT_NOT_STORED,
+    SMITHY_FFI_RESULT_REPLACED,
+    SMITHY_FFI_RESULT_RESOURCE_EXHAUSTED,
+    SMITHY_FFI_RESULT_UNKNOWN_MUTATION,
+    SMITHY_FFI_RESULT_VALUE,
+    SMITHY_OPCODE_DELETE,
+)
+from ._native import NativeClient as _NativeClient, NativeError
+from ._value import (
+    StructuredValueError,
+    Value,
+    decode_value,
+    encode_value,
+    to_native,
+)
+
+
+_I64_MIN: Final = -(1 << 63)
+_I64_MAX: Final = (1 << 63) - 1
+ValueRepresentation = Literal["native", "lossless"]
+
+
+class OpenKacheError(RuntimeError):
+    """Base exception raised by the client."""
+
+
+class OpenKacheValueError(OpenKacheError, ValueError):
+    """Invalid key, value, or local value-codec input."""
+
+
+class OpenKacheResourceLimitError(OpenKacheError):
+    """A native operation exceeded a stable OpenKache resource limit."""
+
+    kind = "resource_limit"
+
+
+class OpenKacheUnknownMutationError(OpenKacheError):
+    """A mutation may have reached the server without a definitive outcome."""
+
+    kind = "unknown_mutation"
+
+
+class OpenKacheIncompatibleServerError(OpenKacheError):
+    """The server returned an outcome outside the supported client API."""
+
+    kind = "incompatible_server_outcome"
+
+
+# This spelling existed in the preview package. Keep it importable for code that
+# only catches the error; the client never exposes cancellation controls.
+UnknownMutationError = OpenKacheUnknownMutationError
+
+
+class SetOutcome(StrEnum):
+    """The server's definitive SET result."""
+
+    CREATED = "created"
+    REPLACED = "replaced"
+
+
+def _set_outcome(kind: object) -> SetOutcome:
+    if isinstance(kind, SetOutcome):
+        return kind
+    if isinstance(kind, str):
+        if kind == "not_stored":
+            raise OpenKacheIncompatibleServerError(
+                "SET returned the unsupported conditional outcome 'not_stored'"
+            )
+        try:
+            return SetOutcome(kind)
+        except ValueError as error:
+            raise OpenKacheError(f"SET returned unexpected native result {kind!r}") from error
+    try:
+        numeric_kind = int(kind)
+    except (TypeError, ValueError) as error:
+        raise OpenKacheError(f"SET returned unexpected native result {kind!r}") from error
+    if numeric_kind == SMITHY_FFI_RESULT_NOT_STORED:
+        raise OpenKacheIncompatibleServerError(
+            "SET returned the unsupported conditional outcome 'not_stored'"
+        )
+    try:
+        return {
+            SMITHY_FFI_RESULT_CREATED: SetOutcome.CREATED,
+            SMITHY_FFI_RESULT_REPLACED: SetOutcome.REPLACED,
+        }[numeric_kind]
+    except KeyError as error:
+        raise OpenKacheError(f"SET returned unexpected native result {kind!r}") from error
+
+
+def _delete_result(kind: object) -> bool:
+    """Map the native DELETE result to whether an item was removed."""
+
+    if isinstance(kind, bool):
+        return kind
+    if isinstance(kind, str):
+        if kind == "deleted":
+            return True
+        if kind in {"not_deleted", "not_found"}:
+            return False
+        raise OpenKacheError(f"DELETE returned unexpected native result {kind!r}")
+    try:
+        if int(kind) == SMITHY_FFI_RESULT_DELETED:
+            return True
+        if int(kind) == SMITHY_FFI_RESULT_NOT_DELETED:
+            return False
+    except (TypeError, ValueError):
+        pass
+    raise OpenKacheError(f"DELETE returned unexpected native result {kind!r}")
+
+
+class OpenKacheClient:
+    """Synchronous structured-value client with a deliberately small API."""
+
+    def __init__(self, native: _NativeClient) -> None:
+        self._native = native
+        self._closed = False
+
+    @classmethod
+    def connect(cls, address: str) -> OpenKacheClient:
+        """Open one development QUIC-over-TLS 1.3 connection.
+
+        The local development profile disables certificate verification and
+        uses a fixed local-development namespace and structured-value format.
+        Production authentication configuration is not available in this
+        client yet.
+        """
+
+        native_address = _resolve_address(address)
+        try:
+            native = _NativeClient.connect_gate0(address=native_address.encode("ascii"))
+        except NativeError as error:
+            _raise_native_error(error)
+        except OSError as error:
+            raise OpenKacheError(str(error)) from error
+        return cls(native)
+
+    @overload
+    def get(
+        self,
+        key: str | int | bytes | bytearray | memoryview,
+        *,
+        representation: Literal["native"] = "native",
+    ) -> object | None: ...
+
+    @overload
+    def get(
+        self,
+        key: str | int | bytes | bytearray | memoryview,
+        *,
+        representation: Literal["lossless"],
+    ) -> Value | None: ...
+
+    def get(
+        self,
+        key: str | int | bytes | bytearray | memoryview,
+        *,
+        representation: ValueRepresentation = "native",
+    ) -> object | Value | None:
+        """Read one value as a native value or a lossless model.
+
+        ``None`` means that the key is absent. Stored ``Null`` and
+        ``Undefined`` values also project to ``None`` in the native view,
+        matching ordinary Python cache APIs. Pass
+        ``representation="lossless"`` to retain ``Undefined``, integer/float
+        distinctions, raw float bits, byte/text kinds, and scalar-key map
+        identity.
+        """
+
+        self._assert_open()
+        if representation not in ("native", "lossless"):
+            raise OpenKacheValueError(
+                "representation must be 'native' or 'lossless'"
+            )
+        key_bytes = _key_bytes(key)
+        operation = getattr(self._native, "get_structured", None)
+        if not callable(operation):
+            raise OpenKacheError(
+                "native client does not support StructuredValue-CBOR-v1"
+            )
+        try:
+            result = operation(key=key_bytes)
+        except NativeError as error:
+            _raise_native_error(error)
+        kind, payload = _read_result(result, operation_name="GET")
+        if kind == SMITHY_FFI_RESULT_NOT_FOUND:
+            return None
+        if kind != SMITHY_FFI_RESULT_VALUE:
+            raise OpenKacheError(f"GET returned unexpected native result {kind!r}")
+        try:
+            model = decode_value(payload)
+        except StructuredValueError as error:
+            raise OpenKacheValueError(
+                f"StructuredValue-CBOR-v1 decoding failed: {error}"
+            ) from error
+        if representation == "lossless":
+            return model
+        try:
+            value = to_native(model)
+        except StructuredValueError as error:
+            raise OpenKacheValueError(
+                f"native value projection failed: {error}"
+            ) from error
+        return value
+
+    def set(
+        self,
+        key: str | int | bytes | bytearray | memoryview,
+        value: object,
+    ) -> SetOutcome:
+        """Encode and store one value through StructuredValue-CBOR-v1."""
+
+        self._assert_open()
+        try:
+            payload = encode_value(value)
+        except StructuredValueError as error:
+            raise OpenKacheValueError(
+                f"StructuredValue-CBOR-v1 encoding failed: {error}"
+            ) from error
+        operation = getattr(self._native, "set_structured", None)
+        if not callable(operation):
+            raise OpenKacheError(
+                "native client does not support StructuredValue-CBOR-v1"
+            )
+        try:
+            result = operation(
+                key=_key_bytes(key),
+                value=payload,
+                set_flags=0,
+                ttl_ms=0,
+            )
+        except NativeError as error:
+            _raise_native_error(error)
+        kind, _ = _read_result(result, operation_name="SET")
+        return _set_outcome(kind)
+
+    def delete(self, key: str | int | bytes | bytearray | memoryview) -> bool:
+        """Delete one mapped key and return whether an item was removed."""
+
+        self._assert_open()
+        try:
+            result = self._native.execute_with_options(
+                SMITHY_OPCODE_DELETE,
+                key=_key_bytes(key),
+                value=b"",
+                set_flags=0,
+                ttl_ms=0,
+            )
+        except NativeError as error:
+            _raise_native_error(error)
+        kind, _ = _read_result(result, operation_name="DELETE")
+        return _delete_result(kind)
+
+    def close(self) -> None:
+        """Release the native connection; repeated calls are harmless."""
+
+        if self._closed:
+            return
+        self._closed = True
+        self._native.close()
+
+    def __enter__(self) -> OpenKacheClient:
+        self._assert_open()
+        return self
+
+    def __exit__(self, *_: object) -> None:
+        self.close()
+
+    def _assert_open(self) -> None:
+        if self._closed:
+            raise OpenKacheError("client is closed")
+
+Client = OpenKacheClient
+
+
+def _read_result(result: object, *, operation_name: str) -> tuple[object, bytes]:
+    """Normalize native tuple results and simple fake-adapter results."""
+
+    if isinstance(result, tuple):
+        if len(result) != 2:
+            raise OpenKacheError(
+                f"{operation_name} returned a malformed native result"
+            )
+        kind, payload = result
+    elif result is None:
+        return SMITHY_FFI_RESULT_NOT_FOUND, b""
+    else:
+        kind, payload = SMITHY_FFI_RESULT_VALUE, result
+    if payload is None:
+        return kind, b""
+    if isinstance(payload, bytes):
+        return kind, payload
+    if isinstance(payload, (bytearray, memoryview)):
+        return kind, bytes(payload)
+    raise OpenKacheError(f"{operation_name} returned a non-byte payload")
+
+
+def _raise_native_error(error: NativeError) -> NoReturn:
+    if error.result_kind == SMITHY_FFI_RESULT_UNKNOWN_MUTATION:
+        raise OpenKacheUnknownMutationError(str(error)) from error
+    if error.result_kind == SMITHY_FFI_RESULT_RESOURCE_EXHAUSTED:
+        raise OpenKacheResourceLimitError(str(error)) from error
+    raise OpenKacheError(str(error)) from error
+
+
+def _resolve_address(address: str) -> str:
+    """Validate and normalize one host:port endpoint for the native ABI."""
+
+    if not isinstance(address, str) or not address:
+        raise OpenKacheValueError("address must be a non-empty host:port string")
+    if address.startswith("["):
+        closing = address.find("]")
+        if closing < 0 or closing + 1 >= len(address) or address[closing + 1] != ":":
+            raise OpenKacheValueError("address must use [ipv6]:port syntax")
+        host, port_text = address[1:closing], address[closing + 2 :]
+    else:
+        try:
+            host, port_text = address.rsplit(":", 1)
+        except ValueError as error:
+            raise OpenKacheValueError("address must include a transport port") from error
+    if not host or not port_text.isdecimal():
+        raise OpenKacheValueError("address must contain a host and numeric transport port")
+    port = int(port_text)
+    if not 1 <= port <= 65_535:
+        raise OpenKacheValueError("address port must be between 1 and 65535")
+    try:
+        infos = socket.getaddrinfo(host, port, type=0)
+    except OSError as error:
+        raise OpenKacheError(f"address DNS resolution failed: {error}") from error
+    for family, _, _, _, sockaddr in infos:
+        if family == socket.AF_INET:
+            return f"{sockaddr[0]}:{sockaddr[1]}"
+        if family == socket.AF_INET6:
+            return f"[{sockaddr[0]}]:{sockaddr[1]}"
+    raise OpenKacheError(f"address did not resolve to a transport endpoint: {address}")
+
+
+def _key_bytes(value: str | int | bytes | bytearray | memoryview) -> bytes:
+    """Encode one mapped key using canonical TypedKey CBOR."""
+
+    if isinstance(value, str):
+        try:
+            payload = value.encode("utf-8")
+        except UnicodeEncodeError as error:
+            raise OpenKacheValueError("key must contain valid UTF-8 text") from error
+        return _canonical_cbor_string(3, payload)
+    if isinstance(value, (bytes, bytearray, memoryview)):
+        return _canonical_cbor_string(2, bytes(value))
+    if isinstance(value, bool):
+        raise OpenKacheValueError("boolean keys are not supported")
+    if isinstance(value, int):
+        return _canonical_cbor_integer(value)
+    raise OpenKacheValueError(
+        "key must be a signed-i64 integer, UTF-8 string, or bytes-like value"
+    )
+
+
+def _canonical_cbor_string(major: int, payload: bytes) -> bytes:
+    header = _canonical_cbor_argument(major, len(payload))
+    total = len(header) + len(payload)
+    if total > SMITHY_MAX_CANONICAL_KEY_BYTES:
+        raise OpenKacheValueError(
+            f"canonical key exceeds {SMITHY_MAX_CANONICAL_KEY_BYTES} bytes"
+        )
+    return header + payload
+
+
+def _canonical_cbor_argument(major: int, value: int) -> bytes:
+    if major not in (0, 1, 2, 3) or value < 0:
+        raise OpenKacheValueError("invalid canonical CBOR key argument")
+    prefix = major << 5
+    if value <= 23:
+        return bytes((prefix | value,))
+    if value <= 0xFF:
+        return bytes((prefix | 24, value))
+    if value <= 0xFFFF:
+        return bytes((prefix | 25,)) + value.to_bytes(2, "big")
+    if value <= 0xFFFF_FFFF:
+        return bytes((prefix | 26,)) + value.to_bytes(4, "big")
+    if value <= 0xFFFF_FFFF_FFFF_FFFF:
+        return bytes((prefix | 27,)) + value.to_bytes(8, "big")
+    raise OpenKacheValueError("canonical key length exceeds CBOR uint64")
+
+
+def _canonical_cbor_integer(value: int) -> bytes:
+    if isinstance(value, bool) or not isinstance(value, int):
+        raise OpenKacheValueError("key must be an integer")
+    if value < _I64_MIN or value > _I64_MAX:
+        raise OpenKacheValueError("integer keys must fit signed i64")
+    negative = value < 0
+    transformed = -value - 1 if negative else value
+    return _canonical_cbor_argument(1 if negative else 0, transformed)
+
+
+__all__ = [
+    "Client",
+    "OpenKacheClient",
+    "OpenKacheError",
+    "OpenKacheIncompatibleServerError",
+    "OpenKacheResourceLimitError",
+    "OpenKacheUnknownMutationError",
+    "OpenKacheValueError",
+    "SetOutcome",
+    "ValueRepresentation",
+]