flask.app
~~~~~~~~~
This module implements the central WSGI application object.
:copyright: (c) 2011 by Armin Ronacher.
:license: BSD, see LICENSE for more details.
from __future__ import with_statement
import os
import sys
from threading import Lock
from datetime import timedelta
from itertools import chain
from functools import update_wrapper
from werkzeug.datastructures import ImmutableDict
from werkzeug.routing import Map, Rule, RequestRedirect, BuildError
from werkzeug.exceptions import HTTPException, InternalServerError, \
MethodNotAllowed, BadRequest
from .helpers import _PackageBoundObject, url_for, get_flashed_messages, \
locked_cached_property, _endpoint_from_view_func, find_package
from . import json
from .wrappers import Request, Response
from .config import ConfigAttribute, Config
from .ctx import RequestContext, AppContext, _AppCtxGlobals
from .globals import _request_ctx_stack, request, session, g
from .sessions import SecureCookieSessionInterface
from .module import blueprint_is_module
from .templating import DispatchingJinjaLoader, Environment, \
_default_template_ctx_processor
from .signals import request_started, request_finished, got_request_exception, \
request_tearing_down, appcontext_tearing_down
a lock used for logger initialization
_logger_lock = Lock()
def _make_timedelta(value):
if not isinstance(value, timedelta):
return timedelta(seconds=value)
return value
Wraps a method so that it performs a check in debug mode if the
def setupmethod(f):
first request was already handled.
def wrapper_func(self, *args, **kwargs):
if self.debug and self._got_first_request:
raise AssertionError('A setup function was called after the '
'first request was handled. This usually indicates a bug '
'in the application where a module was not imported '
'and decorators or other functionality was called too late.\n'
'To fix this make sure to import all your view modules, '
'database models and everything related at a central place '
'before the application starts serving requests.')
return f(self, *args, **kwargs)
return update_wrapper(wrapper_func, f)
The flask object implements a WSGI application and acts as the central
class Flask(_PackageBoundObject):
object. It is passed the name of the module or package of the application. Once it is created it will act as a central registry for the view functions, the URL rules, template configuration and much more.
The name of the package is used to resolve resources from inside the
package or the folder the module is contained in depending on if the
package parameter resolves to an actual python package (a folder with
an __init__.py
file inside) or a standard module (just a .py
file).
For more information about resource loading, see :func:open_resource
.
Usually you create a :class:Flask
instance in your main module or
in the __init__.py
file of your package like this::
from flask import Flask
app = Flask(__name__)
.. admonition:: About the First Parameter
The idea of the first parameter is to give Flask an idea what
belongs to your application. This name is used to find resources
on the file system, can be used by extensions to improve debugging
information and a lot more.
So it's important what you provide there. If you are using a single
module, `__name__` is always the correct value. If you however are
using a package, it's usually recommended to hardcode the name of
your package there.
For example if your application is defined in `yourapplication/app.py`
you should create it with one of the two versions below::
app = Flask('yourapplication')
app = Flask(__name__.split('.')[0])
Why is that? The application will work even with `__name__`, thanks
to how resources are looked up. However it will make debugging more
painful. Certain extensions can make assumptions based on the
import name of your application. For example the Flask-SQLAlchemy
extension will look for the code in your application that triggered
an SQL query in debug mode. If the import name is not properly set
up, that debugging information is lost. (For example it would only
pick up SQL queries in `yourapplication.app` and not
`yourapplication.views.frontend`)
.. versionadded:: 0.7
The static_url_path
, static_folder
, and template_folder
parameters were added.
.. versionadded:: 0.8
The instance_path
and instance_relative_config
parameters were
added.
:param import_name: the name of the application package
:param static_url_path: can be used to specify a different path for the
static files on the web. Defaults to the name
of the static_folder
folder.
:param static_folder: the folder with static files that should be served
at static_url_path
. Defaults to the 'static'
folder in the root path of the application.
:param template_folder: the folder that contains the templates that should
be used by the application. Defaults to
'templates'
folder in the root path of the
application.
:param instance_path: An alternative instance path for the application.
By default the folder 'instance'
next to the
package or module is assumed to be the instance
path.
:param instance_relative_config: if set to True
relative filenames
for loading the config are assumed to
be relative to the instance path instead
of the application root.
: The class that is used for request objects. See :class:~flask.Request
: for more information.
request_class = Request
: The class that is used for response objects. See
: :class:~flask.Response
for more information.
response_class = Response
: The class that is used for the :data:~flask.g
instance.
:
: Example use cases for a custom class:
:
: 1. Store arbitrary attributes on flask.g.
: 2. Add a property for lazy per-request database connectors.
: 3. Return None instead of AttributeError on expected attributes.
: 4. Raise exception if an unexpected attr is set, a "controlled" flask.g.
:
: In Flask 0.9 this property was called request_globals_class
but it
: was changed in 0.10 to :attr:app_ctx_globals_class
because the
: flask.g object is not application context scoped.
:
: .. versionadded:: 0.10
app_ctx_globals_class = _AppCtxGlobals
Backwards compatibility support
def _get_request_globals_class(self):
return self.app_ctx_globals_class
def _set_request_globals_class(self, value):
from warnings import warn
warn(DeprecationWarning('request_globals_class attribute is now '
'called app_ctx_globals_class'))
self.app_ctx_globals_class = value
request_globals_class = property(_get_request_globals_class,
_set_request_globals_class)
del _get_request_globals_class, _set_request_globals_class
: The debug flag. Set this to True
to enable debugging of the
: application. In debug mode the debugger will kick in when an unhandled
: exception ocurrs and the integrated server will automatically reload
: the application if changes in the code are detected.
:
: This attribute can also be configured from the config with the DEBUG
: configuration key. Defaults to False
.
debug = ConfigAttribute('DEBUG')
: The testing flag. Set this to True
to enable the test mode of
: Flask extensions (and in the future probably also Flask itself).
: For example this might activate unittest helpers that have an
: additional runtime cost which should not be enabled by default.
:
: If this is enabled and PROPAGATE_EXCEPTIONS is not changed from the
: default it's implicitly enabled.
:
: This attribute can also be configured from the config with the
: TESTING
configuration key. Defaults to False
.
testing = ConfigAttribute('TESTING')
: If a secret key is set, cryptographic components can use this to
: sign cookies and other things. Set this to a complex random value
: when you want to use the secure cookie for instance.
:
: This attribute can also be configured from the config with the
: SECRET_KEY
configuration key. Defaults to None
.
secret_key = ConfigAttribute('SECRET_KEY')
: The secure cookie uses this for the name of the session cookie.
:
: This attribute can also be configured from the config with the
: SESSION_COOKIE_NAME
configuration key. Defaults to 'session'
session_cookie_name = ConfigAttribute('SESSION_COOKIE_NAME')
: A :class:~datetime.timedelta
which is used to set the expiration
: date of a permanent session. The default is 31 days which makes a
: permanent session survive for roughly one month.
:
: This attribute can also be configured from the config with the
: PERMANENT_SESSION_LIFETIME
configuration key. Defaults to
: timedelta(days=31)
permanent_session_lifetime = ConfigAttribute('PERMANENT_SESSION_LIFETIME',
get_converter=_make_timedelta)
: Enable this if you want to use the X-Sendfile feature. Keep in
: mind that the server has to support this. This only affects files
: sent with the :func:send_file
method.
:
: .. versionadded:: 0.2
:
: This attribute can also be configured from the config with the
: USE_X_SENDFILE
configuration key. Defaults to False
.
use_x_sendfile = ConfigAttribute('USE_X_SENDFILE')
: The name of the logger to use. By default the logger name is the : package name passed to the constructor. : : .. versionadded:: 0.4
logger_name = ConfigAttribute('LOGGER_NAME')
: Enable the deprecated module support? This is active by default : in 0.7 but will be changed to False in 0.8. With Flask 1.0 modules : will be removed in favor of Blueprints
enable_modules = True
: The logging format used for the debug logger. This is only used when : the application is in debug mode, otherwise the attached logging : handler does the formatting. : : .. versionadded:: 0.3
debug_log_format = (
'-' * 80 + '\n' +
'%(levelname)s in %(module)s [%(pathname)s:%(lineno)d]:\n' +
'%(message)s\n' +
'-' * 80
)
: The JSON encoder class to use. Defaults to :class:~flask.json.JSONEncoder
.
:
: .. versionadded:: 0.10
json_encoder = json.JSONEncoder
: The JSON decoder class to use. Defaults to :class:~flask.json.JSONDecoder
.
:
: .. versionadded:: 0.10
json_decoder = json.JSONDecoder
: Options that are passed directly to the Jinja2 environment.
jinja_options = ImmutableDict(
extensions=['jinja2.ext.autoescape', 'jinja2.ext.with_']
)
: Default configuration parameters.
default_config = ImmutableDict({
'DEBUG': False,
'TESTING': False,
'PROPAGATE_EXCEPTIONS': None,
'PRESERVE_CONTEXT_ON_EXCEPTION': None,
'SECRET_KEY': None,
'PERMANENT_SESSION_LIFETIME': timedelta(days=31),
'USE_X_SENDFILE': False,
'LOGGER_NAME': None,
'SERVER_NAME': None,
'APPLICATION_ROOT': None,
'SESSION_COOKIE_NAME': 'session',
'SESSION_COOKIE_DOMAIN': None,
'SESSION_COOKIE_PATH': None,
'SESSION_COOKIE_HTTPONLY': True,
'SESSION_COOKIE_SECURE': False,
'MAX_CONTENT_LENGTH': None,
'SEND_FILE_MAX_AGE_DEFAULT': 12 * 60 * 60, # 12 hours
'TRAP_BAD_REQUEST_ERRORS': False,
'TRAP_HTTP_EXCEPTIONS': False,
'PREFERRED_URL_SCHEME': 'http',
'JSON_AS_ASCII': True
})
: The rule object to use for URL rules created. This is used by
: :meth:add_url_rule
. Defaults to :class:werkzeug.routing.Rule
.
:
: .. versionadded:: 0.7
url_rule_class = Rule
: the test client that is used with when test_client
is used.
:
: .. versionadded:: 0.7
test_client_class = None
: the session interface to use. By default an instance of
: :class:~flask.sessions.SecureCookieSessionInterface
is used here.
:
: .. versionadded:: 0.8
session_interface = SecureCookieSessionInterface()
def __init__(self, import_name, static_path=None, static_url_path=None,
static_folder='static', template_folder='templates',
instance_path=None, instance_relative_config=False):
_PackageBoundObject.__init__(self, import_name,
template_folder=template_folder)
if static_path is not None:
from warnings import warn
warn(DeprecationWarning('static_path is now called '
'static_url_path'), stacklevel=2)
static_url_path = static_path
if static_url_path is not None:
self.static_url_path = static_url_path
if static_folder is not None:
self.static_folder = static_folder
if instance_path is None:
instance_path = self.auto_find_instance_path()
elif not os.path.isabs(instance_path):
raise ValueError('If an instance path is provided it must be '
'absolute. A relative path was given instead.')
: Holds the path to the instance folder. : : .. versionadded:: 0.8
self.instance_path = instance_path
: The configuration dictionary as :class:Config
. This behaves
: exactly like a regular dictionary but supports additional methods
: to load a config from files.
self.config = self.make_config(instance_relative_config)
Prepare the deferred setup of the logger.
self._logger = None
self.logger_name = self.import_name
: A dictionary of all view functions registered. The keys will
: be function names which are also used to generate URLs and
: the values are the function objects themselves.
: To register a view function, use the :meth:route
decorator.
self.view_functions = {}
support for the now deprecated error_handlers
attribute. The
:attr:error_handler_spec
shall be used now.
self._error_handlers = {}
: A dictionary of all registered error handlers. The key is None
: for error handlers active on the application, otherwise the key is
: the name of the blueprint. Each key points to another dictionary
: where they key is the status code of the http exception. The
: special key None
points to a list of tuples where the first item
: is the class for the instance check and the second the error handler
: function.
:
: To register a error handler, use the :meth:errorhandler
: decorator.
self.error_handler_spec = {None: self._error_handlers}
: A list of functions that are called when :meth:url_for
raises a
: :exc:~werkzeug.routing.BuildError
. Each function registered here
: is called with error
, endpoint
and values
. If a function
: returns None
or raises a BuildError
the next function is
: tried.
:
: .. versionadded:: 0.9
self.url_build_error_handlers = []
: A dictionary with lists of functions that should be called at the
: beginning of the request. The key of the dictionary is the name of
: the blueprint this function is active for, None
for all requests.
: This can for example be used to open database connections or
: getting hold of the currently logged in user. To register a
: function here, use the :meth:before_request
decorator.
self.before_request_funcs = {}
: A lists of functions that should be called at the beginning of the
: first request to this instance. To register a function here, use
: the :meth:before_first_request
decorator.
:
: .. versionadded:: 0.8
self.before_first_request_funcs = []
: A dictionary with lists of functions that should be called after
: each request. The key of the dictionary is the name of the blueprint
: this function is active for, None
for all requests. This can for
: example be used to open database connections or getting hold of the
: currently logged in user. To register a function here, use the
: :meth:after_request
decorator.
self.after_request_funcs = {}
: A dictionary with lists of functions that are called after
: each request, even if an exception has occurred. The key of the
: dictionary is the name of the blueprint this function is active for,
: None
for all requests. These functions are not allowed to modify
: the request, and their return values are ignored. If an exception
: occurred while processing the request, it gets passed to each
: teardown_request function. To register a function here, use the
: :meth:teardown_request
decorator.
:
: .. versionadded:: 0.7
self.teardown_request_funcs = {}
: A list of functions that are called when the application context : is destroyed. Since the application context is also torn down : if the request ends this is the place to store code that disconnects : from databases. : : .. versionadded:: 0.9
self.teardown_appcontext_funcs = []
: A dictionary with lists of functions that can be used as URL
: value processor functions. Whenever a URL is built these functions
: are called to modify the dictionary of values in place. The key
: None
here is used for application wide
: callbacks, otherwise the key is the name of the blueprint.
: Each of these functions has the chance to modify the dictionary
:
: .. versionadded:: 0.7
self.url_value_preprocessors = {}
: A dictionary with lists of functions that can be used as URL value
: preprocessors. The key None
here is used for application wide
: callbacks, otherwise the key is the name of the blueprint.
: Each of these functions has the chance to modify the dictionary
: of URL values before they are used as the keyword arguments of the
: view function. For each function registered this one should also
: provide a :meth:url_defaults
function that adds the parameters
: automatically again that were removed that way.
:
: .. versionadded:: 0.7
self.url_default_functions = {}
: A dictionary with list of functions that are called without argument
: to populate the template context. The key of the dictionary is the
: name of the blueprint this function is active for, None
for all
: requests. Each returns a dictionary that the template context is
: updated with. To register a function here, use the
: :meth:context_processor
decorator.
self.template_context_processors = {
None: [_default_template_ctx_processor]
}
: all the attached blueprints in a directory by name. Blueprints : can be attached multiple times so this dictionary does not tell : you how often they got attached. : : .. versionadded:: 0.7
self.blueprints = {}
: a place where extensions can store application specific state. For
: example this is where an extension could store database engines and
: similar things. For backwards compatibility extensions should register
: themselves like this::
:
: if not hasattr(app, 'extensions'):
: app.extensions = {}
: app.extensions['extensionname'] = SomeObject()
:
: The key must match the name of the flaskext
module. For example in
: case of a "Flask-Foo" extension in flaskext.foo
, the key would be
: 'foo'
.
:
: .. versionadded:: 0.7
self.extensions = {}
: The :class:~werkzeug.routing.Map
for this instance. You can use
: this to change the routing converters after the class was created
: but before any routes are connected. Example::
:
: from werkzeug.routing import BaseConverter
:
: class ListConverter(BaseConverter):
: def to_python(self, value):
: return value.split(',')
: def to_url(self, values):
: return ','.join(BaseConverter.to_url(value)
: for value in values)
:
: app = Flask(name)
: app.url_map.converters['list'] = ListConverter
self.url_map = Map()
tracks internally if the application already handled at least one request.
self._got_first_request = False
self._before_request_lock = Lock()
register the static folder for the application. Do that even if the folder does not exist. First of all it might be created while the server is running (usually happens during development) but also because google appengine stores static files somewhere else when mapped with the .yml file.
if self.has_static_folder:
self.add_url_rule(self.static_url_path + '/<path:filename>',
endpoint='static',
view_func=self.send_static_file)
def _get_error_handlers(self):
from warnings import warn
warn(DeprecationWarning('error_handlers is deprecated, use the '
'new error_handler_spec attribute instead.'), stacklevel=1)
return self._error_handlers
def _set_error_handlers(self, value):
self._error_handlers = value
self.error_handler_spec[None] = value
error_handlers = property(_get_error_handlers, _set_error_handlers)
del _get_error_handlers, _set_error_handlers
The name of the application. This is usually the import name
@locked_cached_property
def name(self):
with the difference that it's guessed from the run file if the import name is main. This name is used as a display name when Flask needs the name of the application. It can be set and overriden to change the value.
.. versionadded:: 0.8
if self.import_name == '__main__':
fn = getattr(sys.modules['__main__'], '__file__', None)
if fn is None:
return '__main__'
return os.path.splitext(os.path.basename(fn))[0]
return self.import_name
Returns the value of the PROPAGATE_EXCEPTIONS
configuration
@property
def propagate_exceptions(self):
rv = self.config['PROPAGATE_EXCEPTIONS']
if rv is not None:
return rv
return self.testing or self.debug
Returns the value of the PRESERVE_CONTEXT_ON_EXCEPTION
@property
def preserve_context_on_exception(self):
configuration value in case it's set, otherwise a sensible default is returned.
.. versionadded:: 0.7
rv = self.config['PRESERVE_CONTEXT_ON_EXCEPTION']
if rv is not None:
return rv
return self.debug
A :class:logging.Logger
object for this application. The
@property
def logger(self):
default configuration is to log to stderr if the application is in debug mode. This logger can be used to (surprise) log messages. Here some examples::
app.logger.debug('A value for debugging')
app.logger.warning('A warning occurred (%d apples)', 42)
app.logger.error('An error occurred')
.. versionadded:: 0.3
if self._logger and self._logger.name == self.logger_name:
return self._logger
with _logger_lock:
if self._logger and self._logger.name == self.logger_name:
return self._logger
from flask.logging import create_logger
self._logger = rv = create_logger(self)
return rv
The Jinja2 environment used to load templates.
@locked_cached_property
def jinja_env(self):
rv = self.create_jinja_environment()
Hack to support the init_jinja_globals method which is supported until 1.0 but has an API deficiency.
if getattr(self.init_jinja_globals, 'im_func', None) is not \
Flask.init_jinja_globals.im_func:
from warnings import warn
warn(DeprecationWarning('This flask class uses a customized '
'init_jinja_globals() method which is deprecated. '
'Move the code from that method into the '
'create_jinja_environment() method instead.'))
self.__dict__['jinja_env'] = rv
self.init_jinja_globals()
return rv
This attribute is set to True
if the application started
@property
def got_first_request(self):
return self._got_first_request
Used to create the config attribute by the Flask constructor.
def make_config(self, instance_relative=False):
The instance_relative
parameter is passed in from the constructor
of Flask (there named instance_relative_config
) and indicates if
the config should be relative to the instance path or the root path
of the application.
.. versionadded:: 0.8
root_path = self.root_path
if instance_relative:
root_path = self.instance_path
return Config(root_path, self.default_config)
Tries to locate the instance path if it was not provided to the
def auto_find_instance_path(self):
constructor of the application class. It will basically calculate
the path to a folder named instance
next to your main file or
the package.
.. versionadded:: 0.8
prefix, package_path = find_package(self.import_name)
if prefix is None:
return os.path.join(package_path, 'instance')
return os.path.join(prefix, 'var', self.name + '-instance')
Opens a resource from the application's instance folder
def open_instance_resource(self, resource, mode='rb'):
(:attr:instance_path
). Otherwise works like
:meth:open_resource
. Instance resources can also be opened for
writing.
:param resource: the name of the resource. To access resources within subfolders use forward slashes as separator.
return open(os.path.join(self.instance_path, resource), mode)
Creates the Jinja2 environment based on :attr:jinja_options
def create_jinja_environment(self):
and :meth:select_jinja_autoescape
. Since 0.7 this also adds
the Jinja2 globals and filters after initialization. Override
this function to customize the behavior.
.. versionadded:: 0.5
options = dict(self.jinja_options)
if 'autoescape' not in options:
options['autoescape'] = self.select_jinja_autoescape
rv = Environment(self, **options)
rv.globals.update(
url_for=url_for,
get_flashed_messages=get_flashed_messages,
config=self.config,
request, session and g are normally added with the context processor for efficiency reasons but for imported templates we also want the proxies in there.
request=request,
session=session,
g=g
)
rv.filters['tojson'] = json.htmlsafe_dumps
return rv
Creates the loader for the Jinja2 environment. Can be used to
def create_global_jinja_loader(self):
override just the loader and keeping the rest unchanged. It's
discouraged to override this function. Instead one should override
the :meth:jinja_loader
function instead.
The global loader dispatches between the loaders of the application and the individual blueprints.
.. versionadded:: 0.7
return DispatchingJinjaLoader(self)
Deprecated. Used to initialize the Jinja2 globals.
def init_jinja_globals(self):
.. versionadded:: 0.5
.. versionchanged:: 0.7
This method is deprecated with 0.7. Override
:meth:create_jinja_environment
instead.
Returns True
if autoescaping should be active for the given
def select_jinja_autoescape(self, filename):
if filename is None:
return False
return filename.endswith(('.html', '.htm', '.xml', '.xhtml'))
Update the template context with some commonly used variables.
def update_template_context(self, context):
This injects request, session, config and g into the template context as well as everything template context processors want to inject. Note that the as of Flask 0.6, the original values in the context will not be overriden if a context processor decides to return a value with the same key.
:param context: the context as a dictionary that is updated in place to add extra variables.
funcs = self.template_context_processors[None]
reqctx = _request_ctx_stack.top
if reqctx is not None:
bp = reqctx.request.blueprint
if bp is not None and bp in self.template_context_processors:
funcs = chain(funcs, self.template_context_processors[bp])
orig_ctx = context.copy()
for func in funcs:
context.update(func())
make sure the original values win. This makes it possible to easier add new variables in context processors without breaking existing views.
context.update(orig_ctx)
Runs the application on a local development server. If the
def run(self, host=None, port=None, debug=None, **options):
:attr:debug
flag is set the server will automatically reload
for code changes and show a debugger in case an exception happened.
If you want to run the application in debug mode, but disable the
code execution on the interactive debugger, you can pass
use_evalex=False
as parameter. This will keep the debugger's
traceback screen active, but disable code execution.
.. admonition:: Keep in Mind
Flask will suppress any server error with a generic error page
unless it is in debug mode. As such to enable just the
interactive debugger without the code reloading, you have to
invoke :meth:run
with debug=True
and use_reloader=False
.
Setting use_debugger
to True
without being in debug mode
won't catch any exceptions because there won't be any to
catch.
:param host: the hostname to listen on. Set this to '<IP_ADDRESS>'
to
have the server available externally as well. Defaults to
'<IP_ADDRESS>'
.
:param port: the port of the webserver. Defaults to 5000
.
:param debug: if given, enable or disable debug mode.
See :attr:debug
.
:param options: the options to be forwarded to the underlying
Werkzeug server. See
:func:werkzeug.serving.run_simple
for more
information.
from werkzeug.serving import run_simple
if host is None:
host = '<IP_ADDRESS>'
if port is None:
port = 5000
if debug is not None:
self.debug = bool(debug)
options.setdefault('use_reloader', self.debug)
options.setdefault('use_debugger', self.debug)
try:
run_simple(host, port, self, **options)
finally:
reset the first request information if the development server resetted normally. This makes it possible to restart the server without reloader and that stuff from an interactive shell.
self._got_first_request = False
Creates a test client for this application. For information
def test_client(self, use_cookies=True):
about unit testing head over to :ref:testing
.
Note that if you are testing for assertions or exceptions in your
application code, you must set app.testing = True
in order for the
exceptions to propagate to the test client. Otherwise, the exception
will be handled by the application (not visible to the test client) and
the only indication of an AssertionError or other exception will be a
500 status code response to the test client. See the :attr:testing
attribute. For example::
app.testing = True
client = app.test_client()
The test client can be used in a with
block to defer the closing down
of the context until the end of the with
block. This is useful if
you want to access the context locals for testing::
with app.test_client() as c:
rv = c.get('/?vodka=42')
assert request.args['vodka'] == '42'
See :class:~flask.testing.FlaskClient
for more information.
.. versionchanged:: 0.4
added support for with
block usage for the client.
.. versionadded:: 0.7
The use_cookies
parameter was added as well as the ability
to override the client to be used by setting the
:attr:test_client_class
attribute.
cls = self.test_client_class
if cls is None:
from flask.testing import FlaskClient as cls
return cls(self, self.response_class, use_cookies=use_cookies)
Creates or opens a new session. Default implementation stores all
def open_session(self, request):
session data in a signed cookie. This requires that the
:attr:secret_key
is set. Instead of overriding this method
we recommend replacing the :class:session_interface
.
:param request: an instance of :attr:request_class
.
return self.session_interface.open_session(self, request)
Saves the session if it needs updates. For the default
def save_session(self, session, response):
implementation, check :meth:open_session
. Instead of overriding this
method we recommend replacing the :class:session_interface
.
:param session: the session to be saved (a
:class:~werkzeug.contrib.securecookie.SecureCookie
object)
:param response: an instance of :attr:response_class
return self.session_interface.save_session(self, session, response)
Creates a new instance of a missing session. Instead of overriding
def make_null_session(self):
return self.session_interface.make_null_session(self)
Registers a module with this application. The keyword argument
def register_module(self, module, **options):
of this function are the same as the ones for the constructor of the
:class:Module
class and will override the values of the module if
provided.
.. versionchanged:: 0.7 The module system was deprecated in favor for the blueprint system.
assert blueprint_is_module(module), 'register_module requires ' \
'actual module objects. Please upgrade to blueprints though.'
if not self.enable_modules:
raise RuntimeError('Module support was disabled but code '
'attempted to register a module named %r' % module)
else:
from warnings import warn
warn(DeprecationWarning('Modules are deprecated. Upgrade to '
'using blueprints. Have a look into the documentation for '
'more information. If this module was registered by a '
'Flask-Extension upgrade the extension or contact the author '
'of that extension instead. (Registered %r)' % module),
stacklevel=2)
self.register_blueprint(module, **options)
Registers a blueprint on the application.
@setupmethod
def register_blueprint(self, blueprint, **options):
.. versionadded:: 0.7
first_registration = False
if blueprint.name in self.blueprints:
assert self.blueprints[blueprint.name] is blueprint, \
'A blueprint\'s name collision occurred between %r and ' \
'%r. Both share the same name "%s". Blueprints that ' \
'are created on the fly need unique names.' % \
(blueprint, self.blueprints[blueprint.name], blueprint.name)
else:
self.blueprints[blueprint.name] = blueprint
first_registration = True
blueprint.register(self, options, first_registration)
Connects a URL rule. Works exactly like the :meth:route
@setupmethod
def add_url_rule(self, rule, endpoint=None, view_func=None, **options):
decorator. If a view_func is provided it will be registered with the endpoint.
Basically this example::
@app.route('/')
def index():
pass
Is equivalent to the following::
def index():
pass
app.add_url_rule('/', 'index', index)
If the view_func is not provided you will need to connect the endpoint to a view function like so::
app.view_functions['index'] = index
Internally :meth:route
invokes :meth:add_url_rule
so if you want
to customize the behavior via subclassing you only need to change
this method.
For more information refer to :ref:url-route-registrations
.
.. versionchanged:: 0.2
view_func
parameter added.
.. versionchanged:: 0.6
OPTIONS
is added automatically as method.
:param rule: the URL rule as string
:param endpoint: the endpoint for the registered URL rule. Flask
itself assumes the name of the view function as
endpoint
:param view_func: the function to call when serving a request to the
provided endpoint
:param options: the options to be forwarded to the underlying
:class:~werkzeug.routing.Rule
object. A change
to Werkzeug is handling of method options. methods
is a list of methods this rule should be limited
to (GET
, POST
etc.). By default a rule
just listens for GET
(and implicitly HEAD
).
Starting with Flask 0.6, OPTIONS
is implicitly
added and handled by the standard request handling.
if endpoint is None:
endpoint = _endpoint_from_view_func(view_func)
options['endpoint'] = endpoint
methods = options.pop('methods', None)
if the methods are not given and the view_func object knows its
methods we can use that instead. If neither exists, we go with
a tuple of only GET
as default.
if methods is None:
methods = getattr(view_func, 'methods', None) or ('GET',)
methods = set(methods)
Methods that should always be added
required_methods = set(getattr(view_func, 'required_methods', ()))
starting with Flask 0.8 the view_func object can disable and force-enable the automatic options handling.
provide_automatic_options = getattr(view_func,
'provide_automatic_options', None)
if provide_automatic_options is None:
if 'OPTIONS' not in methods:
provide_automatic_options = True
required_methods.add('OPTIONS')
else:
provide_automatic_options = False
Add the required methods now.
methods |= required_methods
due to a werkzeug bug we need to make sure that the defaults are None if they are an empty dictionary. This should not be necessary with Werkzeug 0.7
options['defaults'] = options.get('defaults') or None
rule = self.url_rule_class(rule, methods=methods, **options)
rule.provide_automatic_options = provide_automatic_options
self.url_map.add(rule)
if view_func is not None:
old_func = self.view_functions.get(endpoint)
if old_func is not None and old_func is not view_func:
raise AssertionError('View function mapping is overwriting an '
'existing endpoint function: %s' % endpoint)
self.view_functions[endpoint] = view_func
A decorator that is used to register a view function for a
def route(self, rule, **options):
given URL rule. This does the same thing as :meth:add_url_rule
but is intended for decorator usage::
@app.route('/')
def index():
return 'Hello World'
For more information refer to :ref:url-route-registrations
.
:param rule: the URL rule as string
:param endpoint: the endpoint for the registered URL rule. Flask
itself assumes the name of the view function as
endpoint
:param view_func: the function to call when serving a request to the
provided endpoint
:param options: the options to be forwarded to the underlying
:class:~werkzeug.routing.Rule
object. A change
to Werkzeug is handling of method options. methods
is a list of methods this rule should be limited
to (GET
, POST
etc.). By default a rule
just listens for GET
(and implicitly HEAD
).
Starting with Flask 0.6, OPTIONS
is implicitly
added and handled by the standard request handling.
def decorator(f):
endpoint = options.pop('endpoint', None)
self.add_url_rule(rule, endpoint, f, **options)
return f
return decorator
A decorator to register a function as an endpoint.
@setupmethod
def endpoint(self, endpoint):
Example::
@app.endpoint('example.endpoint')
def example():
return "example"
:param endpoint: the name of the endpoint
def decorator(f):
self.view_functions[endpoint] = f
return f
return decorator
A decorator that is used to register a function give a given
@setupmethod
def errorhandler(self, code_or_exception):
error code. Example::
@app.errorhandler(404)
def page_not_found(error):
return 'This page does not exist', 404
You can also register handlers for arbitrary exceptions::
@app.errorhandler(DatabaseError)
def special_exception_handler(error):
return 'Database connection failed', 500
You can also register a function as error handler without using
the :meth:errorhandler
decorator. The following example is
equivalent to the one above::
def page_not_found(error):
return 'This page does not exist', 404
app.error_handler_spec[None][404] = page_not_found
Setting error handlers via assignments to :attr:error_handler_spec
however is discouraged as it requires fidling with nested dictionaries
and the special case for arbitrary exception types.
The first None
refers to the active blueprint. If the error
handler should be application wide None
shall be used.
.. versionadded:: 0.7
One can now additionally also register custom exception types
that do not necessarily have to be a subclass of the
:class:~werkzeug.exceptions.HTTPException
class.
:param code: the code as integer for the handler
def decorator(f):
self._register_error_handler(None, code_or_exception, f)
return f
return decorator
Alternative error attach function to the :meth:errorhandler
def register_error_handler(self, code_or_exception, f):
self._register_error_handler(None, code_or_exception, f)
A decorator that is used to register custom template filter.
@setupmethod
def _register_error_handler(self, key, code_or_exception, f):
if isinstance(code_or_exception, HTTPException):
code_or_exception = code_or_exception.code
if isinstance(code_or_exception, (int, long)):
assert code_or_exception != 500 or key is None, \
'It is currently not possible to register a 500 internal ' \
'server error on a per-blueprint level.'
self.error_handler_spec.setdefault(key, {})[code_or_exception] = f
else:
self.error_handler_spec.setdefault(key, {}).setdefault(None, []) \
.append((code_or_exception, f))
@setupmethod
def template_filter(self, name=None):
You can specify a name for the filter, otherwise the function name will be used. Example::
@app.template_filter() def reverse(s): return s[::-1]
:param name: the optional name of the filter, otherwise the function name will be used.
def decorator(f):
self.add_template_filter(f, name=name)
return f
return decorator
Register a custom template filter. Works exactly like the
@setupmethod
def add_template_filter(self, f, name=None):
:meth:template_filter
decorator.
:param name: the optional name of the filter, otherwise the function name will be used.
self.jinja_env.filters[name or f.__name__] = f
A decorator that is used to register custom template test.
@setupmethod
def template_test(self, name=None):
You can specify a name for the test, otherwise the function name will be used. Example::
@app.template_test() def is_prime(n): if n == 2: return True for i in xrange(2, int(math.ceil(math.sqrt(n))) + 1): if n % i == 0: return False return True
.. versionadded:: 0.10
:param name: the optional name of the test, otherwise the function name will be used.
def decorator(f):
self.add_template_test(f, name=name)
return f
return decorator
Register a custom template test. Works exactly like the
@setupmethod
def add_template_test(self, f, name=None):
:meth:template_test
decorator.
.. versionadded:: 0.10
:param name: the optional name of the test, otherwise the function name will be used.
self.jinja_env.tests[name or f.__name__] = f
A decorator that is used to register a custom template global function.
@setupmethod
def template_global(self, name=None):
You can specify a name for the global function, otherwise the function name will be used. Example::
@app.template_global() def double(n): return 2 * n
.. versionadded:: 0.10
:param name: the optional name of the global function, otherwise the function name will be used.
def decorator(f):
self.add_template_global(f, name=name)
return f
return decorator
Register a custom template global function. Works exactly like the
@setupmethod
def add_template_global(self, f, name=None):
:meth:template_global
decorator.
.. versionadded:: 0.10
:param name: the optional name of the global function, otherwise the function name will be used.
self.jinja_env.globals[name or f.__name__] = f
Registers a function to run before each request.
@setupmethod
def before_request(self, f):
self.before_request_funcs.setdefault(None, []).append(f)
return f
Registers a function to be run before the first request to this
@setupmethod
def before_first_request(self, f):
self.before_first_request_funcs.append(f)
Register a function to be run after each request. Your function
@setupmethod
def after_request(self, f):
must take one parameter, a :attr:response_class
object and return
a new response object or the same (see :meth:process_response
).
As of Flask 0.7 this function might not be executed at the end of the request in case an unhandled exception occurred.
self.after_request_funcs.setdefault(None, []).append(f)
return f
Register a function to be run at the end of each request,
@setupmethod
def teardown_request(self, f):
regardless of whether there was an exception or not. These functions are executed when the request context is popped, even if not an actual request was performed.
Example::
ctx = app.test_request_context()
ctx.push()
...
ctx.pop()
When ctx.pop()
is executed in the above example, the teardown
functions are called just before the request context moves from the
stack of active contexts. This becomes relevant if you are using
such constructs in tests.
Generally teardown functions must take every necessary step to avoid that they will fail. If they do execute code that might fail they will have to surround the execution of these code by try/except statements and log occurring errors.
When a teardown function was called because of a exception it will be passed an error object.
.. admonition:: Debug Note
In debug mode Flask will not tear down a request on an exception
immediately. Instead if will keep it alive so that the interactive
debugger can still access it. This behavior can be controlled
by the PRESERVE_CONTEXT_ON_EXCEPTION
configuration variable.
self.teardown_request_funcs.setdefault(None, []).append(f)
return f
Registers a function to be called when the application context
@setupmethod
def teardown_appcontext(self, f):
ends. These functions are typically also called when the request context is popped.
Example::
ctx = app.app_context()
ctx.push()
...
ctx.pop()
When ctx.pop()
is executed in the above example, the teardown
functions are called just before the app context moves from the
stack of active contexts. This becomes relevant if you are using
such constructs in tests.
Since a request context typically also manages an application context it would also be called when you pop a request context.
When a teardown function was called because of an exception it will be passed an error object.
.. versionadded:: 0.9
self.teardown_appcontext_funcs.append(f)
return f
Registers a template context processor function.
@setupmethod
def context_processor(self, f):
self.template_context_processors[None].append(f)
return f
Registers a function as URL value preprocessor for all view
@setupmethod
def url_value_preprocessor(self, f):
functions of the application. It's called before the view functions are called and can modify the url values provided.
self.url_value_preprocessors.setdefault(None, []).append(f)
return f
Callback function for URL defaults for all view functions of the
@setupmethod
def url_defaults(self, f):
application. It's called with the endpoint and values and should update the values passed in place.
self.url_default_functions.setdefault(None, []).append(f)
return f
Handles an HTTP exception. By default this will invoke the
def handle_http_exception(self, e):
registered error handlers and fall back to returning the exception as response.
.. versionadded:: 0.3
handlers = self.error_handler_spec.get(request.blueprint)
Proxy exceptions don't have error codes. We want to always return those unchanged as errors
if e.code is None:
return e
if handlers and e.code in handlers:
handler = handlers[e.code]
else:
handler = self.error_handler_spec[None].get(e.code)
if handler is None:
return e
return handler(e)
Checks if an HTTP exception should be trapped or not. By default
def trap_http_exception(self, e):
this will return False
for all exceptions except for a bad request
key error if TRAP_BAD_REQUEST_ERRORS
is set to True
. It
also returns True
if TRAP_HTTP_EXCEPTIONS
is set to True
.
This is called for all HTTP exceptions raised by a view function.
If it returns True
for any exception the error handler for this
exception is not called and it shows up as regular exception in the
traceback. This is helpful for debugging implicitly raised HTTP
exceptions.
.. versionadded:: 0.8
if self.config['TRAP_HTTP_EXCEPTIONS']:
return True
if self.config['TRAP_BAD_REQUEST_ERRORS']:
return isinstance(e, BadRequest)
return False
This method is called whenever an exception occurs that should be
def handle_user_exception(self, e):
handled. A special case are
:class:~werkzeug.exception.HTTPException
\s which are forwarded by
this function to the :meth:handle_http_exception
method. This
function will either return a response value or reraise the
exception with the same traceback.
.. versionadded:: 0.7
exc_type, exc_value, tb = sys.exc_info()
assert exc_value is e
ensure not to trash sys.exc_info() at that point in case someone wants the traceback preserved in handle_http_exception. Of course we cannot prevent users from trashing it themselves in a custom trap_http_exception method so that's their fault then.
if isinstance(e, HTTPException) and not self.trap_http_exception(e):
return self.handle_http_exception(e)
blueprint_handlers = ()
handlers = self.error_handler_spec.get(request.blueprint)
if handlers is not None:
blueprint_handlers = handlers.get(None, ())
app_handlers = self.error_handler_spec[None].get(None, ())
for typecheck, handler in chain(blueprint_handlers, app_handlers):
if isinstance(e, typecheck):
return handler(e)
raise exc_type, exc_value, tb
Default exception handling that kicks in when an exception
def handle_exception(self, e):
occurs that is not caught. In debug mode the exception will be re-raised immediately, otherwise it is logged and the handler for a 500 internal server error is used. If no such handler exists, a default 500 internal server error message is displayed.
.. versionadded:: 0.3
exc_type, exc_value, tb = sys.exc_info()
got_request_exception.send(self, exception=e)
handler = self.error_handler_spec[None].get(500)
if self.propagate_exceptions:
if we want to repropagate the exception, we can attempt to raise it with the whole traceback in case we can do that (the function was actually called from the except part) otherwise, we just raise the error again
if exc_value is e:
raise exc_type, exc_value, tb
else:
raise e
self.log_exception((exc_type, exc_value, tb))
if handler is None:
return InternalServerError()
return handler(e)
Logs an exception. This is called by :meth:handle_exception
def log_exception(self, exc_info):
if debugging is disabled and right before the handler is called.
The default implementation logs the exception as error on the
:attr:logger
.
.. versionadded:: 0.8
self.logger.error('Exception on %s [%s]' % (
request.path,
request.method
), exc_info=exc_info)
Exceptions that are recording during routing are reraised with
def raise_routing_exception(self, request):
this method. During debug we are not reraising redirect requests
for non GET
, HEAD
, or OPTIONS
requests and we're raising
a different error instead to help debug situations.
:internal:
if not self.debug \
or not isinstance(request.routing_exception, RequestRedirect) \
or request.method in ('GET', 'HEAD', 'OPTIONS'):
raise request.routing_exception
from .debughelpers import FormDataRoutingRedirect
raise FormDataRoutingRedirect(request)
Does the request dispatching. Matches the URL and returns the
def dispatch_request(self):
return value of the view or error handler. This does not have to
be a response object. In order to convert the return value to a
proper response object, call :func:make_response
.
.. versionchanged:: 0.7
This no longer does the exception handling, this code was
moved to the new :meth:full_dispatch_request
.
req = _request_ctx_stack.top.request
if req.routing_exception is not None:
self.raise_routing_exception(req)
rule = req.url_rule
if we provide automatic options for this URL and the request came with the OPTIONS method, reply automatically
if getattr(rule, 'provide_automatic_options', False) \
and req.method == 'OPTIONS':
return self.make_default_options_response()
otherwise dispatch to the handler for that endpoint
return self.view_functions[rule.endpoint](**req.view_args)
Dispatches the request and on top of that performs request
def full_dispatch_request(self):
pre and postprocessing as well as HTTP exception catching and error handling.
.. versionadded:: 0.7
self.try_trigger_before_first_request_functions()
try:
request_started.send(self)
rv = self.preprocess_request()
if rv is None:
rv = self.dispatch_request()
except Exception, e:
rv = self.handle_user_exception(e)
response = self.make_response(rv)
response = self.process_response(response)
request_finished.send(self, response=response)
return response
Called before each request and will ensure that it triggers
def try_trigger_before_first_request_functions(self):
the :attr:before_first_request_funcs
and only exactly once per
application instance (which means process usually).
:internal:
if self._got_first_request:
return
with self._before_request_lock:
if self._got_first_request:
return
self._got_first_request = True
for func in self.before_first_request_funcs:
func()
This method is called to create the default OPTIONS
response.
def make_default_options_response(self):
This can be changed through subclassing to change the default
behavior of OPTIONS
responses.
.. versionadded:: 0.7
adapter = _request_ctx_stack.top.url_adapter
if hasattr(adapter, 'allowed_methods'):
methods = adapter.allowed_methods()
else:
fallback for Werkzeug < 0.7
methods = []
try:
adapter.match(method='--')
except MethodNotAllowed, e:
methods = e.valid_methods
except HTTPException, e:
pass
rv = self.response_class()
rv.allow.update(methods)
return rv
Converts the return value from a view function to a real
def make_response(self, rv):
response object that is an instance of :attr:response_class
.
The following types are allowed for rv
:
.. tabularcolumns:: |p{3.5cm}|p{9.5cm}|
======================= ===========================================
:attr:response_class
the object is returned unchanged
:class:str
a response object is created with the
string as body
:class:unicode
a response object is created with the
string encoded to utf-8 as body
a WSGI function the function is called as WSGI application
and buffered as response object
:class:tuple
A tuple in the form (response, status,
headers)
where response
is any of the
types defined here, status
is a string
or an integer and headers
is a list of
a dictionary with header values.
======================= ===========================================
:param rv: the return value from the view function
.. versionchanged:: 0.9 Previously a tuple was interpreted as the arguments for the response object.
status = headers = None
if isinstance(rv, tuple):
rv, status, headers = rv + (None,) * (3 - len(rv))
if rv is None:
raise ValueError('View function did not return a response')
if not isinstance(rv, self.response_class):
When we create a response object directly, we let the constructor set the headers and status. We do this because there can be some extra logic involved when creating these objects with specific values (like defualt content type selection).
if isinstance(rv, basestring):
rv = self.response_class(rv, headers=headers, status=status)
headers = status = None
else:
rv = self.response_class.force_type(rv, request.environ)
if status is not None:
if isinstance(status, basestring):
rv.status = status
else:
rv.status_code = status
if headers:
rv.headers.extend(headers)
return rv
Creates a URL adapter for the given request. The URL adapter
def create_url_adapter(self, request):
is created at a point where the request context is not yet set up so the request is passed explicitly.
.. versionadded:: 0.6
.. versionchanged:: 0.9 This can now also be called without a request object when the URL adapter is created for the application context.
if request is not None:
return self.url_map.bind_to_environ(request.environ,
server_name=self.config['SERVER_NAME'])
We need at the very least the server name to be set for this to work.
if self.config['SERVER_NAME'] is not None:
return self.url_map.bind(
self.config['SERVER_NAME'],
script_name=self.config['APPLICATION_ROOT'] or '/',
url_scheme=self.config['PREFERRED_URL_SCHEME'])
Injects the URL defaults for the given endpoint directly into
def inject_url_defaults(self, endpoint, values):
the values dictionary passed. This is used internally and automatically called on URL building.
.. versionadded:: 0.7
funcs = self.url_default_functions.get(None, ())
if '.' in endpoint:
bp = endpoint.rsplit('.', 1)[0]
funcs = chain(funcs, self.url_default_functions.get(bp, ()))
for func in funcs:
func(endpoint, values)
Handle :class:~werkzeug.routing.BuildError
on :meth:url_for
.
def handle_url_build_error(self, error, endpoint, values):
exc_type, exc_value, tb = sys.exc_info()
for handler in self.url_build_error_handlers:
try:
rv = handler(error, endpoint, values)
if rv is not None:
return rv
except BuildError, error:
pass
At this point we want to reraise the exception. If the error is still the same one we can reraise it with the original traceback, otherwise we raise it from here.
if error is exc_value:
raise exc_type, exc_value, tb
raise error
Called before the actual request dispatching and will
def preprocess_request(self):
call every as :meth:before_request
decorated function.
If any of these function returns a value it's handled as
if it was the return value from the view and further
request handling is stopped.
This also triggers the :meth:url_value_processor
functions before
the actual :meth:before_request
functions are called.
bp = _request_ctx_stack.top.request.blueprint
funcs = self.url_value_preprocessors.get(None, ())
if bp is not None and bp in self.url_value_preprocessors:
funcs = chain(funcs, self.url_value_preprocessors[bp])
for func in funcs:
func(request.endpoint, request.view_args)
funcs = self.before_request_funcs.get(None, ())
if bp is not None and bp in self.before_request_funcs:
funcs = chain(funcs, self.before_request_funcs[bp])
for func in funcs:
rv = func()
if rv is not None:
return rv
Can be overridden in order to modify the response object
def process_response(self, response):
before it's sent to the WSGI server. By default this will
call all the :meth:after_request
decorated functions.
.. versionchanged:: 0.5 As of Flask 0.5 the functions registered for after request execution are called in reverse order of registration.
:param response: a :attr:response_class
object.
:return: a new response object or the same, has to be an
instance of :attr:response_class
.
ctx = _request_ctx_stack.top
bp = ctx.request.blueprint
funcs = ctx._after_request_functions
if bp is not None and bp in self.after_request_funcs:
funcs = reversed(self.after_request_funcs[bp])
if None in self.after_request_funcs:
funcs = chain(funcs, reversed(self.after_request_funcs[None]))
for handler in funcs:
response = handler(response)
if not self.session_interface.is_null_session(ctx.session):
self.save_session(ctx.session, response)
return response
Called after the actual request dispatching and will
def do_teardown_request(self, exc=None):
call every as :meth:teardown_request
decorated function. This is
not actually called by the :class:Flask
object itself but is always
triggered when the request context is popped. That way we have a
tighter control over certain resources under testing environments.
.. versionchanged:: 0.9
Added the exc
argument. Previously this was always using the
current exception information.
if exc is None:
exc = sys.exc_info()[1]
funcs = reversed(self.teardown_request_funcs.get(None, ()))
bp = _request_ctx_stack.top.request.blueprint
if bp is not None and bp in self.teardown_request_funcs:
funcs = chain(funcs, reversed(self.teardown_request_funcs[bp]))
for func in funcs:
rv = func(exc)
request_tearing_down.send(self, exc=exc)
Called when an application context is popped. This works pretty
def do_teardown_appcontext(self, exc=None):
if exc is None:
exc = sys.exc_info()[1]
for func in reversed(self.teardown_appcontext_funcs):
func(exc)
appcontext_tearing_down.send(self, exc=exc)
Binds the application only. For as long as the application is bound
def app_context(self):
to the current context the :data:flask.current_app
points to that
application. An application context is automatically created when a
request context is pushed if necessary.
Example usage::
with app.app_context():
...
.. versionadded:: 0.9
return AppContext(self)
Creates a :class:~flask.ctx.RequestContext
from the given
def request_context(self, environ):
environment and binds it to the current context. This must be used in
combination with the with
statement because the request is only bound
to the current context for the duration of the with
block.
Example usage::
with app.request_context(environ):
do_something_with(request)
The object returned can also be used without the with
statement
which is useful for working in the shell. The example above is
doing exactly the same as this code::
ctx = app.request_context(environ)
ctx.push()
try:
do_something_with(request)
finally:
ctx.pop()
.. versionchanged:: 0.3
Added support for non-with statement usage and with
statement
is now passed the ctx object.
:param environ: a WSGI environment
return RequestContext(self, environ)
Creates a WSGI environment from the given values (see
def test_request_context(self, *args, **kwargs):
:func:werkzeug.test.EnvironBuilder
for more information, this
function accepts the same arguments).
from flask.testing import make_test_environ_builder
builder = make_test_environ_builder(self, *args, **kwargs)
try:
return self.request_context(builder.get_environ())
finally:
builder.close()
The actual WSGI application. This is not implemented in
def wsgi_app(self, environ, start_response):
__call__
so that middlewares can be applied without losing a
reference to the class. So instead of doing this::
app = MyMiddleware(app)
It's a better idea to do this instead::
app.wsgi_app = MyMiddleware(app.wsgi_app)
Then you still have the original application object around and can continue to call methods on it.
.. versionchanged:: 0.7
The behavior of the before and after request callbacks was changed
under error conditions and a new callback was added that will
always execute at the end of the request, independent on if an
error occurred or not. See :ref:callbacks-and-errors
.
:param environ: a WSGI environment :param start_response: a callable accepting a status code, a list of headers and an optional exception context to start the response
with self.request_context(environ):
try:
response = self.full_dispatch_request()
except Exception, e:
response = self.make_response(self.handle_exception(e))
return response(environ, start_response)
Shortcut for :attr:wsgi_app
.
@property
def modules(self):
from warnings import warn
warn(DeprecationWarning('Flask.modules is deprecated, use '
'Flask.blueprints instead'), stacklevel=2)
return self.blueprints
def __call__(self, environ, start_response):
return self.wsgi_app(environ, start_response)


