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.work package

Submodules

galaxy.work.context module

class galaxy.work.context.WorkRequestContext(app, user=None, history=None, workflow_building_mode=False, qualified_url_builder=None)

Bases: galaxy.managers.context.ProvidesHistoryContext

Stripped down implementation of Galaxy web transaction god object for work request handling outside of web threads - uses mix-ins shared with GalaxyWebTransaction to provide app, user, and history context convenience methods - but nothing related to HTTP handling, mako views, etc….

Things that only need app shouldn’t be consuming trans - but there is a need for actions potentially tied to users and histories and hopefully this can define that stripped down interface providing access to user and history information - but not dealing with web request and response objects.

__init__(app, user=None, history=None, workflow_building_mode=False, qualified_url_builder=None)

Initialize self. See help(type(self)) for accurate signature.

property app

Provide access to the Galaxy app object.

property qualified_url_builder

Provide access to fully qualified Galaxy URLs (if available).

get_history(create=False)

property history

Provide access to the user’s current history model object.

Return type

Optional[galaxy.model.History]

get_user()

Return the current user if logged in or None.

get_current_user_roles()

set_user(user)

Set the current user.

property user

Return the current user if logged in or None.

class galaxy.work.context.SessionRequestContext(**kwargs)

Bases: galaxy.work.context.WorkRequestContext

Like WorkRequestContext, but provides access to galaxy session and session.

__init__(**kwargs)

Initialize self. See help(type(self)) for accurate signature.

get_galaxy_session()

galaxy.work.context.proxy_work_context_for_history(trans: galaxy.managers.context.ProvidesHistoryContext, history: Optional[galaxy.model.History] = None, workflow_building_mode=False)

Create a WorkContext for supplied context with potentially different history.

This provides semi-structured access to a transaction/work context with a supplied target history that is different from the user’s current history (which also might change during the request).