valkey-glide 1.3.5__pp39-pypy39_pp73-macosx_10_7_x86_64.whl

glide/routes.py

@@ -0,0 +1,114 @@
+# Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
+
+from enum import Enum
+from typing import Optional
+
+from glide.exceptions import RequestError
+from glide.protobuf.command_request_pb2 import CommandRequest, SimpleRoutes
+from glide.protobuf.command_request_pb2 import SlotTypes as ProtoSlotTypes
+
+
+class SlotType(Enum):
+    PRIMARY = 1
+    # `REPLICA` overrides the `read_from_replica` configuration. If it's used the request
+    # will be routed to a replica, even if the strategy is `ALWAYS_FROM_MASTER`.
+    REPLICA = 2
+
+
+class Route:
+    def __init__(self) -> None:
+        pass
+
+
+# cluster routes
+
+
+class AllNodes(Route):
+    """
+    Route request to all nodes.
+    Warning:
+        Don't use it with write commands, they could be routed to a replica (RO) node and fail.
+    """
+
+    pass
+
+
+class AllPrimaries(Route):
+    pass
+
+
+class RandomNode(Route):
+    """
+    Route request to a random node.
+    Warning:
+        Don't use it with write commands, because they could be randomly routed to a replica (RO) node and fail.
+    """
+
+    pass
+
+
+class SlotKeyRoute(Route):
+    def __init__(self, slot_type: SlotType, slot_key: str) -> None:
+        super().__init__()
+        self.slot_type = slot_type
+        self.slot_key = slot_key
+
+
+class SlotIdRoute(Route):
+    def __init__(self, slot_type: SlotType, slot_id: int) -> None:
+        super().__init__()
+        self.slot_type = slot_type
+        self.slot_id = slot_id
+
+
+class ByAddressRoute(Route):
+    def __init__(self, host: str, port: Optional[int] = None) -> None:
+        """Routes a request to a node by its address
+
+        Args:
+            host (str): The endpoint of the node. If `port` is not provided, should be in the f"{address}:{port}" format, where `address` is the preferred endpoint as shown in the output of the `CLUSTER SLOTS` command.
+            port (Optional[int]): The port to access on the node. If port is not provided, `host` is assumed to be in the format f"{address}:{port}".
+        """
+        super().__init__()
+        if port is None:
+            split = host.split(":")
+            if len(split) < 2:
+                raise RequestError(
+                    "No port provided, expected host to be formatted as {hostname}:{port}`. Received "
+                    + host
+                )
+            self.host = split[0]
+            self.port = int(split[1])
+        else:
+            self.host = host
+            self.port = port
+
+
+def to_protobuf_slot_type(slot_type: SlotType) -> ProtoSlotTypes.ValueType:
+    return (
+        ProtoSlotTypes.Primary
+        if slot_type == SlotType.PRIMARY
+        else ProtoSlotTypes.Replica
+    )
+
+
+def set_protobuf_route(request: CommandRequest, route: Optional[Route]) -> None:
+    if route is None:
+        return
+    elif isinstance(route, AllNodes):
+        request.route.simple_routes = SimpleRoutes.AllNodes
+    elif isinstance(route, AllPrimaries):
+        request.route.simple_routes = SimpleRoutes.AllPrimaries
+    elif isinstance(route, RandomNode):
+        request.route.simple_routes = SimpleRoutes.Random
+    elif isinstance(route, SlotKeyRoute):
+        request.route.slot_key_route.slot_type = to_protobuf_slot_type(route.slot_type)
+        request.route.slot_key_route.slot_key = route.slot_key
+    elif isinstance(route, SlotIdRoute):
+        request.route.slot_id_route.slot_type = to_protobuf_slot_type(route.slot_type)
+        request.route.slot_id_route.slot_id = route.slot_id
+    elif isinstance(route, ByAddressRoute):
+        request.route.by_address_route.host = route.host
+        request.route.by_address_route.port = route.port
+    else:
+        raise RequestError(f"Received invalid route type: {type(route)}")

valkey_glide-1.3.5.dist-info/METADATA

