# redis-extensions
Redis-extensions is a collection of custom extensions for Redis-py.
## Installation
```
pip install redis-extensions
```
* for `base` use `pip install redis-extensions[base]`, default is `base`
* for `vcode` use `pip install redis-extensions[vcode]`
* for `gvcode` use `pip install redis-extensions[gvcode]`
* for `full - vcode gvcode etc` use `pip install redis-extensions[full]`
## Usage
```python
In [1]: import redis_extensions as redis
In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)
In [3]: r.zaddwithstamps('sorted_set', 1, 'a', 2, 'b')
Out[3]: 1
In [4]: r.zrange('sorted_set', 0, 100, withscores=True)
Out[4]: [('a', 11472205032192.0), ('b', 21472205032192.0)]
In [5]: r.zrange('sorted_set', 0, 100, withscores=True, score_cast_func=r.rawscore)
Out[5]: [('a', 1.0), ('b', 2.0)]
In [6]: r.zincrbywithstamps('sorted_set', 'a')
Out[6]: 0
In [7]: r.zrange('sorted_set', 0, 100, withscores=True)
Out[7]: [('b', 21472205032192.0), ('a', 21472205071514.0)]
In [8]: r.zrange('sorted_set', 0, 100, withscores=True, score_cast_func=r.rawscore)
Out[8]: [('b', 2.0), ('a', 2.0)]
```
## Expired
```python
In [1]: from redis_extensions import RedisExpires as exp
In [2]: exp.REDIS_EXPIRED
exp.REDIS_EXPIRED_HALF_HOUR exp.REDIS_EXPIRED_ONE_HOUR exp.REDIS_EXPIRED_ONE_WEEK
exp.REDIS_EXPIRED_ONE_DAY exp.REDIS_EXPIRED_ONE_MONTH exp.REDIS_EXPIRED_ONE_YEAR
In [2]: exp.REDIS_EXPIRED_ONE_HOUR
Out[2]: 3600
In [3]:
In [3]: import redis_extensions as redis
In [4]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)
In [5]: r.REDIS_EXPIRED
r.REDIS_EXPIRED_HALF_HOUR r.REDIS_EXPIRED_ONE_HOUR r.REDIS_EXPIRED_ONE_WEEK
r.REDIS_EXPIRED_ONE_DAY r.REDIS_EXPIRED_ONE_MONTH r.REDIS_EXPIRED_ONE_YEAR
In [5]: r.REDIS_EXPIRED_ONE_HOUR
Out[5]: 3600
```
## Warnings
```python
In [1]: import redis_extensions as redis
In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)
In [3]: r.delete_keys('redis_extensions')
``r.keys()`` used, may be very very very slow when keys' amount very large
Out[3]: 0
In [4]: r.lock_exists('redis_extensions', regex=True)
``r.keys()`` used, may be very very very slow when keys' amount very large
Out[4]: []
```
## Solutions
* Lock
```python
In [1]: import redis_extensions as redis
In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)
In [3]: r.acquire_lock('redis_extensions')
Out[3]: '026ad2a7-2b58-435f-8ba2-467458a687f1'
In [4]: r.acquire_lock('redis_extensions')
Out[4]: False
In [5]: r.release_lock('redis_extensions', '026ad2a7-2b58-435f-8ba2-467458a687f1')
Out[5]: True
In [6]: r.acquire_lock('redis_extensions', ex=10)
Out[6]: '84f6b991-7c30-4210-947a-deb56bbc769a'
In [7]: r.exists('redis:extensions:lock:redis_extensions')
Out[7]: True
In [8]: # 10 Seconds Later
In [9]: r.exists('redis:extensions:lock:redis_extensions')
Out[9]: False
```
* Quota
```python
In [1]: import redis_extensions as redis
In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)
In [3]: r.quota('redis_extensions', amount=1, time=10)
Out[3]: False
In [4]: r.quota('redis_extensions', amount=1, time=10)
Out[4]: True
```
* Quote/UnQuote
```python
In [1]: import redis_extensions as redis
In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)
In [3]: r.quote('http://a.com')
Out[3]: '6eb19fa3-9e26-457b-bb88-83ea5927ac29'
In [4]: r.unquote('6eb19fa3-9e26-457b-bb88-83ea5927ac29')
Out[4]: 'http://a.com'
```
* Token
```python
In [1]: import redis_extensions as redis
In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)
In [3]: phone = '18888888888'
In [4]: r.token(phone)
Out[4]: '8bde88aa-71e9-4dea-846c-b1684a02b0f5'
In [5]: r.token_exists(phone, '8bde88aa-71e9-4dea-846c-b1684a02b0f5')
Out[5]: True
In [6]: r.token_delete(phone)
Out[6]: 1
```
* Signin
```python
In [1]: import redis_extensions as redis
In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)
In [3]: r.signin_status('redis_extensions')
Out[3]:
{'delta_days': 10394, # Signin Interval, Check Duplicate Signin
'signed_today': False, # Signed Today Or Not
'signin_date': '1988-06-15', # Last Signin Date
'signin_days': 0, # Continuous Signin Days
'signin_longest_days': 0, # Longest Continuous Signin Days In History
'signin_total_days': 0} # Total Signin Days
In [4]: r.signin('redis_extensions')
Out[4]:
{'delta_days': 10394,
'signed_today': True,
'signin_date': '2016-11-29',
'signin_days': 1,
'signin_longest_days': 1,
'signin_total_days': 1}
In [5]: r.signin_status('redis_extensions')
Out[5]:
{'delta_days': 0,
'signed_today': True,
u'signin_date': u'2016-11-29',
u'signin_days': 1,
u'signin_longest_days': 1,
u'signin_total_days': 1}
In [6]: r.signin('redis_extensions')
Out[6]:
{'delta_days': 0, # Duplicate Signin
'signed_today': True,
u'signin_date': u'2016-11-29',
u'signin_days': 1,
u'signin_longest_days': 1,
u'signin_total_days': 1}
```
* Counter
```python
In [1]: import redis_extensions as redis
In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)
In [3]: r.counter('a')
Out[3]: (1, 0, 1) # cur, pre, incr
In [4]: r._counter_key('a')
Out[4]: 'redis:extensions:counter:a:20170215'
In [5]: r.ttl(_4)
Out[5]: 86390L
```
* Verification Code
```python
In [1]: import redis_extensions as redis
In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)
In [3]: phone = '18888888888'
In [4]: r.vcode(phone)
Out[4]: ('678366', False, False)
In [5]: r.vcode_exists(phone, '678366')
Out[5]: True
In [6]: r.vcode_delete(phone)
Out[6]: 1
```
* Graphic Verification Code
```python
In [1]: import redis_extensions as redis
In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)
In [3]: r.gvcode_initial(10)
Out[3]: 10
In [4]: r.gvcode_b64str('a')
Out[4]: 'iVBORw0KGgoAAAANSUhEUgAAAHgAAAAeCAIAAABoq03CAAACg0lEQVR4nO1aO5LCMAyVyAFCw01o4UBciCtwCSo6huEKHIACKjpGWzhrFMdf2Um8nzfMDmFs+eX5WZY9i0QE/xgfi7kJ/BVUITQizk1hdFQhtDV9idVHxApnLiz0GKStMY0fxZsHEcn6jjo9YaHjSQeJ6gbWmGW3ZYFqo9YFJVNHkChvMBSirKFqq6aEQufnwXqEmCahL2SDifOgP2bZgJnjpmrib19F1WEg5g2LlxYqGA+bOvH+9jj7Ekb8cODSZfJSekW+nRrX1ZYzFCPK0YZ31KPfUPF20+9wPqvH7oMIOZYVJDfPcPmrZ35HayBaPFXETTkE0oPYCUtyNJ/esony9SoYbB44t9ZMvxR0nMPRAZe5CMiIFTG1FblVR/8MYnwQEVarrFQLLHVaVw8R8d9PJ53cKTPLl0WC0MEsoTRXWxl02xHc7wlsEOF26z16KgE2btdot4PNxkJJAMM0+Si81WhpuEZJ63HYmMX8VGzujAEAvaEVPNusEUp1WS7h8QgHiceIBxaBEfb73uN2a+YNrUiMysCW1xCeUEQflf1B4jGWo8Hh7sggGqqg1o4OsnXNbtKSsrbP3CdrPILrMwsRXK8AiYvDKkd8BI+aOcm6RkcPA37/jXJ0iUOHc7bEwS2OTjqD2K6VhVSsSFJZEzgccsf115SSgMUdDWAa2X9lYw1ilA1JQqtezye0Lbzf0DTJBKBHnpc6CXH6l2VYMkczF/S+cLmD5HRHXcAy0aPMdTwCALQtAEDTdBHUyhCAX04lTRW3BREl2WTSG6hh9RpPYL2Gy8VUNrXwGPbKucWt6PYuiIlv8hSmE9r/epO9/MTrqThqrKN/JXL/r+NHu2xKfAGHcYJyDRb0UwAAAABJRU5ErkJggg=='
In [5]: # 显示图片
In [6]: r.gvcode_exists('a', 'm9eh')
Out[6]: True
```
## Graphic
* Web
```javascript
<img src="data:image/png;base64,b64str">
```
Raw data
{
"_id": null,
"home_page": "https://github.com/RedisClub/redis-extensions-py/tree/redis4.x+py3.7+",
"name": "redis-extensions",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Redis Extensions",
"author": "Hackathon",
"author_email": "kimi.huang@brightcells.com",
"download_url": "https://files.pythonhosted.org/packages/bc/df/d777c05250d4d7253004271e8cb070c44f49e7d2427084c789064f555293/redis-extensions-4.1.5.tar.gz",
"platform": null,
"description": "# redis-extensions\nRedis-extensions is a collection of custom extensions for Redis-py.\n\n## Installation\n```\npip install redis-extensions\n```\n* for `base` use `pip install redis-extensions[base]`, default is `base`\n* for `vcode` use `pip install redis-extensions[vcode]`\n* for `gvcode` use `pip install redis-extensions[gvcode]`\n* for `full - vcode gvcode etc` use `pip install redis-extensions[full]`\n\n## Usage\n```python\nIn [1]: import redis_extensions as redis\n\nIn [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)\n\nIn [3]: r.zaddwithstamps('sorted_set', 1, 'a', 2, 'b')\nOut[3]: 1\n\nIn [4]: r.zrange('sorted_set', 0, 100, withscores=True)\nOut[4]: [('a', 11472205032192.0), ('b', 21472205032192.0)]\n\nIn [5]: r.zrange('sorted_set', 0, 100, withscores=True, score_cast_func=r.rawscore)\nOut[5]: [('a', 1.0), ('b', 2.0)]\n\nIn [6]: r.zincrbywithstamps('sorted_set', 'a')\nOut[6]: 0\n\nIn [7]: r.zrange('sorted_set', 0, 100, withscores=True)\nOut[7]: [('b', 21472205032192.0), ('a', 21472205071514.0)]\n\nIn [8]: r.zrange('sorted_set', 0, 100, withscores=True, score_cast_func=r.rawscore)\nOut[8]: [('b', 2.0), ('a', 2.0)]\n```\n\n## Expired\n```python\nIn [1]: from redis_extensions import RedisExpires as exp\n\nIn [2]: exp.REDIS_EXPIRED\nexp.REDIS_EXPIRED_HALF_HOUR exp.REDIS_EXPIRED_ONE_HOUR exp.REDIS_EXPIRED_ONE_WEEK\nexp.REDIS_EXPIRED_ONE_DAY exp.REDIS_EXPIRED_ONE_MONTH exp.REDIS_EXPIRED_ONE_YEAR\n\nIn [2]: exp.REDIS_EXPIRED_ONE_HOUR\nOut[2]: 3600\n\nIn [3]:\n\nIn [3]: import redis_extensions as redis\n\nIn [4]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)\n\nIn [5]: r.REDIS_EXPIRED\nr.REDIS_EXPIRED_HALF_HOUR r.REDIS_EXPIRED_ONE_HOUR r.REDIS_EXPIRED_ONE_WEEK\nr.REDIS_EXPIRED_ONE_DAY r.REDIS_EXPIRED_ONE_MONTH r.REDIS_EXPIRED_ONE_YEAR\n\nIn [5]: r.REDIS_EXPIRED_ONE_HOUR\nOut[5]: 3600\n```\n\n## Warnings\n```python\nIn [1]: import redis_extensions as redis\n\nIn [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)\n\nIn [3]: r.delete_keys('redis_extensions')\n``r.keys()`` used, may be very very very slow when keys' amount very large\nOut[3]: 0\n\nIn [4]: r.lock_exists('redis_extensions', regex=True)\n``r.keys()`` used, may be very very very slow when keys' amount very large\nOut[4]: []\n```\n\n## Solutions\n* Lock\n ```python\n In [1]: import redis_extensions as redis\n\n In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)\n\n In [3]: r.acquire_lock('redis_extensions')\n Out[3]: '026ad2a7-2b58-435f-8ba2-467458a687f1'\n\n In [4]: r.acquire_lock('redis_extensions')\n Out[4]: False\n\n In [5]: r.release_lock('redis_extensions', '026ad2a7-2b58-435f-8ba2-467458a687f1')\n Out[5]: True\n\n In [6]: r.acquire_lock('redis_extensions', ex=10)\n Out[6]: '84f6b991-7c30-4210-947a-deb56bbc769a'\n\n In [7]: r.exists('redis:extensions:lock:redis_extensions')\n Out[7]: True\n\n In [8]: # 10 Seconds Later\n\n In [9]: r.exists('redis:extensions:lock:redis_extensions')\n Out[9]: False\n ```\n\n* Quota\n ```python\n In [1]: import redis_extensions as redis\n\n In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)\n\n In [3]: r.quota('redis_extensions', amount=1, time=10)\n Out[3]: False\n\n In [4]: r.quota('redis_extensions', amount=1, time=10)\n Out[4]: True\n ```\n\n* Quote/UnQuote\n ```python\n In [1]: import redis_extensions as redis\n\n In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)\n\n In [3]: r.quote('http://a.com')\n Out[3]: '6eb19fa3-9e26-457b-bb88-83ea5927ac29'\n\n In [4]: r.unquote('6eb19fa3-9e26-457b-bb88-83ea5927ac29')\n Out[4]: 'http://a.com'\n ```\n\n* Token\n ```python\n In [1]: import redis_extensions as redis\n\n In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)\n\n In [3]: phone = '18888888888'\n\n In [4]: r.token(phone)\n Out[4]: '8bde88aa-71e9-4dea-846c-b1684a02b0f5'\n\n In [5]: r.token_exists(phone, '8bde88aa-71e9-4dea-846c-b1684a02b0f5')\n Out[5]: True\n\n In [6]: r.token_delete(phone)\n Out[6]: 1\n ```\n\n* Signin\n ```python\n In [1]: import redis_extensions as redis\n\n In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)\n\n In [3]: r.signin_status('redis_extensions')\n Out[3]:\n {'delta_days': 10394, # Signin Interval, Check Duplicate Signin\n 'signed_today': False, # Signed Today Or Not\n 'signin_date': '1988-06-15', # Last Signin Date\n 'signin_days': 0, # Continuous Signin Days\n 'signin_longest_days': 0, # Longest Continuous Signin Days In History\n 'signin_total_days': 0} # Total Signin Days\n\n In [4]: r.signin('redis_extensions')\n Out[4]:\n {'delta_days': 10394,\n 'signed_today': True,\n 'signin_date': '2016-11-29',\n 'signin_days': 1,\n 'signin_longest_days': 1,\n 'signin_total_days': 1}\n\n In [5]: r.signin_status('redis_extensions')\n Out[5]:\n {'delta_days': 0,\n 'signed_today': True,\n u'signin_date': u'2016-11-29',\n u'signin_days': 1,\n u'signin_longest_days': 1,\n u'signin_total_days': 1}\n\n In [6]: r.signin('redis_extensions')\n Out[6]:\n {'delta_days': 0, # Duplicate Signin\n 'signed_today': True,\n u'signin_date': u'2016-11-29',\n u'signin_days': 1,\n u'signin_longest_days': 1,\n u'signin_total_days': 1}\n ```\n\n* Counter\n ```python\n In [1]: import redis_extensions as redis\n\n In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)\n\n In [3]: r.counter('a')\n Out[3]: (1, 0, 1) # cur, pre, incr\n\n In [4]: r._counter_key('a')\n Out[4]: 'redis:extensions:counter:a:20170215'\n\n In [5]: r.ttl(_4)\n Out[5]: 86390L\n ```\n\n* Verification Code\n ```python\n In [1]: import redis_extensions as redis\n\n In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)\n\n In [3]: phone = '18888888888'\n\n In [4]: r.vcode(phone)\n Out[4]: ('678366', False, False)\n\n In [5]: r.vcode_exists(phone, '678366')\n Out[5]: True\n\n In [6]: r.vcode_delete(phone)\n Out[6]: 1\n ```\n\n* Graphic Verification Code\n ```python\n In [1]: import redis_extensions as redis\n\n In [2]: r = redis.RedisExtensions(host='localhost', port=6379, db=0)\n\n In [3]: r.gvcode_initial(10)\n Out[3]: 10\n\n In [4]: r.gvcode_b64str('a')\n\n Out[4]: 'iVBORw0KGgoAAAANSUhEUgAAAHgAAAAeCAIAAABoq03CAAACg0lEQVR4nO1aO5LCMAyVyAFCw01o4UBciCtwCSo6huEKHIACKjpGWzhrFMdf2Um8nzfMDmFs+eX5WZY9i0QE/xgfi7kJ/BVUITQizk1hdFQhtDV9idVHxApnLiz0GKStMY0fxZsHEcn6jjo9YaHjSQeJ6gbWmGW3ZYFqo9YFJVNHkChvMBSirKFqq6aEQufnwXqEmCahL2SDifOgP2bZgJnjpmrib19F1WEg5g2LlxYqGA+bOvH+9jj7Ekb8cODSZfJSekW+nRrX1ZYzFCPK0YZ31KPfUPF20+9wPqvH7oMIOZYVJDfPcPmrZ35HayBaPFXETTkE0oPYCUtyNJ/esony9SoYbB44t9ZMvxR0nMPRAZe5CMiIFTG1FblVR/8MYnwQEVarrFQLLHVaVw8R8d9PJ53cKTPLl0WC0MEsoTRXWxl02xHc7wlsEOF26z16KgE2btdot4PNxkJJAMM0+Si81WhpuEZJ63HYmMX8VGzujAEAvaEVPNusEUp1WS7h8QgHiceIBxaBEfb73uN2a+YNrUiMysCW1xCeUEQflf1B4jGWo8Hh7sggGqqg1o4OsnXNbtKSsrbP3CdrPILrMwsRXK8AiYvDKkd8BI+aOcm6RkcPA37/jXJ0iUOHc7bEwS2OTjqD2K6VhVSsSFJZEzgccsf115SSgMUdDWAa2X9lYw1ilA1JQqtezye0Lbzf0DTJBKBHnpc6CXH6l2VYMkczF/S+cLmD5HRHXcAy0aPMdTwCALQtAEDTdBHUyhCAX04lTRW3BREl2WTSG6hh9RpPYL2Gy8VUNrXwGPbKucWt6PYuiIlv8hSmE9r/epO9/MTrqThqrKN/JXL/r+NHu2xKfAGHcYJyDRb0UwAAAABJRU5ErkJggg=='\n\n In [5]: # \u663e\u793a\u56fe\u7247\n\n In [6]: r.gvcode_exists('a', 'm9eh')\n Out[6]: True\n ```\n\n## Graphic\n\n* Web\n\n ```javascript\n <img src=\"data:image/png;base64,b64str\">\n ```\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Redis-extensions is a collection of custom extensions for Redis-py.",
"version": "4.1.5",
"split_keywords": [
"redis",
"extensions"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f6ac86aa997b7bd187c2d765352bff64237fd5e9fd9f7355c888a0b9e6f78bcf",
"md5": "413f95f868cdd10fa588491a31bae2cc",
"sha256": "887246279a1d695541799cadf84dfe7c7a76fd6b52d6572bd887af4185246046"
},
"downloads": -1,
"filename": "redis_extensions-4.1.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "413f95f868cdd10fa588491a31bae2cc",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 16962,
"upload_time": "2023-01-30T09:44:43",
"upload_time_iso_8601": "2023-01-30T09:44:43.008478Z",
"url": "https://files.pythonhosted.org/packages/f6/ac/86aa997b7bd187c2d765352bff64237fd5e9fd9f7355c888a0b9e6f78bcf/redis_extensions-4.1.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bcdfd777c05250d4d7253004271e8cb070c44f49e7d2427084c789064f555293",
"md5": "0a1cf42874a10a16292f87580b31ee64",
"sha256": "e464af3937a3c6e789af4120cd688027542789cccd480bfd78316019bdfb0596"
},
"downloads": -1,
"filename": "redis-extensions-4.1.5.tar.gz",
"has_sig": false,
"md5_digest": "0a1cf42874a10a16292f87580b31ee64",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 19854,
"upload_time": "2023-01-30T09:44:45",
"upload_time_iso_8601": "2023-01-30T09:44:45.206781Z",
"url": "https://files.pythonhosted.org/packages/bc/df/d777c05250d4d7253004271e8cb070c44f49e7d2427084c789064f555293/redis-extensions-4.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-30 09:44:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "redis-extensions"
}
JSON