From 153c2b9bce3170d58cafa48d819aef4497159091 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 15 Jul 2011 09:31:34 -0400 Subject: add description of return value --- pyramid/paster.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/pyramid/paster.py b/pyramid/paster.py index 578b854a5..8211dc637 100644 --- a/pyramid/paster.py +++ b/pyramid/paster.py @@ -42,6 +42,12 @@ def bootstrap(config_uri, request=None): currently serving ``request``, leaving a natural environment in place to write scripts that can generate URLs and utilize renderers. + This function returns a dictionary with ``app``, ``root`` and ``closer`` + keys. ``app`` is the WSGI app loaded (based on the ``config_uri``), + ``root`` is the traversal root resource of the Pyramid application, and + ``closer`` is a parameterless callback that may be called when your + script is complete (it pops a threadlocal stack). + .. note:: Most operations within :app:`Pyramid` expect to be invoked within the context of a WSGI request, thus it's important when loading your application to anchor it when executing scripts -- cgit v1.2.3