maya-chen/flask
1
0
Fork 0
forked from orbit-oss/flask
Code Pull requests Activity

Added notes on proxies

Browse source
This commit is contained in:
Armin Ronacher 2010-07-20 10:12:58 +01:00
parent c0abdc4fa5
commit 3b0eb0f3ca
2 changed files with 63 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

46
docs/signals.rst
View file

@ -41,13 +41,9 @@ the optional second argument specifies a sender. To unsubscribe from a
signal, you can use the :meth:`~blinker.base.Signal.disconnect` method.
For all core Flask signals, the sender is the application that issued the
signal. This however might not be true for Flask extensions, so consult
the documentation when subscribing to signals.
Additionally there is a convenient helper method that allows you to
temporarily subscribe a function to a signal. This is especially helpful
for unittests (:meth:`~blinker.base.Signal.temporarily_connected_to`).
This has to be used in combination with the `with` statement.
signal. When you subscribe to a signal, be sure to also provide a sender
unless you really want to listen for signals of all applications. This is
especially true if you are developing an extension.
Here for example a helper context manager that can be used to figure out
in a unittest which templates were rendered and what variables were passed
@ -57,19 +53,19 @@ to the template::
from contextlib import contextmanager
@contextmanager
def captured_templates():
def captured_templates(app):
recorded = []
def record(template, context):
recorded.append((template, context))
template_rendered.connect(record)
template_rendered.connect(record, app)
try:
yield recorded
finally:
template_rendered.disconnect(record)
template_rendered.disconnect(record, app)
This can now easily be paired with a test client::
with captured_templates() as templates:
with captured_templates(app) as templates:
rv = app.test_client().get('/')
assert rv.status_code == 200
assert len(templates) == 1
@ -77,9 +73,23 @@ This can now easily be paired with a test client::
assert template.name == 'index.html'
assert len(context['items']) == 10
All the template rendering in the code, the `with` block wraps will now be
recorded in the `templates` variable. Whenever a template is rendered,
the template object as well as context is appended to it.
All the template rendering in the code issued by the application `app`
in the body of the `with` block will now be recorded in the `templates`
variable. Whenever a template is rendered, the template object as well as
context are appended to it.
Additionally there is a convenient helper method
(:meth:`~blinker.base.Signal.temporarily_connected_to`). that allows you
to temporarily subscribe a function to a signal with is a context manager
on its own which simplifies the example above::
from flask import template_rendered
def captured_templates(app):
recorded = []
def record(template, context):
recorded.append((template, context))
return template_rendered.temporarily_connected_to(record, app)
Creating Signals
----------------
@ -153,7 +163,7 @@ The following signals exist in Flask:
context)
from flask import request_started
request_started.connect(log_template_renders)
request_started.connect(log_template_renders, app)
.. data:: flask.request_started
:noindex:
@ -169,7 +179,7 @@ The following signals exist in Flask:
sender.logger.debug('Request context is set up')
from flask import request_started
request_started.connect(log_request)
request_started.connect(log_request, app)
.. data:: flask.request_finished
:noindex:
@ -184,7 +194,7 @@ The following signals exist in Flask:
'Response: %s', response)
from flask import request_finished
request_finished.connect(log_response)
request_finished.connect(log_response, app)
.. data:: flask.got_request_exception
:noindex:
@ -200,6 +210,6 @@ The following signals exist in Flask:
sender.logger.debug('Got exception during processing: %s', exception)
from flask import got_request_exception
got_request_exception.connect(log_exception)
got_request_exception.connect(log_exception, app)
.. _blinker: http://pypi.python.org/pypi/blinker