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.tool_util.client package


galaxy.tool_util.client.staging module

Client for staging inputs for Galaxy Tools and Workflows.

Implement as a connector to serve a bridge between galactic_job_json utility and a Galaxy API library.

class galaxy.tool_util.client.staging.StagingInterface[source]

Bases: object

Client that parses a job input and populates files into the Galaxy API.

Abstract class that must override _post (and optionally other things such _attach_file, _log, etc..) to adapt to bioblend (for Planemo) or using the tool test interactor infrastructure.

stage(tool_or_workflow: typing_extensions.Literal[tool, workflow], history_id: str, job: Dict[str, Any] | None = None, job_path: str | None = None, use_path_paste: bool = True, to_posix_lines: bool = True, job_dir: str = '.') Tuple[Dict[str, Any], List[Dict[str, Any]]][source]
abstract property use_fetch_api

Return true is this should use (modern) data fetch API.

class galaxy.tool_util.client.staging.InteractorStaging(galaxy_interactor: ApiTestInteractor, use_fetch_api: bool = True)[source]

Bases: StagingInterface

__init__(galaxy_interactor: ApiTestInteractor, use_fetch_api: bool = True) None[source]
property use_fetch_api

Return true is this should use (modern) data fetch API.