--- layout: default ---
Welcome to Processor Architecture and Memory System Lab! Lab Github yhgonglab@gmail.com


* Category Keys : = Today's Works, = Meetings, = Tips, = etc
Have an account? Log In
Don't have an account? Sign Up


These detached one-bedroom beach front villas are sumptuously furnished. Mahogany louvered panels and intricate lofty ceilings impart a colonial feel, while teak furniture and suspended bamboo lights bring nature indoors. Wall to wall glass doors frame the terrace and private pool. By day the villas are filled with light, yet remain secluded by clusters of palms.
An indoor bathroom with Romeo and Juliet basins opens onto a large outdoor bathroom connected by a garden atrium where a gazebo covered daybed overlooks the oversized tub. Day beds, swinging chairs and an alfresco dining area face the Indian Ocean.
Accessible only by boat, this ultra-private one-bedroom villa suspended above the lagoon with uninterrupted views of the ocean offers the utmost privacy and romance, making it perfect for honeymooners or those who are looking for ultra-luxury, including a private chef and butler.
All rooms open onto the terraces, where the Jacuzzi, pool, sundeck and sunken bath offer varying aspects towards the horizon. Dine inside or over the water in a dining gazebo on its own jetty at sunset, or enjoy sundowners on the sumptuous daybeds. The interiors are designed with natural materials and neutral colours with occasional ikat accents or animal prints. With a personal gym and spa treatment rooms inside the residence, there’s little reason to leave.
With uninterrupted ocean views and private pools facing the sunset, these villas are dreamlike in design. Separated by canvas sails, they ensure the utmost privacy. Thatched roofing shades the outdoor dining area, while the bedroom and bathroom open onto the terrace.
The pool and sun deck have steps leading into the ocean, while under the gazebo a vast daybed scattered with cushions catches the final moments of the sunset. Inside, the large comfortable living room has its own bar area complete with a private wine fridge and is designed around a viewing window set into the floor. Huge bathrooms with circular baths and a swinging chair reflect the water surrounding the villa.
Prestigiously located on the tip of the island, in an exclusive private domain, this two-bedroom overwater residence fringed with traditional thatch offers an elegant living space with carefully curated elements. Louvered shutters let the breeze flow through, while a deep sofa is covered in scatter cushions, ideal for settling down with a good book.
The dining area provides a central space while the ocean is the backdrop from every aspect – from the two spacious bathrooms featuring circular baths, to the elegant bedrooms. Swim in your own pool and relax on the sun deck, or step directly into the lagoon. Kick back under one of two gazebos – one with a sunken hot tub and the other with daybeds.
Imagine the definitive ultimate beach residence. With four bedrooms accommodating up to 10 guests, a rarity in the Maldives, the Velaa Private Residences offer elegant contemporary design and 1,350 square metres of private interior and exterior space, inclusive of two terraces, a pool and a courtyard.
Secluded on a pristine private beach, the carefully curated interiors deliver comfort, style and elegance in equal measures. These two-storey detached residences are laid out with privacy in mind. Each of the four bedrooms face the ocean across a stretch of icing sugar sand; the first floor bedrooms have generous balconies, while the ground floor rooms open onto the pool. Indoor and outdoor bathrooms are connected by a garden atrium.
Flanked by two gazebos for dining, relaxation or playing, the pool reflects the ocean and is the central focus. Behind the living space a gym, spa room and outdoor living area offer plenty of quiet spaces to retire to. These residences set a new level of ultimate luxury in the Maldives for friends and families alike.


