Light

zincware / znsocket Goto Github PK

View Code? Open in Web Editor NEW

2.0 1.0 0.0 202 KB

Python implementation of a Redis-compatible API using websockets.

License: Apache License 2.0

Python 100.00%

cache database key-value low-latency nosql redis socketio websocket

znsocket's Introduction

ZnSocket - Redis-like Key-Value Store in Python

ZnSocket provides a Redis-compatible API using python-socketio and Python objects for storage. It is designed for testing and applications requiring key-value storage while being easily installable via pip. For production, consider using redis-py and a Redis instance.

Important

ZnSocket is not designed for large data. The maximum size for a single communication is 100 MB. Although this value can be adapted, you will notice slow data transfers for large files.

Installation

To install ZnSocket, use:

pip install znsocket

Example

Start the ZnSocket server using the CLI:

znsocket --port 5000

For additional options, run:

znsocket --help

Here's a simple example of how to use the ZnSocket client:

from znsocket import Client

# Connect to the ZnSocket server
c = Client.from_url("znsocket://127.0.0.1:5000")

# Set and get a value
c.set("name", "Fabian")
assert c.get("name") == "Fabian"

Note

ZnSocket does not encode/decode strings. Using it is equivalent to using Redis.from_url(storage, decode_responses=True) in the Redis client.

Lists

ZnSocket provides a synchronized version of the Python list implementation. Unlike a regular Python list, the data in znsocket.List is not stored locally; instead, it is dynamically pushed to and pulled from the server.

Below is a step-by-step example of how to use znsocket.List to interact with a ZnSocket server.

from znsocket import Client, List

# Connect to the ZnSocket server using the provided URL
client = Client.from_url("znsocket://127.0.0.1:5000")

# Create a synchronized list associated with the specified key
sync_list = List(r=client, key="list:1")

# Extend the list with multiple elements
sync_list.extend(["a", "b", "c", "d"])

# Print every second element from the list
print(sync_list[::2])

Dicts

ZnSocket provides a synchronized version of the Python dict implementation similar to the list implementation.

Below is a step-by-step example of how to use znsocket.Dict to interact with a ZnSocket server.

from znsocket import Client, Dict

# Connect to the ZnSocket server using the provided URL
client = Client.from_url("znsocket://127.0.0.1:5000")

# Create a synchronized dict associated with the specified key
sync_dict = Dict(r=client, key="dict:1")

# Add an item to the synchronized dict
sync_dict["Hello"] = "World"

# Print the added item
print(sync_dict["Hello"])

znsocket's People

Contributors

Stargazers

Watchers

znsocket's Issues

implement `expire`

test for `DataError`

  File "/Users/fzills/tools/ZnDraw/zndraw/server/events.py", line 536, in room_bookmarks_set
    r.hmset(f"room:{room}:bookmarks", data)
  File "/opt/homebrew/Caskroom/miniconda/base/envs/zndraw/lib/python3.11/site-packages/redis/commands/core.py", line 5047, in hmset
    raise DataError("'hmset' with 'mapping' of length 0")
redis.exceptions.DataError: 'hmset' with 'mapping' of length 0

raise error when `smembers` is caleld on `hash`

Currently znsocket supports smembers where only hgetall should work

`set` callbacks and optional database storage

You might want to trigger a callback, e.g. send data to client that can then react on it for specific events.
E.g. client.atoms = ... should forward it to the JS clients in ZnDraw.

ensure type-consistency

At the moment saving an int will yield a string.

invesitgate the use of byte-strings

Instead of encoded data send it as byte strings for performance?

Patch redis.Redis

Allow for magic patching redis for application that use redis-py such as message queues for socketio.

`'Client' object has no attribute 'lpop'`

Implement lpop

add `List.copy` and `Dict.copy`

Check if there are some built-in methods, but in general this would allow for making a reference in the db instead of transferring everything via socket twice.

`FrozenClient` run `push`/`pull` in chunks

Create a json string and chunk it into digestible size chunks for the server to consume instead of one giant piece.

Allow arbitrary types

Use znjson to encode/decode arbitrary objects and store/load them.

implement `pubsub`

To use znsocket as message queue, e.g. for python-socketio we could implement pubsub of redis

check if patched

check if evenlet or gevent are installed and if socket / everything is monkey patched. If so, raise an error

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.