Compress responses in your Flask app with gzip, deflate or brotli.
The preferred solution is to have a server (like Nginx) automatically compress the static files for you. If you don't have that option Flask-Compress will solve the problem for you.
How it works
Flask-Compress both adds the various headers required for a compressed response and compresses the response data. This makes serving compressed static files extremely easy.
Internally, every time a request is made the extension will check if it matches one of the compressible MIME types and whether the client and the server use some common compression algorithm, and will automatically attach the appropriate headers.
To determine the compression algorithm, the
Accept-Encoding request header is inspected, respecting the
quality factor as described in MDN docs.
If no requested compression algorithm is supported by the server, we don't compress the response. If, on the other
hand, multiple suitable algorithms are found and are requested with the same quality factor, we choose the first one
defined in the
COMPRESS_ALGORITHM option (see below).
If you use pip then installation is simply:
$ pip install --user flask-compress
or, if you want the latest github version:
$ pip install --user git+git://github.com/colour-science/flask-compress.git
You can also install Flask-Compress via Easy Install:
$ easy_install flask-compress
Flask-Compress is incredibly simple to use. In order to start compressing your Flask application's assets, the first thing to do is let Flask-Compress know about your
flask.Flask application object.
from flask import Flask from flask_compress import Compress app = Flask(__name__) Compress(app)
In many cases, however, one cannot expect a Flask instance to be ready at import time, and a common pattern is to return a Flask instance from within a function only after other configuration details have been taken care of. In these cases, Flask-Compress provides a simple function,
flask_compress.Compress.init_app, which takes your application as an argument.
from flask import Flask from flask_compress import Compress compress = Compress() def start_app(): app = Flask(__name__) compress.init_app(app) return app
In terms of automatically compressing your assets, passing your
flask.Flask object to the
flask_compress.Compress object is all that needs to be done.
Compression is possible per view using the
@compress.compressed() decorator. Make sure to disable global compression first.
from flask import Flask from flask_compress import Compress app = Flask(__name__) app.config["COMPRESS_REGISTER"] = False # disable default compression of all eligible requests compress = Compress() compress.init_app(app) # Compress this view specifically @app.route("/test") @compress.compressed() def view(): pass
Within your Flask application's settings you can provide the following settings to control the behavior of Flask-Compress. None of the settings are required.
||Set the list of mimetypes to compress here.||
||Specifies the gzip compression level.||
||Specifies the Brotli compression level. Ranges from 0 to 11.||
||For Brotli, the compression mode. The options are 0, 1, or 2. These correspond to "generic", "text" (for UTF-8 input), and "font" (for WOFF 2.0).||
||For Brotli, this specifies the base-2 logarithm of the sliding window size. Ranges from 10 to 24.||
||For Brotli, this provides the base-2 logarithm of the maximum input block size. If zero is provided, value will be determined based on the quality. Ranges from 16 to 24.||
||Specifies the deflate compression level.||
||Specifies the minimum file size threshold for compressing files.||
||Specifies the cache key method for lookup/storage of response data.||
||Specified the backend for storing the cached response data.||
||Specifies if compression should be automatically registered.||
||Supported compression algorithms.||
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for Flask_Compress-1.12-py3-none-any.whl