Warning

This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

galaxy.webapps package

Galaxy webapps root package – this is a namespace package.

Subpackages

Submodules

galaxy.webapps.config_manage module

class galaxy.webapps.config_manage.App(config_paths, default_port, expected_app_factories, destination, schema_path, uwsgi_module)

Bases: tuple

app_name
config_paths

Alias for field number 0

default_port

Alias for field number 1

destination

Alias for field number 3

expected_app_factories

Alias for field number 2

sample_destination
schema
schema_path

Alias for field number 4

uwsgi_module

Alias for field number 5

class galaxy.webapps.config_manage.OptionValue(name, value, option)

Bases: tuple

name

Alias for field number 0

option

Alias for field number 2

value

Alias for field number 1

class galaxy.webapps.config_manage.Schema(mapping)[source]

Bases: object

__init__(mapping)[source]

x.__init__(…) initializes x; see help(type(x)) for signature

get_app_option(name)[source]
class galaxy.webapps.config_manage.AppSchema(app_desc)[source]

Bases: galaxy.webapps.config_manage.Schema

__init__(app_desc)[source]

x.__init__(…) initializes x; see help(type(x)) for signature

get_app_option(name)[source]
galaxy.webapps.config_manage.main(argv=None)[source]

Entry point for conversion process.

class galaxy.webapps.config_manage.PrefixFilter(name, prefix)[source]

Bases: object

__init__(name, prefix)[source]

x.__init__(…) initializes x; see help(type(x)) for signature

class galaxy.webapps.config_manage.GzipFilter(name)[source]

Bases: object

__init__(name)[source]

x.__init__(…) initializes x; see help(type(x)) for signature

galaxy.webapps.util module

exception galaxy.webapps.util.MiddlewareWrapUnsupported[source]

Bases: exceptions.Exception

galaxy.webapps.util.build_template_error_formatters()[source]

Build a list of template error formatters for WebError. When an error occurs, WebError pass the exception to each function in this list until one returns a value, which will be displayed on the error page.

galaxy.webapps.util.wrap_if_allowed_or_fail(app, stack, wrap, name=None, args=None, kwargs=None)[source]

Wrap the application with the given method if the application stack allows for it.

Arguments are the same as for wrap_if_allowed().

Raises :exception:`MiddlewareWrapUnsupported` if the stack does not allow the middleware.

galaxy.webapps.util.wrap_if_allowed(app, stack, wrap, name=None, args=None, kwargs=None)[source]

Wrap the application with the given method if the application stack allows for it.

Parameters:
  • app (galaxy.web.framework.webapp.WebApplication subclass) – application to wrap
  • stack (galaxy.web.stack.ApplicationStack subclass) – instance of application stack implementing allowed_middleware() method
  • wrap (types.FunctionType or types.LambdaType) – function to wrap application with
  • name (str) – alternative wrap function name for logging purposes (wrap.__name__ if None)
  • args (list) – arguments to pass to wrap (not including app itself)
  • kwargs (dict) – keyword arguments to pass to wrap

Returns app unmodified if the stack does not allow the middleware.