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

Clarified the docstring in method Flask.preprocess_request.

Browse source 
The doc now clearly states that the method invokes two set of hook
functions, and how these are filtered before execution.
This commit is contained in:
Aviv Cohn 2016-01-05 01:10:35 +02:00
parent 23cf923c7c
commit 826d7475cd
1 changed files with 10 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

18
flask/app.py
View file

@ -1791,16 +1791,18 @@ class Flask(_PackageBoundObject):
raise error
def preprocess_request(self):
"""Called before the actual request dispatching and will
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.
"""Called before the request dispatching.
This also triggers the :meth:`url_value_processor` functions before
the actual :meth:`before_request` functions are called.
Triggers two set of hook functions that should be invoked prior to request dispatching:
:attr:`url_value_preprocessors` and :attr:`before_request_funcs`
(the latter are functions decorated with :meth:`before_request` decorator).
In both cases, the method triggers only the functions that are either global
or registered to the current blueprint.
If any function in :attr:`before_request_funcs` returns a value, it's handled as if it was
the return value from the view function, and further request handling is stopped.
"""
bp = _request_ctx_stack.top.request.blueprint
funcs = self.url_value_preprocessors.get(None, ())