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.web.framework package

Galaxy web application framework

galaxy.web.framework.handle_url_for(*args, **kwargs) → str

Tries to resolve the URL using the routes module.

This only works in a WSGI app so a deprecation message is returned when running an ASGI app.

galaxy.web.framework.legacy_url_for(mapper, *args, **kwargs) → str

Re-establishes the mapper for legacy WSGI routes.

galaxy.web.framework.url_for(*args, **kwargs) → str

Tries to resolve the URL using the routes module.

This only works in a WSGI app so a deprecation message is returned when running an ASGI app.

Subpackages

• galaxy.web.framework.helpers package
  • Submodules
  • galaxy.web.framework.helpers.grids module
  • galaxy.web.framework.helpers.tags module
• galaxy.web.framework.middleware package
  • Submodules
  • galaxy.web.framework.middleware.batch module
  • galaxy.web.framework.middleware.error module
  • galaxy.web.framework.middleware.profile module
  • galaxy.web.framework.middleware.remoteuser module
  • galaxy.web.framework.middleware.request_id module
  • galaxy.web.framework.middleware.sentry module
  • galaxy.web.framework.middleware.sqldebug module
  • galaxy.web.framework.middleware.static module
  • galaxy.web.framework.middleware.statsd module
  • galaxy.web.framework.middleware.translogger module
  • galaxy.web.framework.middleware.xforwardedhost module

Submodules

galaxy.web.framework.base module

A simple WSGI application/framework.

class galaxy.web.framework.base.DefaultWebTransaction(environ)

Bases: object

Wraps the state of a single web transaction (request/response cycle).

TODO: Provide hooks to allow application specific state to be included

in here.

__init__(environ)

session

Property that replaces itself with a calculated value the first time it is used.

class galaxy.web.framework.base.LazyProperty(func)

Bases: object

Property that replaces itself with a calculated value the first time it is used.

__init__(func)

class galaxy.web.framework.base.Request(environ)

Bases: webob.request.Request

Encapsulates an HTTP request.

__init__(environ)

Create a new request wrapping the WSGI environment environ

base

Property that replaces itself with a calculated value the first time it is used.

browser_url

Property that replaces itself with a calculated value the first time it is used.

cookies

Property that replaces itself with a calculated value the first time it is used.

path

Property that replaces itself with a calculated value the first time it is used.

protocol

Descriptor that delegates a property to a key in the environ member of the associated object (provides property style access to keys in the WSGI environment)

remote_host

Property that replaces itself with a calculated value the first time it is used.

remote_hostname

Property that replaces itself with a calculated value the first time it is used.

remote_port

Descriptor that delegates a property to a key in the environ member of the associated object (provides property style access to keys in the WSGI environment)

class galaxy.web.framework.base.Response

Bases: object

Describes an HTTP response. Currently very simple since the actual body of the request is handled separately.

__init__()

Create a new Response defaulting to HTML content and “200 OK” status

get_content_type()

send_redirect(url)

Send an HTTP redirect response to (target url)

set_content_type(type_)

Sets the Content-Type header

wsgi_headeritems()

Return headers in format appropriate for WSGI start_response

wsgi_status()

Return status line in format appropriate for WSGI start_response

class galaxy.web.framework.base.WSGIEnvironmentProperty(key, default='')

Bases: object

Descriptor that delegates a property to a key in the environ member of the associated object (provides property style access to keys in the WSGI environment)

__init__(key, default='')

class galaxy.web.framework.base.WebApplication

Bases: object

A simple web application which maps requests to objects using routes, and to methods on those objects in the CherryPy style. Thus simple argument mapping in the CherryPy style occurs automatically, but more complicated encoding of arguments in the PATH_INFO can be performed with routes.

__init__()

Create a new web application object. To actually connect some controllers use add_controller and add_route. Call finalize_config when all controllers and routes have been added and __call__ to handle a request (WSGI style).

add_api_controller(controller_name, controller)

add_client_route(route, controller='root')

add_route(route, **kwargs)

Add a route to match a URL with a method. Accepts all keyword arguments of routes.Mapper.connect. Every route should result in at least a controller value which corresponds to one of the objects added with add_controller. It optionally may yield an action argument which will be used to locate the method to call on the controller. Additional arguments will be passed to the method as keyword args.

add_ui_controller(controller_name, controller)

Add a controller class to this application. A controller class has methods which handle web requests. To connect a URL to a controller’s method use add_route.

finalize_config()

Call when application is completely configured and ready to serve requests

handle_controller_exception(e, trans, **kwargs)

Allow handling of exceptions raised in controller methods.

handle_request(environ, start_response, body_renderer=None)

make_body_iterable(trans, body)

set_transaction_factory(transaction_factory)

Use the callable transaction_factory to create the transaction which will be passed to requests.

trace(**fields)

galaxy.web.framework.base.flatten(seq)

Flatten a possible nested set of iterables

galaxy.web.framework.base.iterate_file(fh)

Progressively return chunks from file.

galaxy.web.framework.base.lazy_property

alias of galaxy.web.framework.base.LazyProperty

galaxy.web.framework.base.send_file(start_response, trans, body)

galaxy.web.framework.base.walk_controller_modules(package_name)

galaxy.web.framework.decorators module

galaxy.web.framework.decorators.api_error_message(trans, **kwds)

galaxy.web.framework.decorators.do_not_cache(func)

Sets cache-prevention headers for the request.

galaxy.web.framework.decorators.error(message)

galaxy.web.framework.decorators.expose(func)

Decorator: mark a function as ‘exposed’ and thus web accessible

galaxy.web.framework.decorators.expose_api(func, to_json=True, user_required=True, user_or_session_required=True, handle_jsonp=True)

Expose this function via the API.

galaxy.web.framework.decorators.expose_api_anonymous(func, to_json=True)

Expose this function via the API but don’t require a set user.

galaxy.web.framework.decorators.expose_api_anonymous_and_sessionless(func, to_json=True)

Expose this function via the API but don’t require a user or a galaxy_session.

galaxy.web.framework.decorators.expose_api_raw(func)

galaxy.web.framework.decorators.expose_api_raw_anonymous(func)

galaxy.web.framework.decorators.expose_api_raw_anonymous_and_sessionless(func)

galaxy.web.framework.decorators.format_return_as_json(rval, jsonp_callback=None, pretty=False)

Formats a return value as JSON or JSONP if jsonp_callback is present.

Use pretty=True to return pretty printed json.

galaxy.web.framework.decorators.json(func, pretty=False)

Format the response as JSON and set the response content type to JSON_CONTENT_TYPE.

galaxy.web.framework.decorators.json_pretty(func)

Indent and sort returned JSON.

galaxy.web.framework.decorators.legacy_expose_api(func, to_json=True, user_required=True)

Expose this function via the API.

galaxy.web.framework.decorators.legacy_expose_api_anonymous(func, to_json=True)

Expose this function via the API but don’t require a set user.

galaxy.web.framework.decorators.legacy_expose_api_raw(func)

Expose this function via the API but don’t dump the results to JSON.

galaxy.web.framework.decorators.legacy_expose_api_raw_anonymous(func)

Expose this function via the API but don’t dump the results to JSON.

galaxy.web.framework.decorators.require_admin(func)

galaxy.web.framework.decorators.require_admin_message(config, user)

galaxy.web.framework.decorators.require_login(verb='perform this action', use_panels=False)

galaxy.web.framework.decorators.validation_error_to_message_exception(e)