Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

StringParam: 문자열 입력 명세

transforms.api.StringParam은 변환 입력으로 사용하는 ParameterSpec의 명세입니다. 기본값은 Python str 유형으로 지정합니다.

transforms.api.StringParam(default, *, description=None, allowed_values=None)
인자형식필수 여부와 기본값의미
defaultstr필수매개변수의 기본값
descriptionstr선택, None매개변수 설명
allowed_valuesOptional[Set[str]]선택, None허용할 문자열 집합

* 뒤의 인자는 키워드로 전달합니다. 다음은 가상 변환의 입력 명세를 선언하는 예시입니다.

from transforms.api import StringParam

parameter = StringParam(
    default="strict",
    description="처리 모드",
    allowed_values={"strict", "lenient"},
)

실행 인터페이스

메서드 또는 속성동작
instance(context, json_value)정적 메서드. ParamContext와 JobSpec의 역직렬화된 원시 JSON 값을 받아 인스턴스를 생성하고, 반환값을 compute 함수에 주입합니다.
lightweight_instance(context, json_value)정적 메서드. 확정된 JSON 값에서 lightweight 입력 유형을 인스턴스화합니다.
input_results(_instance, **_kwargs)instance에서 생성한 유형의 객체를 받아 입력 RID에서 TransformsInputResult로의 맵을 생성합니다. 결과는 TransformJobResult에 병합됩니다.
json_valueJobSpec에 담을 JSON 값을 반환합니다. None이면 바인딩되지 않은 매개변수입니다.
schema해당 유형의 유효한 JSON 스키마를 반환해야 합니다.

변환의 매개변수 중 하나라도 바인딩되지 않았으면 해당 변환의 JobSpec은 게시하지 않습니다. Param 공통 계약과 compute에서 값을 읽는 방법을 함께 확인합니다.