update

README.md

@@ -46,6 +46,23 @@ d.delete("one")  # delete one item from stack
 print(d.set("three", 3))  # True
 ```
 
+# Asynchronous
+
+example asynchronous usage
+
+```python
+import asyncio
+from zcache import AsyncCache
+
+async def main():
+    c = await AsyncCache()
+    await c.set("test", "OK")
+    print(await c.get("test"))
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
 # Storage and plugins
 
 you can change storage and use plugins, for example:
@@ -59,57 +76,26 @@ c = Cache(storage=BaseFileStorage, plugins=BytesCachePlugins)
 ```
 see list current available [storage](https://github.com/guangrei/zcache/tree/main/zcache/Storage) and [plugins](https://github.com/guangrei/zcache/tree/main/zcache/Plugins), you can also create your own storage and plugins.
 
-## Extras
+# Extras
 
-[extras](https://github.com/guangrei/zcache/tree/main/zcache/Extras) is several function based on zcache.
+[Extras](https://github.com/guangrei/zcache/tree/main/zcache/Extras) is several function based on zcache.
 
-1. SmartRequest
+1. [SmartRequest](https://github.com/guangrei/zcache/tree/main/tests_smartrequests.py)
 
-`SmartRequest` is Simple HTTP Client with smart caching system provide by `zcache`.
+`SmartRequest` is Simple HTTP Client with smart caching system based on `zcache`.
 
-example usage of `SmartRequest(url, cache_path, cache_time, offline_ttl)`:
-```python
-from zcache.Extras.SmartRequest import SmartRequest
+2.[AsyncSmartRequest](https://github.com/guangrei/zcache/tree/main/tests_smartrequests.py)
 
-req = SmartRequest("https://www.example.com", cache_path="/tmp/request1.cache")
-print(req.is_loaded_from_cache) # check if response is loaded from cache
-response_headers = req.response.get('headers')
-response_body = req.response.get('body')
-```
-to make advance request you can create custom url object with other library, for example:
-```python
-from zcache.Extras.SmartRequest import SmartRequest
-
-class MyRequest:
-    url = "https://www.example.com"
-
-    def get():
-        """
-        this method called by SmartRequest to retrieve content.
-        you can put request logic get, post etc and return tuple(headers=dict, body=str/bytes)
-        """
-
-        ret = requests.get(MyRequest.url)
-        return dict(ret.headers), ret.content
-
-
-req = SmartRequest(MyRequest, cache_path="/tmp/request2.cache")
-```
+`AsyncSmartRequest` is asynchronous version of `SmartRequests`.
 
-> from zcache v1.0.3 SmartRequest body support bytes and already use BytesCachePlugins to store large file/content.
+3. [Queue](https://github.com/guangrei/zcache/tree/main/tests_queue.py)
 
-2. Queue
+`Queue` is Fifo Queue based on `zcache`.
+
+4. [AsyncQueue](https://github.com/guangrei/zcache/tree/main/tests_queue.py)
+
+`AsyncQueue` is asynchronous version of`zcache`.
 
-```python
-from zcache.Extras.Queue import Queue
-
-q = Queue()
-id = q.put("test")
-q.exists(id)
-q.empty()
-q.size()
-q.get()
-```
 
 ## License
 

tests/test_async_dicstorage.py

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+from unittest import IsolatedAsyncioTestCase
+from zcache.Class.AsyncDatabase import AsyncDatabase
+from zcache.Storage.AsyncDictStorage import AsyncDictStorage
+
+
+class DBTest(IsolatedAsyncioTestCase):
+
+    async def test_database_or_cache(self):
+        c = await AsyncDatabase("/tmp/async_dicstorage_test.json", storage=AsyncDictStorage)
+        await c.reset()
+
+        expected = await c.set("foo", "bar")
+        self.assertEqual(expected, True)

tests/test_dictstorage.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+import unittest
+from zcache.Class.Database import Database
+from zcache.Storage.DictStorage import DictStorage
+
+
+class DictStorageTest(unittest.TestCase):
+
+    def test_database_or_cache(self):
+        c = Database("/tmp/test_dict_storage.json", storage=DictStorage)
+        c.reset()
+        self.assertEqual(c.set("foo", "bar"), True)
+        self.assertEqual(c.size(), 1)

tests/test_fcntlstorage.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+import unittest
+from zcache.Class.Database import Database
+from zcache.Storage.FcntlStorage import FcntlStorage
+
+
+class FcntlStorageTest(unittest.TestCase):
+
+    def test_database_or_cache(self):
+        c = Database("/tmp/test_fcntl_storage.json", storage=FcntlStorage)
+        c.reset()
+        self.assertEqual(c.set("foo", "bar"), True)
+        self.assertEqual(c.size(), 1)

zcache/Class/AsyncDatabase.py

@@ -1,4 +1,27 @@
 # -*-coding:utf8;-*-
+"""
+The MIT License (MIT)
+
+Copyright (c) 2022 zcache https://github.com/guangrei/zcache
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+"""
 from zcache.Storage.AsyncFileStorage import AsyncFileStorage
 from zcache.Interface.Storage import Storage as StorageInterface
 from zcache.Interface.Plugins import Plugins as PluginsInterface

zcache/Class/Database.py

@@ -1,4 +1,27 @@
 # -*-coding:utf8;-*-
+"""
+The MIT License (MIT)
+
+Copyright (c) 2022 zcache https://github.com/guangrei/zcache
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+"""
 from zcache.Storage.BaseFileStorage import BaseFileStorage
 from zcache.Interface.Storage import Storage as StorageInterface
 from zcache.Interface.Plugins import Plugins as PluginsInterface

zcache/Extras/AsyncQueue.py

@@ -1,4 +1,27 @@
 # -*-coding:utf8;-*-
+"""
+The MIT License (MIT)
+
+Copyright (c) 2022 zcache https://github.com/guangrei/zcache
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+"""
 from zcache.Storage.AsyncFileStorage import AsyncFileStorage
 from zcache.Class.AsyncDatabase import AsyncDatabase
 import uuid

zcache/Extras/AsyncSmartRequest.py

@@ -2,7 +2,7 @@
 """
 The MIT License (MIT)
 
-Copyright (c) 2022 PyZCache https://github.com/guangrei/PyZCache
+Copyright (c) 2022 zcache https://github.com/guangrei/zcache
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -31,7 +31,7 @@
 @asyncinit
 class AsyncSmartRequest:
     """
-    A class for making Smart HTTP requests with caching capabilities using PyZCache.
+    A class for making Smart HTTP requests with caching capabilities using zcache.
     """
 
     async def __init__(

zcache/Extras/Queue.py

@@ -1,4 +1,27 @@
 # -*-coding:utf8;-*-
+"""
+The MIT License (MIT)
+
+Copyright (c) 2022 zcache https://github.com/guangrei/zcache
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+"""
 from zcache.Storage.BaseFileStorage import BaseFileStorage
 from zcache.Class.Database import Database
 import uuid

zcache/Extras/SmartRequest.py

@@ -2,7 +2,7 @@
 """
 The MIT License (MIT)
 
-Copyright (c) 2022 PyZCache https://github.com/guangrei/PyZCache
+Copyright (c) 2022 zcache https://github.com/guangrei/zcache
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -29,7 +29,7 @@
 
 class SmartRequest:
     """
-    A class for making Smart HTTP requests with caching capabilities using PyZCache.
+    A class for making Smart HTTP requests with caching capabilities using zcache.
     """
 
     def __init__(

zcache/Interface/Plugins.py

@@ -1,4 +1,27 @@
 # -*-coding:utf8;-*-
+"""
+The MIT License (MIT)
+
+Copyright (c) 2022 zcache https://github.com/guangrei/zcache
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+"""
 from abc import ABC, abstractmethod
 
 

zcache/Interface/Storage.py

@@ -1,16 +1,39 @@
-# -*-coding:utf8;-*-
-from abc import ABC, abstractmethod
-
-
-class Storage(ABC):
-    @abstractmethod
-    def __init__(self, path):
-        pass
-
-    @abstractmethod
-    def load(self):
-        pass
-
-    @abstractmethod
-    def save(self, data):
-        pass
+# -*-coding:utf8;-*-
+"""
+The MIT License (MIT)
+
+Copyright (c) 2022 zcache https://github.com/guangrei/zcache
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+"""
+from abc import ABC, abstractmethod
+
+
+class Storage(ABC):
+    @abstractmethod
+    def __init__(self, path):
+        pass
+
+    @abstractmethod
+    def load(self):
+        pass
+
+    @abstractmethod
+    def save(self, data):
+        pass

zcache/Plugins/AsyncBytesCachePlugins.py

@@ -1,4 +1,27 @@
 # -*-coding:utf8;-*-
+"""
+The MIT License (MIT)
+
+Copyright (c) 2022 zcache https://github.com/guangrei/zcache
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+"""
 from zcache.Interface.Plugins import Plugins
 import pickle
 import os