Skip to content

Caching

By default, FIO Wrapper does not include any form of caching for FIO requests. Enabling caching can be extremely helpful to minimize load on FIO and reduce wait times. You can install the wrapper with the cache extra.

Installation of FIO Wrapper with Cache Extra

1
pip install fio-wrapper[cache]

FIO Wrapper will now make use of requests-cache as a persistent HTTP cache on top of Python's requests library. This package will only use memory caching.

Cache configuration

Caching can only be enabled with a user configuration file provided when instantiating the FIO wrapper.

Minimal

There are two minimal configuration options to be set:

1
2
3
cache:
  enabled: true
  default_expire: 3600

This user configuration enables the caching of requests and sets the default expiration to 10 seconds.

Advanced

You are able to provide URL patterns matching integrated endpoints to cache and specify their individual expiration with the following options:

  • int = Number of Seconds (e.g., 120 = 2 minutes)
  • NEVER_EXPIRE = route will always use cache and never expire
  • DO_NOT_CACHE = route will never be cached

A minimal example of caching individual urls:

1
2
3
4
5
cache:
  urls:
    "*/material/*": 3600
    "*/exchange/all": NEVER_EXPIRE
    "*/exchange/full": DO_NOT_CACHE

Note: Make sure to adjust the configuration according to your specific caching needs.