본문 바로가기

Flow Production Tracking/Python api8

Python API Best Practices 성능 최적화필요한 필드만 요청: 불필요한 필드 포함 시 요청 속도가 느려질 수 있음.필터 구체화: API 쿼리에서 필터링하는 것이 반환 후 데이터 파싱보다 효율적.예: is 필터가 contains보다 빠름.연결된 엔티티 요청 최적화: ID나 이름만 필요한 경우 기본 제공 필드(entity)를 요청. 필요한 경우에만 점 표기법 사용.제어 및 디버깅별도의 키 사용: 각 스크립트에 고유한 키를 생성해 디버깅을 용이하게 함.소유자 지정: 스크립트별 소유자 또는 유지 관리자를 명시.읽기 전용 권한 그룹 활용: 대부분의 스크립트는 읽기 권한만 필요하므로, 불필요한 변경을 방지.API 필드 이름 확인: UI 표시 이름과 API 필드 이름은 다를 수 있으므로 schema_read() 메서드 사용 권장.설계 권장 사항A.. 2024. 12. 29.
Python API Overview 환경 설정API를 사용하려면 스크립트 키 또는 **개인 액세스 토큰(PAT)**을 통해 인증 필요.각 스크립트에 개별 API 키를 등록해 로그 추적 및 모니터링 권장.PAT 설정은 관련 문서 및 비디오에서 지원.https://www.youtube.com/watch?v=RYEBQDJiXAs 활용 예시Version 생성 및 Shot 연결: 렌더링 제출 자동화.썸네일 업로드: 모든 항목에 최신 썸네일 자동 추가.코드 저장소와의 통합: 소프트웨어 개발을 프로젝트 관리로 통합.제약 사항(API를 사용하여 수행할 수 없는 작업)권한 규칙 액세스 또는 변경(보안상의 이유)페이지 설정 읽기 또는 변경개별 페이지 또는 위젯에 대한 필터 또는 쿼리 설정 액세스UI와 상호 작용조건부 형식 지정 규칙 추가, 편집 또는 제거쿼.. 2024. 12. 29.
Handling Action Menu Item Calls 주요 기능GET vs POST:ActionMenuItem이 HTTP/HTTPS로 데이터를 전송하는 경우 POST 방식 사용.GET 방식은 사용자 지정 프로토콜(custom protocol)에서 사용되며, 브라우저에서 URL 길이 제한에 유의해야 합니다.클래스 개요:ShotgunAction 클래스는 URL을 프로토콜, 액션, 파라미터로 분리하여 변수에 저장.GET 요청의 파라미터를 Python 딕셔너리로 파싱.주요 코드 설명# ---------------------------------------------------------------------------------------------# Imports# ------------------------------------------------------.. 2024. 12. 25.
API Usage Tips 모듈 임포트권장: 전체 모듈(shotgun_api3)을 임포트합니다. 모듈 수준에서 관리되는 중요한 기능이 있기 때문입니다.import shotgun_api3비추천: 특정 클래스만 임포트하지 마세요.from shotgun_api3 import Shotgun멀티스레딩ShotGrid API는 **스레드 안전(thread-safe)**하지 않습니다. 각 스레드마다 별도의 연결 객체를 사용하는 것이 좋습니다.엔터티 필드find() 또는 create() 호출 시 엔터티 필드는 표준 딕셔너리 형태로 반환됩니다:type: 엔터티 타입(CamelCase).name: 엔터티의 디스플레이 이름.{'type': 'Asset', 'name': 'redBall', 'id': 1}사용자 정의 엔터티(CustomEntities)사.. 2024. 12. 25.
API Reference(2) 데이터 타입과 값Addressing값: list형식: 리스트 안에 딕셔너리[ { 'type': 'HumanUser' | 'Group', 'id': int, ... }, ...]Checkbox값: bool (True | False)Color값: str예시:색상 값: "255,0,0"pipeline_step: 파이프라인 스텝 색상을 상속Currency값: float | None범위: -9999999999999.99 ~ 9999999999999.99Date값: str | None범위: 연도 >= 1970형식: YYYY-MM-DDDateTime값: datetime | None범위: 연도 >= 1970특징: 서버에서 UTC로 저장되며, 클라이언트의 로컬 시간대.. 2024. 12. 25.
API Reference(1) Shotgun 모듈 속성shotgun_api3.shotgun.LOG: API 실행 시 로그 메시지를 기록하는 로깅 인스턴스.shotgun_api3.shotgun.NO_SSL_VALIDATION: SSL 인증서의 호스트 이름 일치 검증을 비활성화하는 옵션.Shotgun 클래스shotgun_api3.shotgun.Shotgun설명Shotgun 서버와 클라이언트 간의 연결을 초기화하고 관리하는 클래스입니다. 이 클래스는 데이터를 CRUD(Create, Read, Update, Delete) 방식으로 Shotgun 서버와 주고받을 수 있게 합니다.생성자 매개변수  매개변수  유형 필수   여부  설명 base_urlstr필수Shotgun 서버의 HTTP/HTTPS URL. 슬래시(/) 없이 작성해야 함. .. 2024. 12. 25.