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

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
    • raven.middleware
  • 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.

galaxy.web.framework.base.server_starttime = 1616045412

time of the most recent server startup

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_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.

add_api_controller(controller_name, controller)

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_client_route(route, controller='root')

set_transaction_factory(transaction_factory)

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

finalize_config()

Call when application is completely configured and ready to serve requests

trace(**fields)

handle_request(environ, start_response, body_renderer=None)

make_body_iterable(trans, body)

handle_controller_exception(e, trans, **kwargs)

Allow handling of exceptions raised in controller methods.

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.LazyProperty(func)

Bases: object

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

__init__(func)

galaxy.web.framework.base.lazy_property

alias of galaxy.web.framework.base.LazyProperty

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.Request(environ)

Bases: webob.request.Request

Encapsulates an HTTP request.

__init__(environ)

Create a new request wrapping the WSGI environment environ

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.

cookies

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

base

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.

browser_url

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)

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)

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

set_content_type(type_)

Sets the Content-Type header

get_content_type()

send_redirect(url)

Send an HTTP redirect response to (target url)

wsgi_headeritems()

Return headers in format appropriate for WSGI start_response

wsgi_status()

Return status line in format appropriate for WSGI start_response

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

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

Progressively return chunks from file.

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

Flatten a possible nested set of iterables

galaxy.web.framework.decorators module

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.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.require_login(verb='perform this action', use_panels=False, webapp='galaxy')

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

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_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.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.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.webapp module

class galaxy.web.framework.webapp.WebApplication(galaxy_app, session_cookie='galaxysession', name=None)

Bases: galaxy.web.framework.base.WebApplication

Base WSGI application instantiated for all Galaxy webapps.

A web application that:

• adds API and UI controllers by scanning given directories and

importing all modules found there. * has a security object. * builds mako template lookups. * generates GalaxyWebTransactions.

__init__(galaxy_app, session_cookie='galaxysession', name=None)

create_mako_template_lookup(galaxy_app, name)

handle_controller_exception(e, trans, **kwargs)

make_body_iterable(trans, body)

transaction_chooser(environ, galaxy_app, session_cookie)

add_ui_controllers(package_name, app)

Search for UI controllers in package_name and add them to the webapp.

add_api_controllers(package_name, app)

Search for UI controllers in package_name and add them to the webapp.

class galaxy.web.framework.webapp.GalaxyWebTransaction(environ, app, webapp, session_cookie=None)

Bases: galaxy.web.framework.base.DefaultWebTransaction, galaxy.managers.context.ProvidesAppContext, galaxy.managers.context.ProvidesUserContext, galaxy.managers.context.ProvidesHistoryContext

Encapsulates web transaction specific state for the Galaxy application (specifically the user’s “cookie” session and history)

__init__(environ, app, webapp, session_cookie=None)

setup_i18n()

set_cors_origin(origin=None)

set_cors_headers()

Allow CORS requests if configured to do so by echoing back the request’s ‘Origin’ header (if any) as the response header ‘Access-Control-Allow-Origin’

get_user()

Return the current user if logged in or None.

set_user(user)

Set the current user.

user

Return the current user if logged in or None.

get_cookie(name='galaxysession')

Convenience method for getting a session cookie

set_cookie(value, name='galaxysession', path='/', age=90, version='1')

Convenience method for setting a session cookie

get_or_create_remote_user(remote_user_email)

Create a remote user with the email remote_user_email and return it

cookie_path

check_user_library_import_dir(user)

user_checks(user)

This could contain more checks around a user upon login

handle_user_login(user)

Login a new user (possibly newly created)

• do some ‘system’ checks (if any) for this user
• create a new session
• associate new session with user
• if old session had a history and it was not associated with a user, associate it with the new session, otherwise associate the current session’s history with the user
• add the disk usage of the current session to the user’s total disk usage

handle_user_logout(logout_all=False)

Logout the current user:

• invalidate the current session
• create a new session with no user associated

get_galaxy_session()

Return the current galaxy session

get_history(create=False, most_recent=False)

Load the current history.

• If that isn’t available, we find the most recently updated history.
• If that isn’t available, we get or create the default history.

Transactions will not always have an active history (API requests), so None is a valid response.

set_history(history)

history

Load the current history.

• If that isn’t available, we find the most recently updated history.
• If that isn’t available, we get or create the default history.

Transactions will not always have an active history (API requests), so None is a valid response.

get_or_create_default_history()

Gets or creates a default history and associates it with the current session.

get_most_recent_history()

Gets the most recently updated history.

new_history(name=None)

Create a new history and associate it with the current session and its associated user (if set).

template_context

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

set_message(message, type=None)

Convenience method for setting the ‘message’ and ‘message_type’ element of the template context.

get_message()

Convenience method for getting the ‘message’ element of the template context.

show_message(message, type='info', refresh_frames=[], cont=None, use_panels=False, active_view='')

Convenience method for displaying a simple page with a single message.

type: one of “error”, “warning”, “info”, or “done”; determines the

type of dialog box and icon displayed with the message

refresh_frames: names of frames in the interface that should be

refreshed when the message is displayed

show_error_message(message, refresh_frames=[], use_panels=False, active_view='')

Convenience method for displaying an error message. See show_message.

show_ok_message(message, refresh_frames=[], use_panels=False, active_view='')

Convenience method for displaying an ok message. See show_message.

show_warn_message(message, refresh_frames=[], use_panels=False, active_view='')

Convenience method for displaying an warn message. See show_message.

session_csrf_token

check_csrf_token(payload)

fill_template(filename, **kwargs)

Fill in a template, putting any keyword arguments on the context.

fill_template_mako(filename, template_lookup=None, **kwargs)

stream_template_mako(filename, **kwargs)

fill_template_string(template_string, context=None, **kwargs)

Fill in a template, putting any keyword arguments on the context.

galaxy.web.framework.webapp.default_url_path(path)

galaxy.web.framework.webapp.build_native_uwsgi_app(paste_factory, config_section)

uwsgi can load paste factories with –ini-paste, but this builds non-paste uwsgi apps.

In particular these are useful with –yaml or –json for config.

galaxy.web.framework.webapp.build_url_map(app, global_conf, local_conf)