⑴ 임포트 플러그인

Upload(임포트) 플러그인이 스토리지 파일을 검증하고 Synapse 데이터유닛으로 생성하는 흐름을 구현합니다.

진행 순서

1. 임포트 플러그인의 역할을 확인합니다.
2. 업로드 파일의 입력 계약을 확인합니다.
3. 기본 임포트 플러그인 코드를 구현합니다.
4. 필요한 경우 전처리 단계를 추가합니다.
5. 필요한 경우 사용자 입력 옵션을 config.yaml에 선언합니다.

1. 임포트 플러그인 역할 확인

Upload(임포트) 플러그인은 파일 수집, 검증, 업로드, 데이터유닛 생성을 처리합니다.

기본 골격이 표준 업로드 절차를 포함하므로, 일반적인 임포트 플러그인은 필요한 제한 조건과 전처리 로직만 추가해서 구현할 수 있습니다.

2. 파일 사양 확인하기

업로드되는 파일은 데이터 컬렉션에 정의된 파일 사양(file specification) 과 맞아야 합니다.

검증 대상에는 허용 확장자, 파일 크기 제한, 필수 파일 존재 여부가 포함됩니다.

예를 들어 0001.jpg와 0001.pcd는 파일명 stem이 0001로 같기 때문에 하나의 데이터유닛으로 생성됩니다.

3. 기본 임포트 플러그인 구현

기본 구현에서는 DefaultUploadAction과 UploadParams를 사용합니다.

최소 임포트 플러그인은 허용 확장자만 정의해도 동작할 수 있습니다.

from synapse_sdk.plugins.actions.upload import DefaultUploadAction, UploadParams

class UploadAction(DefaultUploadAction[UploadParams]):
    action_name = 'upload'
    params_model = UploadParams

    def get_allowed_extensions(self):
        return {'image': ['.jpg', '.jpeg', '.png']}

코드 구성

4. 전처리 단계 추가

표준 업로드 흐름 중간에 플러그인별 전처리 단계를 추가할 수 있습니다.

기본 업로드 절차를 유지하려면 먼저 super().setup_steps(registry)를 호출한 뒤, 원하는 위치에 커스텀 단계를 삽입합니다.

def setup_steps(self, registry):
    super().setup_steps(registry)
    registry.insert_after('organize_files', MyPreprocessStep())

5. 사용자 입력 옵션 선언

플러그인 전용 옵션은 config.yaml의 ui_schema에 선언합니다.

스토리지, 경로, 데이터 컬렉션처럼 플랫폼에서 공통으로 처리하는 입력값은 ui_schema에 추가하지 않습니다.

actions:
  upload:
    entrypoint:plugin.upload.UploadAction
    method:job
    ui_schema:
    -$formkit:text
      name:frame_per_second
      label:초당 추출 프레임 수
      required:false

사용자가 입력한 값은 실행 시 다음 경로로 전달됩니다.

context.params['extra_params']