Getting started with Sphinx¶
While attending and presenting at Mac Admin and Developer conference, MacAD.uk there was a session Your code should document itself! Embedding documentation into your Python projects that interested me. Awesome content presented by Bryson, I knew someday this would be useful. Working on a project, people were asking for documentation explaing our processes. Like any good project, we didn’t have any centralized methodical represenation of our thoughts, why not use Sphinx?
Sphinx¶
Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.
Install Sphinx¶
pip install sphinx
- Make a directory somewhere to house your Sphinx projects.
mkdir /place/to/store/sphinx/docs
- Change into your new directory.
cd /place/where/you/stored/sphinx/docs
- Next start your project by running
sphinx-quickstart
Setting up your Sphinx project¶
After runnin sphinx-quickstart
you should see the following output.
the default setting is in []
, press return for the default setting.
- Follow along with the promts that get outputted after your selections.
- Name the project
- Add the author and give the project a version number.
After completing all the prompts, I suggest creating the Makefile.
Congrats!! your first sphinx project is now started!
Working with your new Sphinx project¶
Navagate to the directory you setup for your documentation, and you should see something similar:
I use atom to edit the conf.py
and index.rst
files. There are plenty of editors you
can choose from such as Sublime or BBedit.
- Open terminal and
cd
to the project directory.- Next let’s create some
.rst
files to get our documentation started.- While in the current project directory,
touch mysphinxdirections.rst
to create a Restructured Text file.
I’d create a couple of files to get started. For example, some docs used to create this project are called
- sphinxgettingstarted.rst
- GitLabsetup.rst
- runnersetup.rst
Avoid spaces, and try to keep the filename relevant to it’s function.
Open your editor and open your project. Open your .rst
files and give them a title heading.
Make sure to save the files after adding the heading.
Next open your index.rst, and add the .rst
files you touched in the terminal.
Note
Don’t add the file extension .rst
to the index list.
At this point, we have
- Installed Sphinx.
- created a Sphinx project.
- created .rst files for our project.
- added .rst filenames to the index.rst
Now that we have some content configured, let’s build some documentation!
Building your Sphinx project¶
With the base of our project configured, we can generate some html content to view what we’ve started. Head back to your terminal application for the next step.
sphinx-build [options] <source directory> <output directory> [filenames]
If no output directory is listed, the output defaults to the source.
sphinx-build /path/to/my/sphinx/project/ html
will result in the following output.
Head back to the finder and locate your source directory and locate the new HTML directory.
Double click on the index.html file, and a web browser will display your project.
shpinx-build man page and additional options
Doesn’t that look purdy? I’m not a designer, and with minimal effort I have a resource that looks nice! Yes, yes that does look nice, why doesn’t my project look like that?
Sphinx Themes¶
A theme is a collection of HTML templates, stylesheets and other files. A theme keeps the HTML appearance consistant throughout the project making it look good.
In our example project, we are using sphinx_rtd_theme
.
Setting up a Theme¶
Open your text editor and navigate back to the source directory. Locate the conf.py
and open it for modification.
Sphinx has some built in themes you can use setting the html_theme
config value in your conf.py
.
Search
conf.py
forhtml_theme
, enter the valuesphinx_rtd_theme
and save the script.Open terminal and install the theme
pip install sphinx_rtd_theme
Save all your work.
Re-build your project, and refresh your browser and now you should see the blue and black theme.


