The heat.common.wsgi Module

Utility methods for working with WSGI servers

class heat.common.wsgi.AppFactory(conf)

Bases: heat.common.wsgi.BasePasteFactory

A Generic paste.deploy app factory.

This requires heat.app_factory to be set to a callable which returns a WSGI app when invoked. The format of the name is <module>:<callable> e.g.

[app:apiv1app] paste.app_factory = heat.common.wsgi:app_factory heat.app_factory = heat.api.cfn.v1:API

The WSGI app constructor must accept a ConfigOpts object and a local config dict as its two arguments.

KEY = 'heat.app_factory'

class heat.common.wsgi.BasePasteFactory(conf)

Bases: object

A base class for paste app and filter factories.

Sub-classes must override the KEY class attribute and provide a __call__ method.

KEY = None

class heat.common.wsgi.Debug(application)

Bases: heat.common.wsgi.Middleware

Helper class that can be inserted into any WSGI application chain to get information about the request and response.

static print_generator(app_iter)

Iterator that prints the contents of a wrapper string iterator when iterated.

class heat.common.wsgi.FilterFactory(conf)

Bases: heat.common.wsgi.AppFactory

A Generic paste.deploy filter factory.

This requires heat.filter_factory to be set to a callable which returns a WSGI filter when invoked. The format is <module>:<callable> e.g.

[filter:cache] paste.filter_factory = heat.common.wsgi:filter_factory heat.filter_factory = heat.api.middleware.cache:CacheFilter

The WSGI filter constructor must accept a WSGI app, a ConfigOpts object and a local config dict as its three arguments.

KEY = 'heat.filter_factory'

class heat.common.wsgi.JSONRequestDeserializer

Bases: object

default(request)

from_json(datastring)

has_body(request)

Returns whether a Webob.Request object will possess an entity body.

Parameters:request – Webob.Request object

class heat.common.wsgi.JSONResponseSerializer

Bases: object

default(response, result)

to_json(data)

class heat.common.wsgi.Middleware(application)

Bases: object

Base WSGI middleware wrapper. These classes require an application to be initialized that will be called next. By default the middleware will simply call its wrapped app, or you can override __call__ to customize its behavior.

process_request(req)

Called on each request.

If this returns None, the next application down the stack will be executed. If it returns a response then that response will be returned and execution will stop here.

process_response(response)

Do whatever you’d like to the response.

class heat.common.wsgi.Request(environ, charset=None, unicode_errors=None, decode_param_names=None, **kw)

Bases: webob.request.Request

Add some Openstack API-specific logic to the base webob.Request.

best_match_content_type()

Determine the requested response content-type.

get_content_type(allowed_content_types)

Determine content type of the request body.

class heat.common.wsgi.Resource(controller, deserializer, serializer=None)

Bases: object

WSGI app that handles (de)serialization and controller dispatch.

Reads routing information supplied by RoutesMiddleware and calls the requested action method upon its deserializer, controller, and serializer. Those three objects may implement any of the basic controller action methods (create, update, show, index, delete) along with any that may be specified in the api router. A ‘default’ method may also be implemented to be used in place of any non-implemented actions. Deserializer methods must accept a request argument and return a dictionary. Controller methods must accept a request argument. Additionally, they must also accept keyword arguments that represent the keys returned by the Deserializer. They may raise a webob.exc exception or return a dict, which will be serialized by requested content type.

dispatch(obj, action, *args, **kwargs)

Find action-specific method on self and call it.

get_action_args(request_environment)

Parse dictionary created by routes library.

class heat.common.wsgi.Router(mapper)

Bases: object

WSGI middleware that maps incoming requests to WSGI apps.

class heat.common.wsgi.Server(threads=1000)

Bases: object

Server class to manage multiple WSGI sockets and applications.

run_child()

run_server()

Run a WSGI server.

start(application, conf, default_port)

Run a WSGI server with the given application.

Parameters:

• application – The application to run in the WSGI server
• conf – a cfg.ConfigOpts object
• default_port – Port to bind to if none is specified in conf

wait()

Wait until all servers have completed running.

wait_on_children()

class heat.common.wsgi.WritableLogger(logger, level=10)

Bases: object

A thin wrapper that responds to write and logs.

write(msg)

class heat.common.wsgi.XMLResponseSerializer

Bases: object

default(response, result)

object_to_element(obj, element)

to_xml(data)

heat.common.wsgi.debug_filter(app, conf, **local_conf)

heat.common.wsgi.eventlet_wsgi_server(sock, application, **kwargs)

Return a new instance of the eventlet wsgi server with the proper url limit in a way that’s compatible with eventlet 0.9.16 and 0.9.17.

heat.common.wsgi.get_bind_addr(conf, default_port=None)

Return the host and port to bind to.

heat.common.wsgi.get_socket(conf, default_port)

Bind socket to bind ip:port in conf

note: Mostly comes from Swift with a few small changes...

Parameters:

• conf – a cfg.ConfigOpts object
• default_port – port to bind to if none is specified in conf

:returns : a socket object as returned from socket.listen or

ssl.wrap_socket if conf specifies cert_file

heat.common.wsgi.paste_deploy_app(paste_config_file, app_name, conf)

Load a WSGI app from a PasteDeploy configuration.

Use deploy.loadapp() to load the app from the PasteDeploy configuration, ensuring that the supplied ConfigOpts object is passed to the app and filter constructors.

Parameters:

• paste_config_file – a PasteDeploy config file
• app_name – the name of the app/pipeline to load from the file
• conf – a ConfigOpts object to supply to the app and its filters

Returns:

the WSGI app

heat.common.wsgi.setup_paste_factories(conf)

Set up the generic paste app and filter factories.

Set things up so that:

paste.app_factory = heat.common.wsgi:app_factory

and

paste.filter_factory = heat.common.wsgi:filter_factory

work correctly while loading PasteDeploy configuration.

The app factories are constructed at runtime to allow us to pass a ConfigOpts object to the WSGI classes.

Parameters:conf – a ConfigOpts object

heat.common.wsgi.teardown_paste_factories()

Reverse the effect of setup_paste_factories().