Skip to content

Commit

Permalink
shorten datasets names
Browse files Browse the repository at this point in the history
output "data 1, 2, and 3" instead of "data 1, data 2, and data 3"
  • Loading branch information
bernt-matthias committed Dec 3, 2024
1 parent 0aaa505 commit d70fe5c
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 23 deletions.
7 changes: 4 additions & 3 deletions lib/galaxy/tools/actions/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
)
from galaxy.tools.execution_helpers import (
filter_output,
on_text_for_names,
on_text_for_dataset_and_collections,
ToolExecutionCache,
)
from galaxy.tools.parameters import update_dataset_ids
Expand Down Expand Up @@ -885,6 +885,7 @@ def _wrapped_params(self, trans, tool, incoming, input_datasets=None):

def _get_on_text(self, inp_data, inp_dataset_collections):
input_names = []
collection_names = []
collection_hda_ids = set()
# output collection id and store included hda ids (to avoid extra inclusion in the list of datasets)
# two for loops because:
Expand All @@ -905,8 +906,8 @@ def _get_on_text(self, inp_data, inp_dataset_collections):
if getattr(data, "id", None) is None or data.id in collection_hda_ids:
continue
if getattr(data, "hid", None):
input_names.append(f"data {data.hid}")
return on_text_for_names(input_names)
input_names.append(f"{data.hid}")
return on_text_for_dataset_and_collections(dataset_names=input_names, collection_names=collection_names)

def _new_job_for_session(self, trans, tool, history) -> Tuple[model.Job, Optional[model.GalaxySession]]:
job = trans.app.model.Job()
Expand Down
6 changes: 3 additions & 3 deletions lib/galaxy/tools/execute.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
from galaxy.tool_util.parser import ToolOutputCollectionPart
from galaxy.tools.execution_helpers import (
filter_output,
on_text_for_names,
on_text_for_dataset_and_collections,
ToolExecutionCache,
)
from galaxy.tools.parameters.workflow_utils import is_runtime_value
Expand Down Expand Up @@ -325,8 +325,8 @@ def record_error(self, error):
def on_text(self) -> Optional[str]:
collection_info = self.collection_info
if self._on_text is None and collection_info is not None:
collection_names = ["collection %d" % c.hid for c in collection_info.collections.values()]
self._on_text = on_text_for_names(collection_names)
collection_names = ["%d" % c.hid for c in collection_info.collections.values()]
self._on_text = on_text_for_dataset_and_collections(collection_names=collection_names)

return self._on_text

