Warning

This document is for an old release 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 package

The Galaxy web application framework

galaxy.web.do_not_cache(func)

Sets cache-prevention headers for the request.

galaxy.web.error(message)

galaxy.web.expose(func)

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

galaxy.web.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.expose_api_anonymous(func, to_json=True)

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

galaxy.web.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.expose_api_raw(func)

galaxy.web.expose_api_raw_anonymous(func)

galaxy.web.expose_api_raw_anonymous_and_sessionless(func)

galaxy.web.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.json(func, pretty=False)

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

galaxy.web.json_pretty(func)

Indent and sort returned JSON.

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

Expose this function via the API.

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

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

galaxy.web.legacy_expose_api_raw(func)

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

galaxy.web.legacy_expose_api_raw_anonymous(func)

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

galaxy.web.require_admin(func)

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

galaxy.web.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 package
  • handle_url_for()
  • url_for()
  • Subpackages
    • galaxy.web.framework.helpers package
      • time_ago()
      • iff()
      • truncate()
      • css()
      • dist_css()
      • js_helper()
      • dist_js()
      • to_unicode()
      • is_true()
      • to_js_bool()
      • js_nullable()
      • Submodules
      • galaxy.web.framework.helpers.grids module
      • galaxy.web.framework.helpers.tags module
    • galaxy.web.framework.middleware package
      • Submodules
      • 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.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
    • DefaultWebTransaction
      • DefaultWebTransaction.__init__()
      • DefaultWebTransaction.session
    • lazy_property
    • server_starttime
    • walk_controller_modules()
    • WebApplication
      • WebApplication.__init__()
      • WebApplication.add_ui_controller()
      • WebApplication.add_api_controller()
      • WebApplication.add_route()
      • WebApplication.add_client_route()
      • WebApplication.set_transaction_factory()
      • WebApplication.finalize_config()
      • WebApplication.trace()
      • WebApplication.handle_request()
      • WebApplication.make_body_iterable()
      • WebApplication.handle_controller_exception()
  • galaxy.web.framework.decorators module
    • error()
    • expose()
    • json()
    • json_pretty()
    • require_login()
    • require_admin()
    • require_admin_message()
    • do_not_cache()
    • legacy_expose_api()
    • legacy_expose_api_raw()
    • legacy_expose_api_raw_anonymous()
    • legacy_expose_api_anonymous()
    • expose_api()
    • format_return_as_json()
    • validation_error_to_message_exception()
    • api_error_message()
    • expose_api_anonymous()
    • expose_api_anonymous_and_sessionless()
    • expose_api_raw()
    • expose_api_raw_anonymous()
    • expose_api_raw_anonymous_and_sessionless()
