A Flask extension adding a decorator for CORS support
Project description
A Flask extension for handling Cross Origin Resource Sharing (CORS), making cross-origin AJAX possible.
Installation
Install the extension with using pip, or easy_install.
$ pip install flask-cors
Usage
This extension enables CORS support either via a decorator, or a Flask extension. There are three examples shown in the examples directory, showing the major use cases. The suggested configuration is the simple_example.py, or the app_example.py.
Simple Usage
In the simplest case, initialize the Flask-Cors extension with default arguments in order to allow CORS on all routes.
app = Flask(__name__)
cors = CORS(app)
@app.route("/")
def helloWorld():
return "Hello, cross-origin-world!"
Resource specific CORS
Alternatively, a list of resources and associated settings for CORS can be supplied, selectively enables CORS support on a set of paths on your app.
Note: this resources parameter can also be set in your application’s config.
app = Flask(__name__)
cors = CORS(app, resources={r"/api/*": {"origins": "*"}})
@app.route("/api/v1/users")
def list_users():
return "user example"
Route specific CORS via decorator
This extension also exposes a simple decorator to decorate flask routes with. Simply add @cross_origin() below a call to Flask’s @app.route(..) incanation to accept the default options and allow CORS on a given route.
@app.route("/")
@cross_origin() # allow all origins all methods.
def helloWorld():
return "Hello, cross-origin-world!"
Using JSON with CORS
When using JSON cross origin, browsers will issue a pre-flight OPTIONS request for POST requests. In order for browsers to allow POST requests with a JSON content type, you must allow the Content-Type header. The simplest way to do this is to simply set the CORS_HEADERS configuration value on your application, e.g:
app.config['CORS_HEADERS'] = 'Content-Type'
Application-wide settings
Alternatively, you can set all parameters except automatic_options in an app’s config object. Setting these at the application level effectively changes the default value for your application, while still allowing you to override it on a per-resource basis, either via the CORS Flask-Extension and regular expressions, or via the @cross_origin() decorator.
The application-wide configuration options are identical to the keyword arguments to cross_origin, creatively prefixed with CORS_
CORS_ORIGINS
CORS_METHODS
CORS_HEADERS
CORS_EXPOSE_HEADERS
CORS_ALWAYS_SEND
CORS_MAX_AGE
CORS_SEND_WILDCARD
CORS_ALWAYS_SEND
Documentation
For a full list of options, please see the full documentation
Tests
A simple set of tests is included in test/. To run, install nose, and simply invoke nosetests or python setup.py test to exercise the tests.
Contributing
Questions, comments or improvements? Please create an issue on Github, tweet at @wcdolphin or send me an email.
Credits
This Flask extension is based upon the Decorator for the HTTP Access Control written by Armin Ronacher.
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 Distributions
Hashes for Flask_Cors-1.7.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63553c26fbee2d5aae1cfaaeffaae420b9d98e44a72637b80f998cc7752306e4 |
|
MD5 | 5841fdcca777f9e7d57bd436cb2c4d0d |
|
BLAKE2b-256 | 2e6cf7b46161b9fed79b6bf193a4ad42a10bb36331c4005c7bd24aed6b833579 |
Hashes for Flask_Cors-1.7.3-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd0126e49348a784402bff104fa394789a90b9fb2fb817ba2019ce14122a578c |
|
MD5 | 8aacca0dec64ea8d8fe21222a7cd4b6d |
|
BLAKE2b-256 | 67bc9df606c8d644861ba6f0f778e2a11e22109203f8667c209557ad43396c06 |