Make a file called "hi.html" containing this Use your a Web browser to open the file "hi.html," and it will look something like this
Welcome to the Quarter Backs Meetup Website


CrossFit Falls Church provides a free workout for non-members that are interested in joining our community. There is no need to sign up in advance!
In order to sign up for a membership, you must have first completed one of our Elements programs or a skills test-in.
My name is Alex Ticovschi careerd large proportion of my over the past 2 years t. To achieve this goal to studying HTML, CSS, JavaScript and PHP. See my portfolio website web based apps I've created.


Hi, I'm Dylan.
I'm currently building
GrowthHackers.com
. I previously co-founded
Wellen Surf
.
Follow along:


--- layout: post title: I'm Running the Abingdon Marathon date: 2013-02-17 11:05:38.000000000 +00:00 tags: - race - marathon - shorts - entry - Abingdon Marathon - 42.2km type: post published: true ---
Woohoo!!! My postal entry into the Abingdon Marathon on 20 Oct 2013 has been accepted. I am now running one of the fastest marathons in the UK. I'm very chuffed as this is a very popular marathon and the online entry has already closed. I can now do all four of the races for the Berkshire Champs. I don't expect to win the Berkshire Champs, but running all four races will certainly see me fair quite well.


Cards and rows with content
This is an example of a row.
Some title text
Some secondary text
Some text that takes up most of the row's space
Button 1
Button 2
A row...
...that continues into another row.
Cards with <cr-link-row> instances
A link row that uses slotted content
And slotted sublabel
Other examples
A row that expands...
...into more rows!
...into more rows!
...into more rows!


