https://github.com/frostming/rediswrapper

Pythonic wrapper for Redis Client.
https://github.com/frostming/rediswrapper

mock pythonic redis

Last synced: 3 months ago
JSON representation

Pythonic wrapper for Redis Client.

• Host: GitHub
• URL: https://github.com/frostming/rediswrapper
• Owner: frostming
• License: mit
• Created: 2017-05-04T04:34:53.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T01:56:51.000Z (about 2 years ago)
• Last Synced: 2024-09-08T15:48:53.323Z (4 months ago)
• Topics: mock, pythonic, redis
• Language: Python
• Size: 46.9 KB
• Stars: 10
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Redis Wrapper

=============

.. image:: https://img.shields.io/pypi/v/rediswrapper.svg

  :target: https://pypi.org/project/rediswrapper

.. image:: https://img.shields.io/pypi/pyversions/rediswrapper.svg

  :target: https://pypi.org/project/rediswrapper

.. image:: https://github.com/frostming/rediswrapper/actions/workflows/ci.yml/badge.svg

  :target: https://github.com/frostming/rediswrapper/actions/workflows/ci.yml

*rediswrapper is a pythonic wrapper of Redis Client for end users. The whole storage

acts like a python dict as well as its child storage values.*

Features

--------

* The root client support dict-like operations

* Python object wrappers for list, set, hash type values

* Implicit serialization and deserialization when storing and fetching data

Installation

------------

From PyPI::

  pip install rediswrapper

From GitHub::

  git clone https://github.com/frostming/rediswrapper

  cd rediswrapper

  pip install .

Usage

-----

``rediswrapper`` will try to serialize non-sting values and store them in redis and

deserialize them when fetching back.

All redis value types are mocked with respective python objects and support all

standard methods as the builtin types.

.. code:: python

  >>> import rediswrapper

  >>> redis = rediswrapper.RedisDict()

  # String value

  >>> redis['a'] = 'hello'

  # int value

  >>> redis['b'] = 2

  >>> dict(redis)

  {'a': 'hello', 'b': 2}

  # Picklable object

  >>> import datetime

  >>> redis['c'] = datetime.datetime.now()

  # List value

  >>> redis['d'] = list(range(5))

  >>> redis['d'].append(0)

  >>> redis['d']

  ListType value([0, 1, 2, 3, 4, 0])

  # Hash value

  >>> redis['e'] = {'a': 1, 'b': 2}

  >>> redis['e'].get('a')

  1

  # Set value

  >>> redis['f'] = set([1, 2])

  >>> redis['f'].add(3)

  >>> redis['f']

  SetType value([1, 2, 3])

To inspect those value types, one should use the ABCs defined in ``collections``

module.

.. code:: python

  >>> from collections import Mapping

  >>> isinstance(redis['e'], Mapping)

  True

History

-------

v0.4.0

    * Drop support for Python older than 3.6

v0.3.0

    * Drop support for Python 3.3

    * Fix a vulnerability issue that cause users run arbitrary scripts.

Licensing

---------

This work is open-sourced under the `MIT `_ license.