• galaxy.web.legacy_framework package
  • Submodules
  • galaxy.web.legacy_framework.grids module
    • GridColumn
      • GridColumn.__init__()
      • GridColumn.get_value()
      • GridColumn.get_link()
      • GridColumn.filter()
      • GridColumn.get_accepted_filters()
      • GridColumn.sort()
    • ReverseSortColumn
      • ReverseSortColumn.sort()
    • TextColumn
      • TextColumn.filter()
      • TextColumn.get_filter()
      • TextColumn.get_single_filter()
      • TextColumn.sort()
    • DateTimeColumn
      • DateTimeColumn.sort()
    • BooleanColumn
      • BooleanColumn.sort()
      • BooleanColumn.get_single_filter()
    • IntegerColumn
      • IntegerColumn.get_single_filter()
      • IntegerColumn.sort()
    • CommunityRatingColumn
      • CommunityRatingColumn.get_value()
      • CommunityRatingColumn.sort()
    • OwnerAnnotationColumn
      • OwnerAnnotationColumn.__init__()
      • OwnerAnnotationColumn.get_value()
      • OwnerAnnotationColumn.get_single_filter()
    • CommunityTagsColumn
      • CommunityTagsColumn.__init__()
      • CommunityTagsColumn.get_value()
      • CommunityTagsColumn.filter()
      • CommunityTagsColumn.get_filter()
    • IndividualTagsColumn
      • IndividualTagsColumn.get_value()
      • IndividualTagsColumn.get_filter()
    • MulticolFilterColumn
      • MulticolFilterColumn.__init__()
      • MulticolFilterColumn.filter()
    • OwnerColumn
      • OwnerColumn.get_value()
      • OwnerColumn.sort()
    • PublicURLColumn
      • PublicURLColumn.get_link()
    • DeletedColumn
      • DeletedColumn.get_accepted_filters()
      • DeletedColumn.filter()
    • StateColumn
      • StateColumn.get_value()
      • StateColumn.filter()
      • StateColumn.get_accepted_filters()
    • SharingStatusColumn
      • SharingStatusColumn.get_value()
      • SharingStatusColumn.get_link()
      • SharingStatusColumn.filter()
      • SharingStatusColumn.get_accepted_filters()
    • GridOperation
      • GridOperation.__init__()
      • GridOperation.get_url_args()
      • GridOperation.allowed()
    • DisplayByUsernameAndSlugGridOperation
      • DisplayByUsernameAndSlugGridOperation.get_url_args()
    • GridAction
      • GridAction.__init__()
    • GridColumnFilter
      • GridColumnFilter.__init__()
      • GridColumnFilter.get_url_args()
    • Grid
      • Grid.title
      • Grid.model_class
      • Grid.show_item_checkboxes
      • Grid.template
      • Grid.async_template
      • Grid.use_async
      • Grid.use_hide_message
      • Grid.global_actions
      • Grid.columns
      • Grid.operations
      • Grid.standard_filters
      • Grid.default_filter
      • Grid.default_sort_key
      • Grid.use_paging
      • Grid.num_rows_per_page
      • Grid.num_page_links
      • Grid.allow_fetching_all_results
      • Grid.cur_filter_pref_name
      • Grid.cur_sort_key_pref_name
      • Grid.legend
      • Grid.info_text
      • Grid.__init__()
      • Grid.get_ids()
      • Grid.handle_operation()
      • Grid.get_current_item()
      • Grid.build_initial_query()
      • Grid.apply_query_filter()
• galaxy.web.proxy package
  • ProxyManager
    • ProxyManager.valid_update_keys
    • ProxyManager.__init__()
    • ProxyManager.shutdown()
    • ProxyManager.setup_proxy()
    • ProxyManager.update_proxy()
    • ProxyManager.query_proxy()
    • ProxyManager.proxy_launcher()
  • ProxyLauncher
    • ProxyLauncher.launch_proxy_command()
  • NodeProxyLauncher
    • NodeProxyLauncher.launch_proxy_command()
  • GolangProxyLauncher
    • GolangProxyLauncher.launch_proxy_command()
  • AuthenticationToken
    • AuthenticationToken.__init__()
  • ProxyRequests
    • ProxyRequests.__init__()
  • proxy_ipc()
  • ProxyIpc
    • ProxyIpc.handle_requests()
    • ProxyIpc.fetch_requests()
  • JsonFileProxyIpc
    • JsonFileProxyIpc.__init__()
    • JsonFileProxyIpc.handle_requests()
    • JsonFileProxyIpc.update_requests()
    • JsonFileProxyIpc.fetch_requests()
  • SqliteProxyIpc
    • SqliteProxyIpc.__init__()
    • SqliteProxyIpc.handle_requests()
    • SqliteProxyIpc.update_requests()
    • SqliteProxyIpc.fetch_requests()
  • RestGolangProxyIpc
    • RestGolangProxyIpc.__init__()
    • RestGolangProxyIpc.handle_requests()
  • ProxyMapping
    • ProxyMapping.container_ids
    • ProxyMapping.container_interface
    • ProxyMapping.host
    • ProxyMapping.port