---
layout: post
title: 3/6
date: '2013-03-06T22:58:00.001-07:00'
author: Jacob .
tags:
modified_time: '2013-03-08T00:28:45.880-07:00'
blogger_id: tag:blogger.com,1999:blog-6400085873105072120.post-4694839227672855111
blogger_orig_url: http://www.svlark.com/2013/03/35.html
---
Man I'm struggling to stay on the wagon. Must ... blog ....
I've got my neighbor Nick the plumber coming tomorrow evening to take a look at these crazy shower fixtures we're trying to remove. No screws, no holes, no nothing.
I'm also going to try to talk him into renting his truck a few weeks from now do I can haul away demo refuse from all these projects.
Len's got a bunch of new stuff varnished up beautifully and ready to install: window sill for the kitchen; mud room bench seat and shelves; bi-fold door for upstairs bathroom; assorted other pieces.
235.4


Redback Configuration
Configuration in Redback is governed by a plexus configuration setup making use of properties files. Below is a listing of all of the available configuration options along with default values and notes on what they are where applicable.
Configuration File Locations
Configuration file location can depend on the application that is embedding Redback. Since Redback is currently built up off of Plexus, it would be ideal to check out the application.xml of the relevant application and look for an entry similar to the following.
<bean name="userConfiguration" class="org.apache.archiva.redback.configuration.DefaultUserConfiguration"
init-method="initialize">
<property name="configs">
<list>
<value>src/test/resources/security.properties</value>
</list>
</property>
<property name="registry" ref="registry#commons-configuration"/>
</bean>
Configuration Options
Application Configuration
- application.timestamp=EEE d MMM yyyy HH:mm:ss Z
- application.url=http://myurl.mycompany.com
- Set the application base URL. The default is to derive it from the HTTP request
JDBC Setup
By default Redback uses Apache Derby for persistence of user and role information. This can be configured with the following options.
- jdbc.driver.name=org.apache.derby.jdbc.EmbeddedDriver
- jdbc.url=jdbc:derby:$plexus.home/database;create=true
- jdbc.username=sa
- jdbc.password=
By default Redback uses Apache Derby for persistence of user and role information. This can be configured with the following options.
Note: If you are using MySQL as your database, the database will not be populated if the encoding is initially set to UTF-8. As a workaround, set the database to UTF-8 encoding after it has been populated. See REDBACK-267 for more details.
Email Settings
- email.jndiSessionName=java:comp/env/mail/Session
- email.smtp.host=localhost
- email.smtp.port=25
- email.smtp.ssl.enabled=false
- email.smtp.tls.enabled=false
- email.smtp.username=
- email.smtp.password=
- email.from.address=$user.name@localhost
- All emails sent by the system will be from the following address
- email.from.name=Unconfigured Username
- email.validation.required=true
- If all email addresses (from new user registration) require an account validation email.
- email.validation.timeout=2880
- Timeout (in minutes) for the key generated for an email validation to remain valid.
- 2880 minutes = 48 hours
- email.validation.subject=Welcome
- email.feedback.path=/feedback.action
- Get the Feedback to use for any outgoing emails.
- Feedback path starts with a "/" it is appended to the end of the value provided in application.url. This value can be in the format/syntax of "/feedback.action" or even<EMAIL_ADDRESS>Auto Login Settings
- security.rememberme.enabled=true
- security.rememberme.timeout=365
- security.signon.timeout=30
- Single Sign On
- Timeout is in minutes
Default Username Values
- redback.default.admin=admin
- name for the admin user, by default this is 'admin' and can not easily be changed after the fact at this point. However any number of people may be assigned full administrator roles.
- redback.default.guest=guest (currently guest is an hardcoded value so not possible to configure it)
Security Policies
- security.policy.password.encoder=
- security.policy.password.previous.count=6
- security.policy.password.expiration.enabled=true
- security.policy.password.expiration.days=90
- security.policy.password.expiration.notify.days=10
- security.policy.allowed.login.attempt=10
- security.policy.strict.enforcement.enabled=true
- turn off the perclick enforcement of various security policies, slightly more heavyweight since it will ensure that the User object on each click is up to date
- security.policy.strict.force.password.change.enabled=true
- forces the user to change their password immediately should their account be flagged for a password change.
- security.policy.unlockable.accounts
- can be specified multiple times to ensure that password policies never lock the specified account(s) (eg. security.policy.unlockable.accounts=guest )
Password Rules
- security.policy.password.rule.alphanumeric.enabled=false
- security.policy.password.rule.alphacount.enabled=true
- security.policy.password.rule.alphacount.minimum=1
- security.policy.password.rule.characterlength.enabled=true
- security.policy.password.rule.characterlength.minimum=1
- security.policy.password.rule.characterlength.maximum=24
- security.policy.password.rule.musthave.enabled=true
- security.policy.password.rule.numericalcount.enabled=true
- security.policy.password.rule.numericalcount.minimum=1
- security.policy.password.rule.reuse.enabled=true
- security.policy.password.rule.nowhitespace.enabled=true
LDAP settings
Ldap can be used as a readonly user manager, however the role assignment is still managed entirely within the given database store. This should be fixed in the future sometime but likely not before ldap is switched over as the default user and role store entirely.
- ldap.user.store.enabled=false
- ldap.bind.authenticator.enabled=false
ldap options for configuration via properties file
- ldap.config.hostname=
- ldap.config.port=
- ldap.config.base.dn=
- ldap.config.context.factory=
- ldap.config.bind.dn=
- ldap.config.password=
- ldap.config.authentication.method=
- ldap.config.groups.class= object class for groups (default: groupOfUniqueNames)
- ldap.config.groups.base.dn= basedn for groups, dn with list of groups ( dc=archiva,dc=apache,dc=org ) (if empty default will be ldap.config.base.dn)
- ldap.config.groups.role.*(ldap group)=*(roles) (mapping ldap group - redback roles comma separated) (example: ldap.config.groups.role.archiva-admin=Archiva System Administrator, Foo)
- ldap.config.writable=true/false will write datas to ldap (default false)
- ldap.config.groups.use.rolename=true/false will create/use groups in ldap with default role if no group-role mapping found (default false)
- ldap.config.user.attribute= attribute name to use for user (default uid=)
User Manager Implementation(s) to use
- user.manager.impl=cached (since 1.4-M4: Archiva support more than one value comma separated)
- valid values for realistic usage are 'cached' and then further configuring the cached instance to use another underlying user manager like ldap or the jdo one which is used by default. Placing 'ldap' here will check with the ldap system for a fair amount of checks and would likely be a performance issue
RBAC Manager Implementation(s) to use
- rbac.manager.impl=cached (since 1.4-M4: Archiva support more than one value comma separated)
REST security settings
Cross Site Request Forgery (CSRF) Prevention
There are multiple checks implemented to prevent CSRF attacks from other sides that are opened in the same browser. If you use the REST services from non-Browser clients or very old Browser versions you may need to deactivate some of these checks. If you deactivate these checks your archiva site will be more vulnerable to these attacks.
- rest.csrffilter.enabled=true
- Enable/disable the filter for CSRF prevention. Possible values: true, false
- rest.baseUrl=
- Set the base URL to which the Origin/Referer header are matched against. If it's empty, the URL is determined dynamically.
- rest.csrffilter.absentorigin.deny=true
- Defines what happens, if the client request does not contain a Origin or Referer header. This may happen with native REST clients. Browsers normally add these headers to the request, if it is initiated from another site. Possible values: true, false
- rest.csrffilter.disableTokenValidation=false
- Token validation means, that each REST request must send a validation token that is returned during the first login. If you have REST clients that cannot send this token you may have to disable this feature. Possible values: true, false