본문으로 건너뛰기

flow.input

flow.input(...)flow = px.Flow(...)로 만든 Flow 객체의 메서드입니다. Flow가 밖에서 값을 받을 공개 input을 만듭니다.

무엇을 만드나요?

Flow 경계에 이름과 타입이 있는 input port 하나를 추가합니다. Report Workbench와 승인된 App도 이 공개 input을 찾아 값을 연결할 수 있습니다.

Studio에서는 어디에 보이나요?

Canvas의 Flow input으로 보입니다. 이 port에서 Node input으로 연결선을 그을 수 있습니다.

문법

python
flow.input(input_key, ValueType, *, description, unit=None, constraints=None)

최소 예제

아래 코드는 px.Flow(...)flow를 만든 다음 이어서 작성합니다.

python
span = flow.input(
    "span",
    float,
    unit="m",
    description="Clear span between bearing centre-lines.",
)

매개변수

이름설명
input_keyFlow 안에서 input을 구분하는 lower_snake_case 이름
ValueType받을 값의 Python 타입
description값의 의미를 설명하는 문장
unit숫자 공학 값의 기준 단위. 무차원 값은 "1"
constraints최소값 등 입력 제약

반환값과 handle

Flow input handle을 반환합니다. 이 handle을 연결의 시작점으로 사용합니다.

python
flow.connect(span, check.inputs.span)

규칙과 진단

  • flow.input(...)은 Flow의 공개 경계를 만들고, px.input(...)은 Python 함수의 Node input을 설명합니다.
  • 숫자 공학 값에는 canonical unit을 작성합니다.
  • 같은 Flow에서 input key가 중복되거나 지원하지 않는 타입·단위를 쓰면 validation 오류가 발생합니다.
  • Report의 값과 이 input의 관계는 Report에 저장됩니다. Flow 내부에서는 flow.connect(...)만 사용합니다.

다음