Merge pull request #21 from nrccua/ARCH-546-fix-pydoc-errors-in-redis…

…-file

Update redis pydocs

HISTORY.rst

@@ -3,6 +3,12 @@ History
 =======
 
 
+v0.11.3 (2021-02-18)
+-----------------------
+
+* Fix pydoc errors in redis.py file.
+
+
 v0.11.2 (2021-02-18)
 -----------------------
 

aioradio/redis.py

@@ -75,6 +75,7 @@ async def get(self, key: str, use_json: bool=None, encoding: Union[str, None]='u
         Args:
             key (str): redis cache key
             use_json (bool, optional): convert json value to object. Defaults to None.
+            encoding (Union[str, None], optional): encoding of values
 
         Returns:
             Any: any
@@ -96,6 +97,7 @@ async def mget(self, items: List[str], use_json: bool=None, encoding: Union[str,
         Args:
             items (List[str]): list of redis cache keys
             use_json (bool, optional): convert json values to objects. Defaults to None.
+            encoding (Union[str, None], optional): encoding of values
 
         Returns:
             List[Any]: list of objects
@@ -154,6 +156,7 @@ async def hget(self, key: str, field: str, use_json: bool=None, encoding: Union[
             key (str): cache key
             field (str): hash field
             use_json (bool, optional): convert json values to objects. Defaults to None.
+            encoding (Union[str, None], optional): encoding of values
 
         Returns:
             Any: any
@@ -176,6 +179,7 @@ async def hmget(self, key: str, fields: List[str], use_json: bool=None, encoding
             key (str): cache key
             fields (List[str]): hash fields
             use_json (bool, optional): convert json values to objects. Defaults to None.
+            encoding (Union[str, None], optional): encoding of values
 
         Returns:
             Any: any
@@ -200,7 +204,7 @@ async def hmget_many(self, keys: List[str], fields: List[str], use_json: bool=No
             keys (List[str]): cache keys
             fields (List[str]): hash fields
             use_json (bool, optional): convert json values to objects. Defaults to None.
-            encoding (Union[str, None]): encoding of values
+            encoding (Union[str, None], optional): encoding of values
 
         Returns:
             List[Any]: any
@@ -231,6 +235,7 @@ async def hgetall(self, key: str, use_json: bool=None, encoding: Union[str, None
         Args:
             key (str): cache key
             use_json (bool, optional): convert json values to objects. Defaults to None.
+            encoding (Union[str, None], optional): encoding of values
 
         Returns:
             Any: any
@@ -254,7 +259,7 @@ async def hgetall_many(self, keys: List[str], use_json: bool=None, encoding: Uni
         Args:
             keys (str): cache keys
             use_json (bool, optional): convert json values to objects. Defaults to None.
-            encoding (Union[str, None]): encoding of values
+            encoding (Union[str, None], optional): encoding of values
 
         Returns:
             List[Any]: any
@@ -287,6 +292,7 @@ async def hset(self, key: str, field: str, value: str, use_json: bool=None, expi
             field (str): hash field
             value (str): hash value
             use_json (bool, optional): set object to json before writing to cache. Defaults to None.
+            expire (int, optional): cache expiration. Defaults to None.
 
         Returns:
             int: 1 if key is set successfully else 0
@@ -313,6 +319,7 @@ async def hmset(self, key: str, items: Dict[str, Any], use_json: bool=None, expi
             key (str): cache key
             items (List[str, Any]): list of redis hash key-value pairs
             use_json (bool, optional): set object to json before writing to cache. Defaults to None.
+            expire (int, optional): cache expiration. Defaults to None.
 
         Returns:
             bool: True if hash is set successfully else False
@@ -337,7 +344,8 @@ async def hdel(self, key: str, fields: List[str]) -> int:
         """Delete one or more hash fields.
 
         Args:
-            key (str): cache key
+            key (str): hash key
+            fields (List[str]): hash fields
 
         Returns:
             int: Number of hash fields deleted
@@ -349,8 +357,8 @@ async def hexists(self, key: str, field: str) -> bool:
         """Determine if hash field exists.
 
         Args:
-            key (str): [description]
-            field (str): [description]
+            key (str): hash key
+            field (str): hash field
 
         Returns:
             int: True if hash field exists else False

setup.py

@@ -7,7 +7,7 @@
     long_description = fileobj.read()
 
 setup(name='aioradio',
-    version='0.11.2',
+    version='0.11.3',
     description='Generic asynchronous i/o python utilities for AWS services (SQS, S3, DynamoDB, Secrets Manager), Redis, MSSQL (pyodbc), JIRA and more',
     long_description=long_description,
     long_description_content_type="text/markdown",