Skip to content

fix(workflows): allow Special parameters to have Intervals #508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
prasad-albert merged 1 commit into from
May 22, 2026
Merged

fix(workflows): allow Special parameters to have Intervals #508

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 30 additions & 3 deletions src/albert/resources/workflows.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,22 @@ class IntervalParameter(BaseAlbertModel):
class Interval(BaseAlbertModel):
"""A Pydantic class representing an interval.

Attrubutes
Attributes
----------
value : str
The value of the interval setpoint.
The value of the interval setpoint. For Special parameters (Equipment, Consumables,
Templates) this is the entity ID (e.g. ``"INVC191778"``). For Normal parameters this
is a plain scalar string (e.g. ``"23"``).
name : str | None
The display name of the interval value. Populated for Special parameters (e.g.
``"Pipette 0.01 -0.1 ml (10 - 100 μl)"``). ``None`` for Normal parameters.
unit : Unit
The unit of the related value.

"""

value: str | None = Field(default=None)
name: str | None = Field(default=None)
unit: SerializeAsEntityLink[Unit] | None = Field(default=None, alias="Unit")
row_id: RowId | None = Field(default=None, alias="rowId", exclude=True)

Expand All @@ -70,6 +76,21 @@ def validate_interval(self) -> Interval:
return self


class IntervalDetail(BaseAlbertModel):
"""A single parameter's contribution to an interval combination.

Attributes
----------
name : str
The parameter name (e.g. ``"Equipment"``).
value : str
The display value for this interval (e.g. ``"C191778 || Pipette 0.01 -0.1 ml"``).
"""

name: str
value: str


class IntervalCombination(BaseAlbertModel):
"""A class representing the interval combinations of on a workflow.
This is returned by the workflow endpoint when at least one parameter
Expand All @@ -91,11 +112,15 @@ class IntervalCombination(BaseAlbertModel):
The string representation of the interval combination
This will have the form "[Parameter Name]: [Parameter Value] [Parameter Unit]"
for each parameter in the interval combination
interval_details : list[IntervalDetail] | None
Per-parameter breakdown of the interval combination. Each entry has ``name``
(parameter name) and ``value`` (display string, e.g. ``"C191778 || Pipette ..."``)
"""

interval_id: IntervalId | None = Field(default=None, alias="interval")
interval_params: str | None = Field(default=None, alias="intervalParams")
interval_string: str | None = Field(default=None, alias="intervalString")
interval_details: list[IntervalDetail] | None = Field(default=None, alias="intervalDetails")


class ParameterSetpoint(BaseAlbertModel):
Expand Down Expand Up @@ -162,7 +187,9 @@ def has_id(obj: Any) -> bool:
# Special Parameters
if self.category == ParameterCategory.SPECIAL:
if self.intervals is not None:
raise ValueError(f"Parameter {pid}: Special parameters cannot have 'intervals'.")
# Intervalized special parameters (Equipment, Consumables, Templates) are valid;
# each interval value is a plain entity ID string.
return self
if self.value is None:
return self # presence-only allowed
if not has_id(self.value):
Expand Down