• galaxy.web.short_term_storage package
  • now()
  • ShortTermStorageConfiguration
    • ShortTermStorageConfiguration.short_term_storage_directory
    • ShortTermStorageConfiguration.default_storage_duration
    • ShortTermStorageConfiguration.maximum_storage_duration
    • ShortTermStorageConfiguration.__init__()
  • ShortTermStorageTargetSecurity
    • ShortTermStorageTargetSecurity.user_id
    • ShortTermStorageTargetSecurity.session_id
    • ShortTermStorageTargetSecurity.to_dict()
    • ShortTermStorageTargetSecurity.from_dict()
    • ShortTermStorageTargetSecurity.__init__()
  • ShortTermStorageTarget
    • ShortTermStorageTarget.request_id
    • ShortTermStorageTarget.raw_path
    • ShortTermStorageTarget.duration
    • ShortTermStorageTarget.path
    • ShortTermStorageTarget.__init__()
  • ShortTermStorageServeCompletedInformation
    • ShortTermStorageServeCompletedInformation.target
    • ShortTermStorageServeCompletedInformation.mime_type
    • ShortTermStorageServeCompletedInformation.filename
    • ShortTermStorageServeCompletedInformation.security
    • ShortTermStorageServeCompletedInformation.__init__()
  • ShortTermStorageServeCancelledInformation
    • ShortTermStorageServeCancelledInformation.target
    • ShortTermStorageServeCancelledInformation.status_code
    • ShortTermStorageServeCancelledInformation.exception
    • ShortTermStorageServeCancelledInformation.message_exception
    • ShortTermStorageServeCancelledInformation.__init__()
  • ShortTermStorageAllocator
    • ShortTermStorageAllocator.new_target()
  • ShortTermStorageMonitor
    • ShortTermStorageMonitor.is_ready()
    • ShortTermStorageMonitor.get_serve_info()
    • ShortTermStorageMonitor.finalize()
    • ShortTermStorageMonitor.cancel()
    • ShortTermStorageMonitor.target_path()
    • ShortTermStorageMonitor.cleanup()
    • ShortTermStorageMonitor.recover_target()
  • ShortTermStorageManager
    • ShortTermStorageManager.__init__()
    • ShortTermStorageManager.new_target()
    • ShortTermStorageManager.recover_target()
    • ShortTermStorageManager.is_ready()
    • ShortTermStorageManager.get_serve_info()
    • ShortTermStorageManager.cancel()
    • ShortTermStorageManager.finalize()
    • ShortTermStorageManager.target_path()
    • ShortTermStorageManager.cleanup()
  • storage_context()

Submodules

galaxy.web.form_builder module

class galaxy.web.form_builder.AddressField(name, user=None, value=None, security=None, **kwds)

Bases: BaseField

static fields()

__init__(name, user=None, value=None, security=None, **kwds)

to_dict()

class galaxy.web.form_builder.BaseField(name, value=None, label=None, **kwds)

Bases: object

__init__(name, value=None, label=None, **kwds)

to_dict()

class galaxy.web.form_builder.CheckboxField(name, value=None, label=None, **kwds)

Bases: BaseField

A checkbox (boolean input)

static is_checked(value)

to_dict()

class galaxy.web.form_builder.HistoryField(name, user=None, value=None, security=None, **kwds)

Bases: BaseField

__init__(name, user=None, value=None, security=None, **kwds)

to_dict()

class galaxy.web.form_builder.PasswordField(name, value=None, label=None, **kwds)

Bases: BaseField

A password input box. text appears as “**”

to_dict()

class galaxy.web.form_builder.SelectField(name, multiple=None, display=None, field_id=None, value=None, selectlist=None, refresh_on_change=False, **kwds)

Bases: BaseField

A select field.

__init__(name, multiple=None, display=None, field_id=None, value=None, selectlist=None, refresh_on_change=False, **kwds)

add_option(label, value, selected=False)

to_dict()

class galaxy.web.form_builder.TextArea(name, value=None, label=None, **kwds)

Bases: BaseField

A standard text area box.

to_dict()

class galaxy.web.form_builder.TextField(name, value=None, label=None, **kwds)

Bases: BaseField

A standard text input box.

to_dict()

class galaxy.web.form_builder.WorkflowField(name, user=None, value=None, security=None, **kwds)

Bases: BaseField

__init__(name, user=None, value=None, security=None, **kwds)

to_dict()

class galaxy.web.form_builder.WorkflowMappingField(name, user=None, value=None, **kwds)

Bases: BaseField

__init__(name, user=None, value=None, **kwds)

galaxy.web.statsd_client module

galaxy.web.statsd_client.GalaxyStatsdClient

alias of VanillaGalaxyStatsdClient