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.webapps package¶
Galaxy webapps root package – this is a namespace package.
Subpackages¶
- galaxy.webapps.base package
- Submodules
- galaxy.webapps.base.api module
- galaxy.webapps.base.controller module
- galaxy.webapps.base.webapp module
WebApplication
WebApplication.injection_aware
WebApplication.__init__()
WebApplication.build_apispec()
WebApplication.create_mako_template_lookup()
WebApplication.handle_controller_exception()
WebApplication.make_body_iterable()
WebApplication.transaction_chooser()
WebApplication.add_ui_controllers()
WebApplication.add_api_controllers()
config_allows_origin()
url_builder()
GalaxyWebTransaction
GalaxyWebTransaction.__init__()
GalaxyWebTransaction.app
GalaxyWebTransaction.url_builder
GalaxyWebTransaction.set_cors_allow()
GalaxyWebTransaction.set_cors_origin()
GalaxyWebTransaction.set_cors_headers()
GalaxyWebTransaction.get_user()
GalaxyWebTransaction.set_user()
GalaxyWebTransaction.user
GalaxyWebTransaction.get_cookie()
GalaxyWebTransaction.set_cookie()
GalaxyWebTransaction.get_or_create_remote_user()
GalaxyWebTransaction.cookie_path
GalaxyWebTransaction.check_user_library_import_dir()
GalaxyWebTransaction.user_checks()
GalaxyWebTransaction.handle_user_login()
GalaxyWebTransaction.handle_user_logout()
GalaxyWebTransaction.get_galaxy_session()
GalaxyWebTransaction.get_history()
GalaxyWebTransaction.set_history()
GalaxyWebTransaction.history
GalaxyWebTransaction.get_or_create_default_history()
GalaxyWebTransaction.get_most_recent_history()
GalaxyWebTransaction.new_history()
GalaxyWebTransaction.template_context
GalaxyWebTransaction.set_message()
GalaxyWebTransaction.get_message()
GalaxyWebTransaction.show_message()
GalaxyWebTransaction.show_error_message()
GalaxyWebTransaction.show_ok_message()
GalaxyWebTransaction.show_warn_message()
GalaxyWebTransaction.session_csrf_token
GalaxyWebTransaction.check_csrf_token()
GalaxyWebTransaction.fill_template()
GalaxyWebTransaction.fill_template_mako()
GalaxyWebTransaction.qualified_url_for_path()
default_url_path()
build_url_map()
- galaxy.webapps.galaxy package
- Subpackages
- galaxy.webapps.galaxy.api package
get_app()
get_app_with_request_session()
GalaxyTypeDepends
depends()
get_session_manager()
get_session()
get_api_user()
get_user()
UrlBuilder
GalaxyASGIRequest
GalaxyASGIResponse
get_current_history_from_session()
get_trans()
get_admin_user()
BaseGalaxyAPIController
RestVerb
Router
APIContentTypeRoute
as_form()
try_get_request_body_as_json()
IndexQueryTag
search_query_param()
- Submodules
- galaxy.webapps.galaxy.api.annotations module
- galaxy.webapps.galaxy.api.authenticate module
- galaxy.webapps.galaxy.api.cloud module
- galaxy.webapps.galaxy.api.cloudauthz module
- galaxy.webapps.galaxy.api.common module
- galaxy.webapps.galaxy.api.configuration module
- galaxy.webapps.galaxy.api.container_resolution module
- galaxy.webapps.galaxy.api.dataset_collections module
- galaxy.webapps.galaxy.api.datasets module
- galaxy.webapps.galaxy.api.datatypes module
- galaxy.webapps.galaxy.api.display_applications module
- galaxy.webapps.galaxy.api.dynamic_tools module
- galaxy.webapps.galaxy.api.extended_metadata module
- galaxy.webapps.galaxy.api.folder_contents module
- galaxy.webapps.galaxy.api.folders module
- galaxy.webapps.galaxy.api.forms module
- galaxy.webapps.galaxy.api.genomes module
- galaxy.webapps.galaxy.api.group_roles module
- galaxy.webapps.galaxy.api.group_users module
- galaxy.webapps.galaxy.api.groups module
- galaxy.webapps.galaxy.api.histories module
- galaxy.webapps.galaxy.api.history_contents module
- galaxy.webapps.galaxy.api.item_tags module
- galaxy.webapps.galaxy.api.job_files module
- galaxy.webapps.galaxy.api.job_lock module
- galaxy.webapps.galaxy.api.job_ports module
- galaxy.webapps.galaxy.api.jobs module
- galaxy.webapps.galaxy.api.libraries module
- galaxy.webapps.galaxy.api.library_contents module
- galaxy.webapps.galaxy.api.library_datasets module
- galaxy.webapps.galaxy.api.licenses module
- galaxy.webapps.galaxy.api.metrics module
- galaxy.webapps.galaxy.api.page_revisions module
- galaxy.webapps.galaxy.api.pages module
- galaxy.webapps.galaxy.api.plugins module
- galaxy.webapps.galaxy.api.provenance module
- galaxy.webapps.galaxy.api.quotas module
- galaxy.webapps.galaxy.api.remote_files module
- galaxy.webapps.galaxy.api.roles module
- galaxy.webapps.galaxy.api.sanitize_allow module
- galaxy.webapps.galaxy.api.search module
- galaxy.webapps.galaxy.api.short_term_storage module
- galaxy.webapps.galaxy.api.tags module
- galaxy.webapps.galaxy.api.tasks module
- galaxy.webapps.galaxy.api.tool_data module
- galaxy.webapps.galaxy.api.tool_dependencies module
- galaxy.webapps.galaxy.api.tool_entry_points module
- galaxy.webapps.galaxy.api.tool_shed_repositories module
- galaxy.webapps.galaxy.api.tools module
- galaxy.webapps.galaxy.api.toolshed module
- galaxy.webapps.galaxy.api.tours module
- galaxy.webapps.galaxy.api.trs_consumer module
- galaxy.webapps.galaxy.api.trs_search module
- galaxy.webapps.galaxy.api.uploads module
- galaxy.webapps.galaxy.api.users module
- galaxy.webapps.galaxy.api.visualizations module
- galaxy.webapps.galaxy.api.webhooks module
- galaxy.webapps.galaxy.api.workflows module
- galaxy.webapps.galaxy.controllers package
- Submodules
- galaxy.webapps.galaxy.controllers.admin module
- galaxy.webapps.galaxy.controllers.admin_toolshed module
- galaxy.webapps.galaxy.controllers.async module
- galaxy.webapps.galaxy.controllers.authnz module
- galaxy.webapps.galaxy.controllers.data_manager module
- galaxy.webapps.galaxy.controllers.dataset module
- galaxy.webapps.galaxy.controllers.error module
- galaxy.webapps.galaxy.controllers.forms module
- galaxy.webapps.galaxy.controllers.history module
- galaxy.webapps.galaxy.controllers.library module
- galaxy.webapps.galaxy.controllers.page module
- galaxy.webapps.galaxy.controllers.root module
- galaxy.webapps.galaxy.controllers.shed_tool_static module
- galaxy.webapps.galaxy.controllers.tag module
- galaxy.webapps.galaxy.controllers.tool_runner module
- galaxy.webapps.galaxy.controllers.user module
- galaxy.webapps.galaxy.controllers.userskeys module
- galaxy.webapps.galaxy.controllers.visualization module
- galaxy.webapps.galaxy.controllers.workflow module
- galaxy.webapps.galaxy.services package
- Submodules
- galaxy.webapps.galaxy.services.authenticate module
- galaxy.webapps.galaxy.services.base module
- galaxy.webapps.galaxy.services.dataset_collections module
- galaxy.webapps.galaxy.services.datasets module
- galaxy.webapps.galaxy.services.histories module
- galaxy.webapps.galaxy.services.history_contents module
- galaxy.webapps.galaxy.services.invocations module
- galaxy.webapps.galaxy.services.jobs module
- galaxy.webapps.galaxy.services.libraries module
- galaxy.webapps.galaxy.services.library_folder_contents module
- galaxy.webapps.galaxy.services.library_folders module
- galaxy.webapps.galaxy.services.pages module
- galaxy.webapps.galaxy.services.quotas module
- galaxy.webapps.galaxy.services.sharable module
- galaxy.webapps.galaxy.services.tools module
- galaxy.webapps.galaxy.services.users module
- galaxy.webapps.galaxy.services.visualizations module
- galaxy.webapps.galaxy.services.workflows module
- galaxy.webapps.galaxy.api package
- Submodules
- galaxy.webapps.galaxy.buildapp module
- galaxy.webapps.galaxy.fast_app module
- galaxy.webapps.galaxy.fast_factory module
- galaxy.webapps.galaxy.workers module
- Subpackages
- galaxy.webapps.openapi package
- Submodules
- galaxy.webapps.openapi.utils module
get_openapi_security_definitions()
get_openapi_operation_parameters()
get_openapi_operation_request_body()
generate_operation_id()
generate_operation_summary()
get_openapi_operation_metadata()
get_openapi_path()
get_flat_models_from_routes()
get_openapi()
merge_paths()
merge_tags()
merge_summary()
merge_description()
merge_operation_id()
merge_deprecated()
merge_parameters()
deep_dict_operation_merge()
- galaxy.webapps.reports package
url_for()
expose()
- Subpackages
- galaxy.webapps.reports.api package
- galaxy.webapps.reports.controllers package
- Submodules
- galaxy.webapps.reports.controllers.history module
- galaxy.webapps.reports.controllers.home module
- galaxy.webapps.reports.controllers.jobs module
- galaxy.webapps.reports.controllers.query module
- galaxy.webapps.reports.controllers.root module
- galaxy.webapps.reports.controllers.system module
- galaxy.webapps.reports.controllers.tools module
- galaxy.webapps.reports.controllers.users module
- galaxy.webapps.reports.controllers.workflows module
- Submodules
- galaxy.webapps.reports.app module
UniverseApplication
UniverseApplication.__init__()
UniverseApplication.name
UniverseApplication.config
UniverseApplication.application_stack
UniverseApplication.model
UniverseApplication.security
UniverseApplication.shutdown()
UniverseApplication.datatypes_registry
UniverseApplication.auth_manager
UniverseApplication.toolbox
UniverseApplication.security_agent
UniverseApplication.quota_agent
- galaxy.webapps.reports.buildapp module
- galaxy.webapps.reports.config module
- galaxy.webapps.reports.fast_app module
- galaxy.webapps.reports.fast_factory module
Submodules¶
galaxy.webapps.util module¶
- 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 py:class: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.webapps.base.webapp.WebApplication
subclass) – application to wrapstack (
galaxy.web_stack.ApplicationStack
subclass) – instance of application stack implementing allowed_middleware() methodwrap (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.