orbit-oss/flask
4
4
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #1338 from cvrebert/middleware-docs

Browse source 
Improve docs of signatures of before/after/teardown callback funcs
This commit is contained in:
Markus Unterwaditzer 2015-02-05 22:11:07 +01:00
commit 6e6a3e8cfb
1 changed files with 17 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

20
flask/app.py
View file

@ -1243,7 +1243,13 @@ class Flask(_PackageBoundObject):
@setupmethod
def before_request(self, f):
"""Registers a function to run before each request."""
"""Registers a function to run before each request.
The function will be called without any arguments.
If the function returns a non-None value, it's handled as
if it was the return value from the view and further
request handling is stopped.
"""
self.before_request_funcs.setdefault(None, []).append(f)
return f
@ -1252,6 +1258,9 @@ class Flask(_PackageBoundObject):
"""Registers a function to be run before the first request to this
instance of the application.
The function will be called without any arguments and its return
value is ignored.
.. versionadded:: 0.8
"""
self.before_first_request_funcs.append(f)
@ -1298,6 +1307,8 @@ class Flask(_PackageBoundObject):
When a teardown function was called because of a exception it will
be passed an error object.
The return values of teardown functions are ignored.
.. admonition:: Debug Note
In debug mode Flask will not tear down a request on an exception
@ -1332,6 +1343,8 @@ class Flask(_PackageBoundObject):
When a teardown function was called because of an exception it will
be passed an error object.
The return values of teardown functions are ignored.
.. versionadded:: 0.9
"""
self.teardown_appcontext_funcs.append(f)
@ -1710,8 +1723,9 @@ class Flask(_PackageBoundObject):
def preprocess_request(self):
"""Called before the actual request dispatching and will
call every as :meth:`before_request` decorated function.
If any of these function returns a value it's handled as
call each :meth:`before_request` decorated function, passing no
arguments.
If any of these functions returns a value, it's handled as
if it was the return value from the view and further
request handling is stopped.