Expand Down
23 changes: 17 additions & 6 deletions lib/galaxy/tools/execution_helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
"""

import logging
from typing import Collection
from typing import (
Collection,
Optional,
)

log = logging.getLogger(__name__)

Expand Down Expand Up @@ -48,7 +51,9 @@ def filter_output(tool, output, incoming):
return False


def on_text_for_names(input_names: Collection[str]) -> str:
def on_text_for_names(input_names: Optional[Collection[str]], prefix) -> str:
if input_names is None:
return ""
# input_names may contain duplicates... this is because the first value in
# multiple input dataset parameters will appear twice once as param_name
# and once as param_name1.
Expand All @@ -62,11 +67,17 @@ def on_text_for_names(input_names: Collection[str]) -> str:
if len(input_names) == 0:
on_text = ""
elif len(input_names) == 1:
on_text = input_names[0]
on_text = prefix + " " + input_names[0]
elif len(input_names) == 2:
on_text = "{} and {}".format(*input_names)
on_text = prefix + "s {} and {}".format(*input_names)
elif len(input_names) == 3:
on_text = "{}, {}, and {}".format(*input_names)
on_text = prefix + "s {}, {}, and {}".format(*input_names)
else:
on_text = "{}, {}, and others".format(*input_names[:2])
on_text = prefix + "s {}, {}, and others".format(*input_names[:2])
return on_text


def on_text_for_dataset_and_collections(
dataset_names: Optional[Collection[str]] = None, collection_names: Optional[Collection[str]] = None
) -> str:
return on_text_for_names(collection_names, "collection") + on_text_for_names(dataset_names, "dataset")
6 changes: 3 additions & 3 deletions lib/galaxy_test/api/test_workflows.py
Original file line number Diff line number Diff line change
Expand Up @@ -5871,7 +5871,7 @@ def test_run_build_list_hide_collection_output(self):
history_id, hid=3, wait=True, assert_ok=True
)
assert details1["elements"][0]["object"]["visible"] is False
assert details1["name"] == "data 1 (as list)", details1
assert details1["name"] == "dataset 1 (as list)", details1
assert details1["visible"] is False

@skip_without_tool("__BUILD_LIST__")
Expand Down Expand Up @@ -5906,7 +5906,7 @@ def test_run_build_list_delete_intermediate_collection_output(self):
history_id, hid=3, wait=True, assert_ok=True
)
assert details1["elements"][0]["object"]["visible"] is False
assert details1["name"] == "data 1 (as list)", details1
assert details1["name"] == "dataset 1 (as list)", details1
# FIXME: this doesn't work because the workflow is still being scheduled
# TODO: Implement a way to run PJAs that couldn't be run during/after the job
# after the workflow has run to completion
Expand Down Expand Up @@ -5951,7 +5951,7 @@ def test_run_build_list_change_datatype_collection_output(self):
details1 = self.dataset_populator.get_history_collection_details(
history_id, hid=3, wait=True, assert_ok=True
)
assert details1["name"] == "data 1 (as list)", details1
assert details1["name"] == "dataset 1 (as list)", details1
assert details1["elements"][0]["object"]["visible"] is False
assert details1["elements"][0]["object"]["file_ext"] == "txt"
details2 = self.dataset_populator.get_history_collection_details(
Expand Down
2 changes: 1 addition & 1 deletion lib/galaxy_test/selenium/test_tool_form.py
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ def test_run_data(self):

latest_hda = self.latest_history_item()
assert latest_hda["hid"] == 3
assert latest_hda["name"] == "Select first on data 1"
assert latest_hda["name"] == "Select first on dataset 1"

@selenium_test
def test_bibtex_rendering(self):
Expand Down
14 changes: 7 additions & 7 deletions test/unit/app/tools/test_actions.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,15 @@

def test_on_text_for_names():
def assert_on_text_is(expected, *names):
on_text = on_text_for_names(names)
on_text = on_text_for_names(names, "dataset")
assert on_text == expected, f"Wrong on text value {on_text}, expected {expected}"

assert_on_text_is("data 1", "data 1")
assert_on_text_is("data 1 and data 2", "data 1", "data 2")
assert_on_text_is("data 1, data 2, and data 3", "data 1", "data 2", "data 3")
assert_on_text_is("data 1, data 2, and others", "data 1", "data 2", "data 3", "data 4")
assert_on_text_is("dataset 1", "1")
assert_on_text_is("datasets 1 and 2", "1", "2")
assert_on_text_is("datasets 1, 2, and 3", "1", "2", "3")
assert_on_text_is("datasets 1, 2, and others", "1", "2", "3", "4")

assert_on_text_is("data 1 and data 2", "data 1", "data 1", "data 2")
assert_on_text_is("datasets 1 and 2", "1", "1", "2")


class TestDefaultToolAction(TestCase, tools_support.UsesTools):
Expand Down Expand Up @@ -99,7 +99,7 @@ def test_output_label_data(self):
tools_support.SIMPLE_CAT_TOOL_CONTENTS,
incoming,
)
assert output["out1"].name == "Test Tool on data 2 and data 1"
assert output["out1"].name == "Test Tool on datasets 2 and 1"

def test_object_store_ids(self):
_, output = self._simple_execute(contents=TWO_OUTPUTS)
Expand Down

0 comments on commit d70fe5c

Please sign in to comment.