galaxy.web package¶
The Galaxy web application framework
- galaxy.web.expose_api(func, to_json=True, user_required=True, user_or_session_required=True, handle_jsonp=True)[source]¶
Expose this function via the API.
- galaxy.web.expose_api_anonymous(func, to_json=True)[source]¶
Expose this function via the API but don’t require a set user.
- galaxy.web.expose_api_anonymous_and_sessionless(func, to_json=True)[source]¶
Expose this function via the API but don’t require a user or a galaxy_session.
- galaxy.web.format_return_as_json(rval, jsonp_callback=None, pretty=False)[source]¶
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)[source]¶
Format the response as JSON and set the response content type to JSON_CONTENT_TYPE.
- galaxy.web.legacy_expose_api(func, to_json=True, user_required=True)[source]¶
Expose this function via the API.
- galaxy.web.legacy_expose_api_anonymous(func, to_json=True)[source]¶
Expose this function via the API but don’t require a set user.
- galaxy.web.legacy_expose_api_raw(func)[source]¶
Expose this function via the API but don’t dump the results to JSON.
- galaxy.web.legacy_expose_api_raw_anonymous(func)[source]¶
Expose this function via the API but don’t dump the results to JSON.
- galaxy.web.legacy_url_for(mapper, *args, **kwargs) str [source]¶
Re-establishes the mapper for legacy WSGI routes.
- 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
- Subpackages
- galaxy.web.framework.helpers package
- 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
- galaxy.web.framework.decorators module
- Subpackages
- galaxy.web.legacy_framework package
- galaxy.web.proxy package
- galaxy.web.short_term_storage package
Submodules¶
galaxy.web.form_builder module¶
- class galaxy.web.form_builder.AddressField(name, user=None, value=None, security=None, **kwds)[source]¶
Bases:
BaseField
- class galaxy.web.form_builder.BaseField(name, value=None, label=None, **kwds)[source]¶
Bases:
object
- class galaxy.web.form_builder.CheckboxField(name, value=None, label=None, **kwds)[source]¶
Bases:
BaseField
A checkbox (boolean input)
- class galaxy.web.form_builder.HistoryField(name, user=None, value=None, security=None, **kwds)[source]¶
Bases:
BaseField
- class galaxy.web.form_builder.PasswordField(name, value=None, label=None, **kwds)[source]¶
Bases:
BaseField
A password input box. text appears as “**”
- class galaxy.web.form_builder.SelectField(name, multiple=None, display=None, field_id=None, value=None, selectlist=None, refresh_on_change=False, **kwds)[source]¶
Bases:
BaseField
A select field.
- class galaxy.web.form_builder.TextArea(name, value=None, label=None, **kwds)[source]¶
Bases:
BaseField
A standard text area box.
- class galaxy.web.form_builder.TextField(name, value=None, label=None, **kwds)[source]¶
Bases:
BaseField
A standard text input box.