https://github.com/fraserchapman/script.module.cache
Kodi HTTP cache module using sqlite3
https://github.com/fraserchapman/script.module.cache
cache kodi kodi-module
Last synced: 11 months ago
JSON representation
Kodi HTTP cache module using sqlite3
- Host: GitHub
- URL: https://github.com/fraserchapman/script.module.cache
- Owner: FraserChapman
- License: mit
- Created: 2019-06-28T11:03:36.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-20T20:51:01.000Z (almost 2 years ago)
- Last Synced: 2025-07-05T14:36:54.062Z (11 months ago)
- Topics: cache, kodi, kodi-module
- Language: Python
- Homepage:
- Size: 15.6 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.txt
- License: LICENSE.txt
Awesome Lists containing this project
README
# script.module.cache
Simple Python HTTP Cache using sqlite3
* Stores cached data in sqlite3.Blobs.
* Calculates lifetime, freshness as virtual columns.
* Obeys cache control directives, immutable, no-store, etc.
* Supports etag, last_modified, etc for conditional requests.
* Can be used as a generic key/blob data store when used without directives.
By default the Cache (and Store) use a sqlite3 database named "cache.sqlite" located in the add-on profile directory
## Examples
Quick examples of basic usage
## Request cache
How to use the Cache class with requests
The Cache class allows you to easily store URIs, as keys, along with their response data and headers in a persistent database.
The calculated column "fresh" and the "conditional_headers" method can be used to limit the number of requests made
and the amount of data transferred respectively.
~~~~python
import requests
from cache import Cache, conditional_headers
def get_html(uri):
# type: (str) -> Union[str, None]
headers = {
"Accept": "text/html",
"Accept-encoding": "gzip"
}
with Cache() as c:
# check if uri is cached
cached = c.get(uri)
if cached:
# if the data is fresh then simply return it
if cached["fresh"]:
return cached["blob"]
# otherwise append applicable "If-None-Match"/"If-Modified-Since" headers
headers.update(conditional_headers(cached))
# request a new version of the data
r = requests.get(uri, headers=headers, timeout=60)
if 200 == r.status_code:
# add the new data and headers to the cache
c.set(uri, r.content, r.headers)
return r.content
if 304 == r.status_code:
# the data hasn't been modified so just touch the cache with the new headers
# and return the existing data
c.touch(uri, r.headers)
return cached["blob"]
# perhaps log any other status codes for debugging
return None
~~~~
## Generic string storage
Generic string storage is facilitated by the Store class.
The Store class allows a "key" to be used to append to, remove from or retrieve a set of unique string values.
This is useful for saving things like; a history of searched terms, urls of played films, etc.
~~~~python
from cache import Store
# key can be anything, app:// prefix isn't required
# the only requirement is that the key be unique with in your add-on
searches = Store("app://user-searches")
# add strings to the store
searches.append("foo")
searches.append("bar")
searches.append("bat")
print(searches.retrieve()) # {'bar', 'bat', 'foo'}
# remove a string from the store
searches.remove("bar")
print(searches.retrieve()) # {'bat', 'foo'}
# clear the store
searches.clear()
print(searches.retrieve()) # set()
~~~~
## References
* [DB-API 2.0 interface for SQLite databases](https://docs.python.org/2/library/sqlite3.html)
* [RFC7234 - HTTP/1.1 Caching](https://tools.ietf.org/html/rfc7234)
* [RFC7232 - HTTP/1.1 Conditional Requests](https://tools.ietf.org/html/rfc7232)
[](https://www.codacy.com/app/FraserChapman/script.module.cache?utm_source=github.com&utm_medium=referral&utm_content=FraserChapman/script.module.cache&utm_campaign=Badge_Grade)