Return the WSGI application named
namein the PasteDeploy config file specified by
nameis None, this will attempt to parse the name from the
config_uristring expecting the format
inifile#name. If no name is found, the name will default to “main”.
Load a WSGI application from the PasteDeploy config file specified by
config_uri. The environment will be configured as if it is 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
appis the WSGI app loaded (based on the
rootis the traversal root resource of the Pyramid application, and
closeris a parameterless callback that may be called when your script is complete (it pops a threadlocal stack).
Most operations within 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 and other code that is not normally invoked during active WSGI requests.
For a complex config file containing multiple Pyramid applications, this function will setup the environment under the context of the last-loaded Pyramid application. You may load a specific application yourself by using the lower-level functions
pyramid.scripting.prepare()in conjunction with
config_uri– specifies the PasteDeploy config file to use for the interactive shell. The format is
inifile#name. If the name is left off,
mainwill be assumed.
request– specified to anchor the script to a given set of WSGI parameters. For example, most people would want to specify the host, scheme and port such that their script will generate URLs in relation to those parameters. A request with default parameters is constructed for you if none is provided. You can mutate the request’s
environlater to setup a specific host/port/scheme/etc.
See Writing a Script for more information about how to use this function.