Easy decorators for deprecating flask views and blueprints
Project description
Flask-Deprecate
Easy decorators for deprecating flask views and blueprints
Free software: MIT license
Documentation: https://flask-deprecate.readthedocs.io.
Example
from flask import Flask, Response
from flask_deprecate import deprecate_view
app = Flask('myapp')
@app.route('/myroute')
@deprecate_view("Don't use this!")
def myroute():
return Response()
An HTTP compliant “Warning” header is injected indicating the route is deprecated and optionally providing an upgrade path.
You can also deprecate an entire blueprint in favor of a new one
from flask import Flask, Response, Blueprint
from flask_deprecate import deprecate_blueprint
old_bp = Blueprint('old', 'old', url_prefix='/v1')
new_bp = Blueprint('new', 'new', url_prefix='/v2')
@old_bp.route('/my_route')
def my_old_route():
return Resonse()
@new_bp.route('/my_new_route')
def my_new_route():
return Response()
deprecate_blueprint(old_bp, new_blueprint=new_bp)
app.register_blueprint(old_bp)
app.register_blueprint(new_bp)
This will inject the Warning header for every route on the old blueprint and additionally direct the client to use the new /v2 api.
Documentation
You will need to install the package dependencies first, see the Installation section for details.
To build and open the documentation simply run:
bin/build-docs
Installation
If you need to install pyenv/virtualenvwrapper you can run the bin/setup-osx command Please note that this will modify your bash profile
Assuming you have virtualenv wrapper installed
mkvirtualenv flask-deprecate
workon flask-deprecate
pip install -r requirements_dev.txt
pip install -e .
Credits
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
History
0.1.0 (2018-02-07)
First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flask_deprecate-0.1.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 574a738460c8b31ffd0a19a24001dc49f85867c3e5bd8adca9514088f8df6aa2 |
|
MD5 | c69f556572d11794ef67637bacdfb2ed |
|
BLAKE2b-256 | e5e8ddddf13aa2181e2215a31ceb227d09be37bdfb5c6a98f280f9d1662ceb27 |