Psion-fanatic/platypush
1
0
Fork 0
forked from platypush/platypush
Code Pull requests Activity

Added support for Redis-stored variables in variables plugin

Browse source
This commit is contained in:
Fabio Manganiello 2018-09-06 09:31:31 +02:00
parent cccb48c533
commit 5762c51019
2 changed files with 50 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
platypush/plugins/redis.py
View file

@ -44,10 +44,13 @@ class RedisPlugin(Plugin):
@action @action
def mget(self, keys, *args): def mget(self, keys, *args):
""" """
:returns: A list of values as specified in `keys` (wraps MGET) :returns: The values specified in keys as a key/value dict (wraps MGET)
""" """
return self._get_redis().mget(keys, *args)[0].decode() return {
keys[i]: value.decode()
for (i, value) in enumerate(self._get_redis().mget(keys, *args))
}
@action @action
def mset(self, *args, **kwargs): def mset(self, *args, **kwargs):

50
platypush/plugins/variable.py
View file

@ -7,12 +7,13 @@ class VariablePlugin(Plugin):
""" """
This plugin allows you to manipulate context variables that can be This plugin allows you to manipulate context variables that can be
accessed across your tasks. It requires the :mod:`platypush.plugins.db` accessed across your tasks. It requires the :mod:`platypush.plugins.db`
plugin to be enabled, as the variables will be stored on a local database and :mod:`platypush.plugins.redis` plugins to be enabled, as the variables
for persistency and multi-process sharing purposes. will be stored either persisted on a local database or on the local Redis instance.
Requires: Requires:
* **sqlalchemy** (``pip install sqlalchemy``) * **sqlalchemy** (``pip install sqlalchemy``)
* **redis** (``pip install redis``)
""" """
_variable_table_name = 'variable' _variable_table_name = 'variable'
@ -26,6 +27,7 @@ class VariablePlugin(Plugin):
super().__init__(*args, **kwargs) super().__init__(*args, **kwargs)
self.db_plugin = get_plugin('db') self.db_plugin = get_plugin('db')
self.redis_plugin = get_plugin('redis')
db = Config.get('db') db = Config.get('db')
self.db_config = { self.db_config = {
@ -46,7 +48,7 @@ class VariablePlugin(Plugin):
@action @action
def get(self, name, default_value=None): def get(self, name, default_value=None):
""" """
Get the value of a variable by name. Get the value of a variable by name from the local db.
:param name: Variable name :param name: Variable name
:type name: str :type name: str
@ -67,7 +69,7 @@ class VariablePlugin(Plugin):
@action @action
def set(self, **kwargs): def set(self, **kwargs):
""" """
Set a variable or a set of variables. Set a variable or a set of variables on the local db.
:param kwargs: Key-value list of variables to set (e.g. ``foo='bar', answer=42``) :param kwargs: Key-value list of variables to set (e.g. ``foo='bar', answer=42``)
""" """
@ -88,7 +90,7 @@ class VariablePlugin(Plugin):
@action @action
def unset(self, name): def unset(self, name):
""" """
Unset a variable by name if it's set Unset a variable by name if it's set on the local db.
:param name: Name of the variable to remove :param name: Name of the variable to remove
:type name: str :type name: str
@ -104,5 +106,43 @@ class VariablePlugin(Plugin):
return True return True
@action
def mget(self, name):
"""
Get the value of a variable by name from Redis.
:param name: Variable name
:type name: str
:param default_value: What will be returned if the variable is not defined (default: None)
:returns: A map in the format ``{"<name>":"<value>"}``
"""
return self.redis_plugin.mget([name])
@action
def mset(self, **kwargs):
"""
Set a variable or a set of variables on Redis.
:param kwargs: Key-value list of variables to set (e.g. ``foo='bar', answer=42``)
"""
return self.redis_plugin.mset(**kwargs)
@action
def munset(self, name):
"""
Unset a Redis variable by name if it's set
:param name: Name of the variable to remove
:type name: str
"""
return self.redis_plugin.mset(**{name: None})
# vim:sw=4:ts=4:et: # vim:sw=4:ts=4:et: