Adds simple file handling for different providers to your application. Provides the following providers out of the box:
Flask-Store integration into Flask applications. Flask-Store can be integrated in two different ways depending on how you have setup your Flask application.
You can bind to a specific flask application:
app = Flask(__name__)
store = Store(app)
Or if you use an application factory you can use flask_store.Store.init_app():
store = Store()
def create_app():
app = Flask(__name__)
store.init_app(app)
return app
Checks the required application configuration variables are set in the flask application.
Parameters: | app (flask.app.Flask) – Flask application instance |
---|---|
Raises: | NotConfiguredError – In the event a required config parameter is required by the Store. |
Sets up application default confugration options and sets a Provider property which can be used to access the default provider class which handles the saving of files.
Parameters: | app (flask.app.Flask) – Flask application instance |
---|
Fetches the provider class as defined by the application configuration.
Parameters: | app (flask.app.Flask) – Flask application instance |
---|---|
Raises: | ImportError – If the class or module cannot be imported |
Returns: | The provider class |
Return type: | class |
Custom Flask-Store exception classes.
An Ambassador class for the provider for a specific file. Each method basically proxies to methods on the provider.
Returns the absollute file path to the file.
Returns: | Absolute file path |
---|---|
Return type: | str |
Absolute url contains a domain if it is set in the configuration, the url predix, destination and the actual file name.
Returns: | Full absolute URL to file |
---|---|
Return type: | str |
Base store functionality and classes.
Base file storage class all storage providers should inherit from. This class provides some of the base functionality for all providers. Override as required.
Placeholder “exists” method. This should be overridden by custom providers and return a boolean depending on if the file exists of not for the provider.
Raises: | NotImplementedError – If the “exists” method has not been implemented |
---|
Each provider needs to implement how to safely join parts of a path together to result in a path which can be used for the provider.
Raises: | NotImplementedError – If the “join” method has not been implemented |
---|
By default Stores do not require a route to be registered
If the file already exists the file will be renamed to contain a short url safe UUID. This will avoid overwtites.
Parameters: | filename (str) – A filename to check if it exists |
---|---|
Returns: | A safe filenaem to use when writting the file |
Return type: | str |
Local file storage for your Flask application.
Example
from flask import Flask, request
from flask.ext.store import Provider, Store
from wtforms import Form
from wtforms.fields import FileField
class FooForm(Form):
foo = FileField('foo')
app = Flask(__app__)
app.config['STORE_PATH'] = '/some/file/path'
store = Store(app)
@app,route('/upload')
def upload():
form = FooForm()
form.validate_on_submit()
if not form.errors:
provider = store.Provider()
provider.save(request.files.get('foo'))
The default provider for Flask-Store. Handles saving files onto the local file system.
Sets sensible application configuration settings for this provider.
Parameters: | app (flask.app.Flask) – Flask application at init |
---|
Returns boolean of the provided filename exists at the compiled absolute path.
Parameters: | name (str) – Filename to check its existence |
---|---|
Returns: | Whether the file exists on the file system |
Return type: | bool |
Ensure a route is registered for serving files
Save the file on the local file system. Simply builds the paths and calls werkzeug.datastructures.FileStorage.save() on the file object.
Parameters: | file (werkzeug.datastructures.FileStorage) – The file uploaded by the user |
---|---|
Returns: | A thin wrapper around the file and provider |
Return type: | flask_store.file_wapper.FileWrapper |
AWS Simple Storage Service file Store.
Example
from flask import Flask, request
from flask.ext.Store import Backend, Store
from wtforms import Form
from wtforms.fields import FileField
class FooForm(Form):
foo = FileField('foo')
app = Flask(__app__)
app.config['STORE_PROVIDER'] = 'flask_store.stores.s3.S3Store'
app.config['STORE_S3_ACCESS_KEY'] = 'foo'
app.confog['STORE_S3_SECRET_KEY'] = 'bar'
store = Store(app)
@app,route('/upload')
def upload():
form = FooForm()
form.validate_on_submit()
backend = Backend()
backend.save(form.files.get('foo'))
A Gevent Support for S3Store. Calling save() here will spawn a greenlet which will handle the actual upload process.
Acts as a proxy to the actual save method in the parent class. The save method will be called in a greenlet so gevent must be installed.
Since the origional request will close the file object we write the file to a temporary location on disk and create a new werkzeug.datastructures.FileStorage instance with the stram being the temporary file.
Returns: | Relative path to file |
---|---|
Return type: | str |
Amazon Simple Storage Service Store (S3). Allows files to be stored in an AWS S3 bucket.
Required application configuration variables
Sets sensible application configuration settings for this provider.
Parameters: | app (flask.app.Flask) – Flask application at init |
---|
Checks if the file already exists in the bucket using Boto.
Parameters: | name (str) – Filename to check its existence |
---|---|
Returns: | Whether the file exists on the file system |
Return type: | bool |
Joins paths into a url.
Parameters: | *parts – List of arbitrary paths to join together |
---|---|
Returns: | S3 save joined paths |
Return type: | str |
Takes the uploaded file and uploads it to S3.
Note
This is a blocking call and therefore will increase the time for your application to respond to the client and may cause request timeouts.
Parameters: | file (werkzeug.datastructures.FileStorage) – The file uploaded by the user |
---|---|
Returns: | Relative path to file |
Return type: | str |