bottle-file-cache 1.1.0

A simple file cache for the Python Bottle web framework.

Bottle File Cache

A simple file cache for the Python Bottle web framework.

Installation

python -m pip install -U bottle-file-cache

Usage

Given that example:

import bottle


@bottle.route("/hello/<name>")
def index(name: str) -> str:
    return bottle.template("<b>Hello {{name}}</b>!", name=name)


if __name__ == "__main__":
    bottle.run(host="localhost", port=8080)

Add those lines to enable the cache:

+from bottle_file_cache import cache
import bottle


@bottle.route("/hello/<name>")
+@cache()
def index(name: str) -> str:
    return bottle.template("<b>Hello {{name}}</b>!", name=name)

And that's it!

Advanced Usage

Bottle Parameters

You can specify more details to compute the cache key.

Here, it takes URL parameters in addition to the request path:

@bottle.route("/hello2/<name>")
@cache(params=["gender", "pron", "not-used"])
def index2(name: str) -> str:
    return bottle.template("<b>Hello {{name}} ({{gender}}, {{pron}})</b>!", name=name, **bottle.request.params)

Par-Call Expiration

You can specify a custom expiration time (in seconds) on a per-call basis:

@bottle.route("/hello3/<name>")
@cache(expires=1)
def index3(name: str) -> str:
    return bottle.template("<b>Hello {{name}}</b>!", name=name)