문서

한국어

English · Core guides

한국어

English · Core guides

테마

px.setting ​

용도 ​

px.Settings field의 description·unit·required·default metadata를 선언합니다. Component companion의 settings 계약이 이 field들로 만들어집니다.

문법 ​

python
px.setting(*, description: str, unit: str | None = None, required: bool = True, default: object = ...)

예제 ​

python
from pipelinexlab import px


class ViewerSettings(px.Settings):
    thickness: float = px.setting(description="Plate thickness.", unit="mm")
    show_grid: bool = px.setting(description="Draws the grid.", default=True)

매개변수 ​

  • description — 이 setting의 한 문장 설명.
  • unit — RFC-003 unit code. 생략하면 단위 없음.
  • required — False면 값 생략을 허용합니다.
  • default — 생략 시 사용할 값. 지정하면 required가 강제되지 않습니다.

반환 ​

registry가 소비하는 내부 _SettingSpec marker를 반환합니다. px.Settings field 기본값 자리 밖에서는 사용하지 않습니다.

규칙 ​

  • @px.component(settings=ViewerSettings)로 연결하면 field들이 Component 선언의 settings 계약이 됩니다(최대 8개).
  • production third-party Component의 admission은 여전히 별도 게이트가 소유합니다. 이 marker는 선언 문법이지 공개 admission이 아닙니다.