1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
|
"""Define the ParsedTool model representing metadata extracted from a tool's source.
This is abstraction exported by newer tool shed APIS (circa 2024) and should be sufficient
for reasoning about tool state externally from Galaxy.
"""
from typing import (
Any,
Dict,
List,
Optional,
Union,
)
from pydantic import (
AfterValidator,
AnyUrl,
BaseModel,
ConfigDict,
Field,
model_validator,
RootModel,
)
from typing_extensions import (
Annotated,
Literal,
NotRequired,
TypedDict,
)
from galaxy.tool_util_models.parameters import GalaxyToolParameterModel
from ._base import ToolSourceBaseModel
from .assertions import assertions
from .parameters import ToolParameterT
from .tool_outputs import (
IncomingToolOutput,
ToolOutput,
)
from .tool_source import (
Citation,
ContainerRequirement,
HelpContent,
JavascriptRequirement,
OutputCompareType,
ResourceRequirement,
XrefDict,
YamlTemplateConfigFile,
)
def normalize_dict(values, keys: List[str]):
for key in keys:
items = values.get(key)
if isinstance(items, dict): # dict-of-dicts format
# Transform dict-of-dicts to list-of-dicts
values[key] = [{"name": k, **v} for k, v in items.items()]
class ToolSourceBase(ToolSourceBaseModel):
id: Optional[str] = None
name: Optional[str] = None
version: Optional[str] = "1.0"
profile: Optional[float] = None
description: Optional[str] = None
container: Optional[str] = None
requirements: Optional[List[Union[JavascriptRequirement, ResourceRequirement, ContainerRequirement]]] = []
inputs: List[GalaxyToolParameterModel] = []
outputs: List[IncomingToolOutput] = []
citations: Optional[List[Citation]] = None
license: Optional[str] = None
edam_operations: Optional[List[str]] = None
edam_topics: Optional[List[str]] = None
xrefs: Optional[List[XrefDict]] = None
help: Optional[HelpContent] = None
@model_validator(mode="before")
@classmethod
def normalize_items(cls, values):
if isinstance(values, dict):
normalize_dict(values, ["inputs", "outputs"])
return values
# repeated fields to get consistent order, ugh, FIXME obviously
class UserToolSource(ToolSourceBaseModel):
class_: Annotated[Literal["GalaxyUserTool"], Field(alias="class")]
id: Annotated[
str,
Field(
description="Unique identifier for the tool. Should be all lower-case and should not include whitespace.",
examples=["my-cool-tool"],
min_length=3,
max_length=255,
),
]
version: Annotated[str, Field(description="Version for the tool.", examples=["0.1.0"])]
name: Annotated[
str,
Field(
description="The name of the tool, displayed in the tool menu. This is not the same as the tool id, which is a unique identifier for the tool."
),
]
description: Annotated[
Optional[str],
Field(
description="The description is displayed in the tool menu immediately following the hyperlink for the tool."
),
] = None
configfiles: Annotated[
Optional[List[YamlTemplateConfigFile]], Field(description="A list of config files for this tool.")
] = None
container: Annotated[
str, Field(description="Container image to use for this tool.", examples=["quay.io/biocontainers/python:3.13"])
]
requirements: Annotated[
Optional[List[Union[JavascriptRequirement, ResourceRequirement, ContainerRequirement]]],
Field(
description="A list of requirements needed to execute this tool. These can be javascript expressions, resource requirements or container images."
),
] = []
shell_command: Annotated[
str,
Field(
title="shell_command",
description="A string that contains the command to be executed. Parameters can be referenced inside $().",
examples=["head -n '$(inputs.n_lines)' '$(inputs.data_input.path)'"],
),
]
inputs: List[GalaxyToolParameterModel] = []
outputs: List[IncomingToolOutput] = []
citations: Optional[List[Citation]] = None
license: Annotated[
Optional[str],
Field(
description="A full URI or a a short [SPDX](https://spdx.org/licenses/) identifier for a license for this tool wrapper. The tool wrapper license can be independent of the underlying tool license. This license covers the tool yaml and associated scripts shipped with the tool.",
examples=["MIT"],
),
] = None
edam_operations: Optional[List[str]] = None
edam_topics: Optional[List[str]] = None
xrefs: Optional[List[XrefDict]] = None
help: Annotated[Optional[HelpContent], Field(description="Help text shown below the tool interface.")] = None
@model_validator(mode="before")
@classmethod
def normalize_items(cls, values):
if isinstance(values, dict):
normalize_dict(values, ["inputs", "outputs"])
return values
class AdminToolSource(ToolSourceBase):
class_: Annotated[Literal["GalaxyTool"], Field(alias="class")]
command: str
DynamicToolSources = Annotated[Union[UserToolSource, AdminToolSource], Field(discriminator="class_")]
class ParsedTool(ToolSourceBaseModel):
id: str
version: Optional[str]
name: str
description: Optional[str]
inputs: List[ToolParameterT]
outputs: List[ToolOutput]
citations: List[Citation]
license: Optional[str]
profile: Optional[str]
edam_operations: List[str]
edam_topics: List[str]
xrefs: List[XrefDict]
help: Optional[HelpContent]
class StrictModel(BaseModel):
model_config = ConfigDict(extra="forbid", field_title_generator=lambda field_name, field_info: field_name.lower())
class BaseTestOutputModel(StrictModel):
file: Optional[str] = None
path: Optional[str] = None
location: Optional[AnyUrl] = None
ftype: Optional[str] = None
sort: Optional[bool] = None
compare: Optional[OutputCompareType] = None
checksum: Optional[str] = None
metadata: Optional[Dict[str, Any]] = None
asserts: Optional[assertions] = None
delta: Optional[int] = None
delta_frac: Optional[float] = None
lines_diff: Optional[int] = None
decompress: Optional[bool] = None
class TestDataOutputAssertions(BaseTestOutputModel):
class_: Optional[Literal["File"]] = Field("File", alias="class")
class TestCollectionCollectionElementAssertions(StrictModel):
elements: Optional[Dict[str, "TestCollectionElementAssertion"]] = None
element_tests: Optional[Dict[str, "TestCollectionElementAssertion"]] = None
class TestCollectionDatasetElementAssertions(BaseTestOutputModel):
pass
TestCollectionElementAssertion = Union[
TestCollectionDatasetElementAssertions, TestCollectionCollectionElementAssertions
]
TestCollectionCollectionElementAssertions.model_rebuild()
def _check_collection_type(v: str) -> str:
if len(v) == 0:
raise ValueError("Invalid empty collection_type specified.")
collection_levels = v.split(":")
for collection_level in collection_levels:
if collection_level not in ["list", "paired"]:
raise ValueError(f"Invalid collection_type specified [{v}]")
return v
CollectionType = Annotated[Optional[str], AfterValidator(_check_collection_type)]
class CollectionAttributes(StrictModel):
collection_type: CollectionType = None
class TestCollectionOutputAssertions(StrictModel):
class_: Optional[Literal["Collection"]] = Field("Collection", alias="class")
elements: Optional[Dict[str, TestCollectionElementAssertion]] = None
element_tests: Optional[Dict[str, "TestCollectionElementAssertion"]] = None
element_count: Optional[int] = None
attributes: Optional[CollectionAttributes] = None
collection_type: CollectionType = None
TestOutputLiteral = Union[bool, int, float, str]
TestOutputAssertions = Union[TestCollectionOutputAssertions, TestDataOutputAssertions, TestOutputLiteral]
JobDict = Dict[str, Any]
class TestJob(StrictModel):
doc: Optional[str]
job: JobDict
outputs: Dict[str, TestOutputAssertions]
expect_failure: Optional[bool] = False
Tests = RootModel[List[TestJob]]
# TODO: typed dict versions of all thee above for verify code - make this Dict[str, Any] here more
# specific.
OutputChecks = Union[TestOutputLiteral, Dict[str, Any]]
OutputsDict = Dict[str, OutputChecks]
class TestJobDict(TypedDict):
doc: NotRequired[str]
job: NotRequired[JobDict]
expect_failure: NotRequired[bool]
outputs: OutputsDict
TestDicts = List[TestJobDict]
|