Params language: one language at every depth

クローズ
  • 何か問題がありますか？
#135 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@SimonHeybrock がすでに取り組んでいます。

2026年11月3日 から。

  • #136 @SimonHeybrock による — マージ済み

評価

この issue はまだ評価されていません。

説明

With #133, a spec marks each field that a reference fills as Referenced[T]. Most rules that set a parameter apart from a field of a group existed because a reference inside a group was costly. They include: references only at a parameter or a row, flat groups, a "data value" that made a group reference-only, and "every parameter is a group". This issue makes the params language the same at every depth.

The language

A field of the params model, or of a group nested to any depth, is typed from a closed list:

int, float, str, bool, datetime, an enum, a Literal   # scalars
RunFile                                               # a file model
Specimen                                              # a group: its fields typed the same way
Annotated[A | B, Field(discriminator='kind')]         # a union of groups, tagged
Referenced[T]                                         # T a group; the framework does not look inside
X | None, list[X]                                     # X not a list, not X | None
Annotated[A | B, ...] | Referenced[C]                 # inline members and referenced members

Any other type is refused, such as a tuple, a dict, int | str, or sc.DataArray outside Referenced[T]. A group that contains itself is refused.

class Sample(BaseModel):
    run: SampleRun
    thickness: float = 1.0
    window: Window | None = None
    transmission: Referenced[Transmission]   # a reference at a field of a table row

class Params(BaseModel):
    samples: list[Sample]

How a group with a reference is validated

When A file A reference to an output
submit resolved to its identity through the validation context checked against history, at its position
run given its local path through the validation context replaced by its data through the validation context

When the request runs, the params model itself validates what the record stores, and the marker of Referenced[T] reads the data. A group that holds a reference runs its validators then; every other group is validated whole at submit.

Decisions

  • No "data value": a type outside the list is refused.
  • A parameter need not be a group. By convention it still is: a group is a tab of the form and a key of the binding. PipelineBinding requires keys= for any other parameter.
  • X | None at any depth: a choice with a "None" way in the form, files included.
  • Lists at any depth. Only a table is validated a row at a time, and only a table is limited to length constraints.
  • Table rows are distinct by their stored form only: a file by its identity, a reference by its record and output.
  • The discriminator sits on the union written inline, since a reference has no tag.
  • The term "place" goes, and ess.spec.places is folded into field_types and request_types.
主要言語
Python
スター
0
フォーク
1
平均マージ
8時間 48分
マージ済み PR（30日）
70

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

scipp/essapps のほかの issue

scipp/essapps の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。