@@ -0,0 +1,125 @@
+Metadata-Version: 2.1
+Name: valkey-glide
+Version: 1.3.5
+Classifier: Topic :: Database
+Classifier: Topic :: Utilities
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Dist: async-timeout>=4.0.2; python_version < '3.11'
+Requires-Dist: typing-extensions>=4.8.0; python_version < '3.11'
+Requires-Dist: protobuf>=3.20
+Summary: An open source Valkey client library that supports Valkey and Redis open source 6.2, 7.0, 7.2 and 8.0.
+Author: Valkey GLIDE Maintainers
+License: Apache-2.0
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# Valkey GLIDE
+
+Valkey General Language Independent Driver for the Enterprise (GLIDE), is an open-source Valkey client library. Valkey GLIDE is one of the official client libraries for Valkey, and it supports all Valkey commands. Valkey GLIDE supports Valkey 7.2 and above, and Redis open-source 6.2, 7.0 and 7.2. Application programmers use Valkey GLIDE to safely and reliably connect their applications to Valkey- and Redis OSS- compatible services. Valkey GLIDE is designed for reliability, optimized performance, and high-availability, for Valkey and Redis OSS based applications. It is sponsored and supported by AWS, and is pre-configured with best practices learned from over a decade of operating Redis OSS-compatible services used by hundreds of thousands of customers. To help ensure consistency in application development and operations, Valkey GLIDE is implemented using a core driver framework, written in Rust, with language specific extensions. This design ensures consistency in features across languages and reduces overall complexity.
+
+## Supported Engine Versions
+
+Refer to the [Supported Engine Versions table](https://github.com/valkey-io/valkey-glide/blob/main/README.md#supported-engine-versions) for details.
+
+# Getting Started - Python Wrapper
+
+## System Requirements
+
+The release of Valkey GLIDE was tested on the following platforms:
+
+Linux:
+
+-   Ubuntu 22.04.1 (x86_64 and aarch64)
+-   Amazon Linux 2023 (AL2023) (x86_64)
+
+macOS:
+
+- macOS (Apple silicon/aarch_64 and Intel/x86_64)
+Testing are being done on macOS arm64 platforms. 
+Please note that the package is not tested on macOS intel platforms, only minimal testing is done during CD.
+
+## Python Supported Versions
+
+| Python Version |
+|----------------|
+| 3.9            |
+| 3.10           |
+| 3.11           |
+| 3.12           |
+| 3.13           |
+
+## Installation and Setup
+
+### Installing via Package Manager (pip)
+
+To install Valkey GLIDE using `pip`, follow these steps:
+
+1. Open your terminal.
+2. Execute the command below:
+    ```bash
+    $ pip install valkey-glide
+    ```
+3. After installation, confirm the client is accessible by running:
+    ```bash
+    $ python3
+    >>> import glide
+    ```
+
+## Basic Examples
+
+#### Cluster Mode:
+
+```python:
+>>> import asyncio
+>>> from glide import GlideClusterClientConfiguration, NodeAddress, GlideClusterClient
+>>> async def test_cluster_client():
+...     addresses = [NodeAddress("address.example.com", 6379)]
+...     config = GlideClusterClientConfiguration(addresses)
+...     client = await GlideClusterClient.create(config)
+...     set_result = await client.set("foo", "bar")
+...     print(f"Set response is {set_result}")
+...     get_result = await client.get("foo")
+...     print(f"Get response is {get_result}")
+... 
+>>> asyncio.run(test_cluster_client())
+Set response is OK
+Get response is bar
+```
+
+#### Standalone Mode:
+
+```python:
+>>> import asyncio
+>>> from glide import GlideClientConfiguration, NodeAddress, GlideClient
+>>> async def test_standalone_client():
+...     addresses = [
+...             NodeAddress("server_primary.example.com", 6379),
+...             NodeAddress("server_replica.example.com", 6379)
+...     ]
+...     config = GlideClientConfiguration(addresses)
+...     client = await GlideClient.create(config)
+...     set_result = await client.set("foo", "bar")
+...     print(f"Set response is {set_result}")
+...     get_result = await client.get("foo")
+...     print(f"Get response is {get_result}")
+... 
+>>> asyncio.run(test_standalone_client())
+Set response is OK
+Get response is bar
+```
+
+For complete examples with error handling, please refer to the [cluster example](https://github.com/valkey-io/valkey-glide/blob/main/examples/python/cluster_example.py) and the [standalone example](https://github.com/valkey-io/valkey-glide/blob/main/examples/python/standalone_example.py).
+
+## Documentation
+
+Visit our [wiki](https://github.com/valkey-io/valkey-glide/wiki/Python-wrapper) for examples and further details on TLS, Read strategy, Timeouts and various other configurations.
+
+### Building & Testing
+
+Development instructions for local building & testing the package are in the [DEVELOPER.md](https://github.com/valkey-io/valkey-glide/blob/main/python/DEVELOPER.md#build-from-source) file.
+

valkey_glide-1.3.5.dist-info/RECORD

@@ -0,0 +1,37 @@
+valkey_glide-1.3.5.dist-info/METADATA,sha256=qyLsphqAtRf6Y93JnP9RPOcCi7slKawgNy-LlmAWZys,5116
+valkey_glide-1.3.5.dist-info/WHEEL,sha256=p99NWwcjJuNqiQFdVZaMhdRHjtoUBT0X2w8hBl2qIME,112
+glide/config.py,sha256=5kpn5OKkuzNHaRe7kpmLxlJNZ3D8V_H2t3k4DnVqAEQ,27648
+glide/protobuf_codec.py,sha256=3tQnc3L-y1VoNLggN6FyYFR4POkgZLfu-xYAKE2dN8M,3623
+glide/constants.py,sha256=B_mMzUS48ulnpQhv4h_NecRNTTENl6CuEl6OuJURYEI,4346
+glide/async_commands/sorted_set.py,sha256=swS10R7AwEY8cNI3XlxUkfvlV_R9kx9fvN2encofmUg,11384
+glide/async_commands/transaction.py,sha256=f3U5e3qtppXvsXLdIlwYCZFckyxtsVowQlCZjjBWHxE,222911
+glide/async_commands/__init__.py,sha256=_tbTAFATlzp4L2qe-H77PpAQK-16VsV-y7uKNUKLC_o,136
+glide/async_commands/core.py,sha256=9M09GMvxCIcyN9c93_qUwG_gFi6O-bn5J9Cro-74Fec,308681
+glide/async_commands/server_modules/glide_json.py,sha256=JAoPqjtJH0XDWCKVigHwwghMJGYTTSYKTLT80W89WWw,61278
+glide/async_commands/server_modules/json_batch.py,sha256=wBGOplaOp9ALJsAUJkTlrTmvO2ZWu044_4LKJqQd7Cg,36786
+glide/async_commands/server_modules/ft.py,sha256=ysNIKNSU69j2pbl-_lWWxznklId2_4G88_bX4UyeUiQ,15507
+glide/async_commands/server_modules/ft_options/ft_search_options.py,sha256=PN1m9gJ1V6CZrFLb3Espoa7THr6puk1J8H-lH_yEUeI,4759
+glide/async_commands/server_modules/ft_options/ft_aggregate_options.py,sha256=No9LxyQ25-x7943guocs0vrwnzx-ruq8Oi7GWAlezww,9849
+glide/async_commands/server_modules/ft_options/ft_create_options.py,sha256=9VCsI47tyyG5ai4Gy1mOl3HCha8AMK7mI1GMGCfJkeM,13529
+glide/async_commands/server_modules/ft_options/ft_profile_options.py,sha256=s4XSiKpjFjBbtC5oCf6ddNYImf6ag7KvFcgOk2dNbYs,4185
+glide/async_commands/server_modules/ft_options/ft_constants.py,sha256=r9uLAExg2qThjwOBC8LxqXBITF0fwa5xfnD7EXnyPrw,1704
+glide/async_commands/stream.py,sha256=U7n2HPmHpcK1mmbI68szphZqjAoGPJTLOZscgw0WEK0,15791
+glide/async_commands/standalone_commands.py,sha256=RrumL-O2rt6yPYS9QtftY1rebAcqxoshLsQvf_8GCMo,34742
+glide/async_commands/cluster_commands.py,sha256=JjYuJbIkipQGllzwSJGvWzM88frFQenk1LTFY2qJueI,54315
+glide/async_commands/command_args.py,sha256=Lz-Rl9pXtEcQ4hhcRns23x0dVPQ0shpqQw1a0vxFGAI,2561
+glide/async_commands/bitmap.py,sha256=eYKfA1Xuikr7nXxCVGRsZ9RFKJOU_QN4nLXXTRtBSgU,10325
+glide/__init__.py,sha256=2YpdncnGRo9mHjXVPBvLn2MuvllaMp7-HemVgQYmbA0,7328
+glide/glide.pyi,sha256=K2CeC-F0E8vlr-rbko-E0PofzFoWl4da-xUQSuvuFDo,1105
+glide/glide_client.py,sha256=g_HK93WjNYTJn1H_q1T5t6Cvym2Av5z2aCdYLXQsWLA,24356
+glide/logger.py,sha256=zP_ENonH15lEvXlAYo1yg0QoJmHyZgEkI8H2-kO_QuY,3804
+glide/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+glide/exceptions.py,sha256=ZI_LwIduoR-1jHm9-6jWZkx90AqCJLRtjbv4iESIEEA,1194
+glide/protobuf/response_pb2.pyi,sha256=1US9ekAXkanJnzwArqHzj4NezV8TJl36QADmiAFqlKg,4076
+glide/protobuf/connection_request_pb2.pyi,sha256=uwyWm81mAjtKnGGJFUoJVGr9_ou0xAxYd_ERgM7OXTw,12391
+glide/protobuf/command_request_pb2.py,sha256=7BYmHeBKF76Yk911Nmeq5jwEGzjiOaHFnka08L6DOkI,18481
+glide/protobuf/connection_request_pb2.py,sha256=LcB4WVCmhQEJ7n7Rx6VZyr6dIAh3zdF0PuYga6EeQBA,5221
+glide/protobuf/command_request_pb2.pyi,sha256=QnRKhSy1jPbPBtHJsdbQyFWYGQkNZ8CVyG1IsZBYPBk,49860
+glide/protobuf/response_pb2.py,sha256=r3_OFhf8HZvEmBSigSyBzG7S7kWl7CCgVMog4HgMFXM,2025
+glide/routes.py,sha256=riaUkzI36tq4Lhsn11H7uSBdx7HfSvdT9YXxNabMNKk,3699
+glide/glide.pypy39-pp73-darwin.so,sha256=Yfl_HDxJpDWV2fJmZ3Uhg99irhKfTJ63TR7LmnMlKas,4547544
+valkey_glide-1.3.5.dist-info/RECORD,,

valkey_glide-1.3.5.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (0.14.17)
+Root-Is-Purelib: false
+Tag: pp39-pypy39_pp73-macosx_10_7_x86_64