Merge pull request #2 from vidyasagar1432/dev

Dev - added StarletteCache
vidyasagar1432 · Oct 9, 2022 · a8b0fb9 · a8b0fb9
2 parents 4d2324f + 40460c3
commit a8b0fb9
Show file tree

Hide file tree

Showing 17 changed files with 352 additions and 433 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -3,3 +3,4 @@
   uses: pypa/gh-action-pypi-publish@release/v1
   with:
     password: ${{ secrets.PYPI_API_TOKEN }}
+
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,8 @@
 .pypirc
 
 # python
+starletteTest.py
+fastTest.py
 test.py
 test1.py
 fastapiExample.py

diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 ## Installing
 
 ```bash
-pip3 install detacache
+pip install detacache
 ```
 
 ## Async and Sync Decorator to cache function
@@ -14,7 +14,7 @@ import asyncio
 import aiohttp
 import requests
 
-from detacache import detaCache
+from detacache import DetaCache
 
 app = detaCache('projectKey')
 
@@ -49,10 +49,6 @@ from fastapi.templating import Jinja2Templates
 from fastapi.responses import HTMLResponse, PlainTextResponse
 from detacache import FastAPICache
 
-import logging
-
-logger = logging.getLogger("detacache")
-
 app = FastAPI()
 
 templates = Jinja2Templates(directory='templates')
@@ -178,6 +174,161 @@ def boolResponse(request: Request):
     return True
 
 ```
+
+## starlette Decorator to cache function
+
+#### you can use `cache` method as decorator and must pass `request` as param of view function.
+
+```python
+from starlette.applications import Starlette
+from starlette.responses import HTMLResponse, PlainTextResponse, JSONResponse
+from starlette.routing import Route
+from starlette.requests import Request
+
+from detacache import StarletteCache
+
+
+deta = StarletteCache(projectKey='projectKey')
+
+
+
+@deta.cache(expire=30)
+def dictResponse(request: Request):
+    return JSONResponse({
+        "slideshow": {
+            "author": "Yours Truly",
+            "date": "date of publication",
+            "slides": [
+                {
+                    "title": "Wake up to WonderWidgets!",
+                    "type": "all"
+                },
+                {
+                    "items": [
+                        "Why <em>WonderWidgets</em> are great",
+                        "Who <em>buys</em> WonderWidgets"
+                    ],
+                    "title": "Overview",
+                    "type": "all"
+                }
+            ],
+            "title": "Sample Slide Show"
+        }
+    })
+
+@deta.cache(expire=20)
+async def strResponse(request: Request):
+    return JSONResponse('fastapi detacache') 
+
+@deta.cache(expire=10)
+def tupleResponse(request: Request):
+    return JSONResponse(('fastapi', 'detacache'))
+
+@deta.cache(expire=10)
+def listResponse(req):
+    print(req.url)
+    return JSONResponse(['fastapi', 'detacache'])
+
+@deta.cache(expire=10)
+def setResponse(request: Request):
+    return JSONResponse({'fastapi', 'detacache'})
+
+@deta.cache(expire=10)
+def intResponse(request: Request):
+    return JSONResponse(10)
+
+@deta.cache(expire=10)
+def floatResponse(request: Request):
+    return JSONResponse(1.5)
+
+@deta.cache(expire=10)
+def boolResponse(request: Request):
+    return JSONResponse(True)
+
+@deta.cache(expire=10)
+def jsonResponse(request: Request):
+    return JSONResponse({
+        "slideshow": {
+            "author": "Yours Truly",
+            "date": "date of publication",
+            "slides": [
+                {
+                    "title": "Wake up to WonderWidgets!",
+                    "type": "all"
+                },
+                {
+                    "items": [
+                        "Why <em>WonderWidgets</em> are great",
+                        "Who <em>buys</em> WonderWidgets"
+                    ],
+                    "title": "Overview",
+                    "type": "all"
+                }
+            ],
+            "title": "Sample Slide Show"
+        }
+    }
+)
+
+@deta.cache(expire=30)
+def htmlResponse(request: Request):
+    return HTMLResponse('''
+        <!DOCTYPE HTML>
+        <html lang="en-US">
+        <head>
+            <meta charset="UTF-8">
+            <title>My Pimpin Website</title>
+            <meta name="description" content="A sample website, nothin fancy">
+            <meta http-equiv="author" content="Francisco Campos Arias">
+            <meta name="keywords" content="html, css, web, design, sample, practice">
+        </head>
+        <body>
+            <div class="container">
+            <header>
+                <div class="header">
+                    <h1>{{ data }}</h1>
+                </div>
+            </header>
+                <div class="main">
+                    <h2>This is just an example with some web content. This is the Hero Unit.</h2>
+                </div>
+                <div class="feature">
+                    <h3>Featured Content 1</h3>
+                    <p>lorem ipsum dolor amet lorem ipsum dolor ametlorem ipsum dolor ametlorem ipsum dolor ametlorem ipsum dolor ametlorem ipsum dolor ametlorem ipsum dolor ametlorem ipsum.</p>
+                </div>
+                <div class="feature">
+                    <h3>Featured Content 2</h3>
+                    <p>lorem ipsum dolor amet lorem ipsum dolor ametlorem ipsum dolor ametlorem ipsum dolor ametlorem ipsum dolor ametlorem ipsum dolor ametlorem ipsum dolor ametlorem ipsum dolor.</p>
+                </div>
+            <footer>
+                &copy;2012 Francisco Campos Arias, All Rigts Reserved.
+            </footer>
+            </div>
+        </body>
+        </html>
+        ''')
+
+@deta.cache(expire=20)
+def textResponse(request: Request):
+    return PlainTextResponse('detacache')
+
+
+routes = [
+    Route("/text", endpoint=textResponse),
+    Route("/html", endpoint=htmlResponse),
+    Route("/json", endpoint=jsonResponse),
+    Route("/bool", endpoint=boolResponse),
+    Route("/float", endpoint=floatResponse),
+    Route("/int", endpoint=intResponse),
+    Route("/set", endpoint=setResponse),
+    Route("/list", endpoint=listResponse),
+    Route("/tuple", endpoint=tupleResponse),
+    Route("/str", endpoint=strResponse),
+    Route("/dict", endpoint=dictResponse),
+]
+
+app = Starlette(routes=routes)
+```
 ## License
 
 MIT License

diff --git a/detacache/__init__.py b/detacache/__init__.py
@@ -1,10 +1,12 @@
-from detacache.core._decorators import DetaCache, FastAPICache,JsonCache
+from detacache.core._decorators import DetaCache,BaseDecorator,FastAPICache,StarletteCache
 
 
-__version__ = 'v0.1.1'
+__version__ = 'v0.1.2'
 
 __all__ = [
+    'BaseDecorator',
     'DetaCache',
     'FastAPICache',
-    'JsonCache'
-]
+    'StarletteCache'
+]
+
diff --git a/detacache/coder.py b/detacache/coder.py
@@ -1,9 +1,8 @@
-from .core._coder import Coder,DetaCoder,JsonCoder,PickleCoder,FastAPICoder
+from .core._coder import Coder,DetaCoder,FastAPICoder,StarletteCoder
 
 __all__ = [
     'Coder',
     'DetaCoder',
-    'JsonCoder',
-    'PickleCoder',
-    'FastAPICoder'
+    'FastAPICoder',
+    'StarletteCoder'
 ]
diff --git a/detacache/core/_cache.py b/detacache/core/_cache.py