flask_cacheify.py

from os import environ

from flask_cache import Cache


def init_cacheify(app, config=None):
    """Auto-configure an appropriate cache for your Flask application.

    :param app app: Your Flask application.
    :param dict config: Your Flask configuration dictionary.
    """
    if not (config is None or isinstance(config, dict)):
        raise ValueError('ERROR: config must be an instance of dict or '
                'NoneType.')

    config = config if config else app.config
    config.setdefault('CACHE_TYPE', 'simple')

    # Look for MemCachier.
    if any([k.startswith('MEMCACHIER_') for k in environ]):
        config['CACHE_TYPE'] = 'saslmemcached'
        config.setdefault('CACHE_MEMCACHED_SERVERS',
                [environ.get('MEMCACHIER_SERVERS')])
        config.setdefault('CACHE_MEMCACHED_USERNAME',
                environ.get('MEMCACHIER_USERNAME'))
        config.setdefault('CACHE_MEMCACHED_PASSWORD',
                environ.get('MEMCACHIER_PASSWORD'))

    # Look for RedisGreen.
    elif any([k.startswith('REDISGREEN_') for k in environ]):
        config['CACHE_TYPE'] = 'redis'
        config.setdefault('CACHE_REDIS_URL', environ.get('REDISGREEN_URL'))

    # Look for Redis Cloud.
    elif any([k.startswith('REDISCLOUD_') for k in environ]):
        config['CACHE_TYPE'] = 'redis'
        config.setdefault('CACHE_REDIS_URL', environ.get('REDISCLOUD_URL'))

    # Look for Redis To Go.
    elif any([k.startswith('REDISTOGO_') for k in environ]):
        config['CACHE_TYPE'] = 'redis'
        config.setdefault('CACHE_REDIS_URL', environ.get('REDISTOGO_URL'))

    # Look for openredis.
    elif any([k.startswith('OPENREDIS_') for k in environ]):
        config['CACHE_TYPE'] = 'redis'
        config.setdefault('CACHE_REDIS_URL', environ.get('OPENREDIS_URL'))

    return Cache(app, config)