Python API Best Practices

성능 최적화

• 필요한 필드만 요청: 불필요한 필드 포함 시 요청 속도가 느려질 수 있음.
• 필터 구체화: API 쿼리에서 필터링하는 것이 반환 후 데이터 파싱보다 효율적.
  • 예: is 필터가 contains보다 빠름.
• 연결된 엔티티 요청 최적화: ID나 이름만 필요한 경우 기본 제공 필드(entity)를 요청. 필요한 경우에만 점 표기법 사용.

---

제어 및 디버깅

• 별도의 키 사용: 각 스크립트에 고유한 키를 생성해 디버깅을 용이하게 함.
• 소유자 지정: 스크립트별 소유자 또는 유지 관리자를 명시.
• 읽기 전용 권한 그룹 활용: 대부분의 스크립트는 읽기 권한만 필요하므로, 불필요한 변경을 방지.
• API 필드 이름 확인: UI 표시 이름과 API 필드 이름은 다를 수 있으므로 schema_read() 메서드 사용 권장.

---

설계 권장 사항

• API 래퍼 레이어 사용: API 변경에 대한 영향을 최소화하고 디버깅 및 감사 추적을 관리.
• 최신 API 버전 유지: 성능 향상과 버그 수정 적용.
• 스크립트 실행 환경 고려:
  • 렌더팜 등에서 반복 호출 시, 읽기 전용 캐싱 레이어로 중복 호출 최소화.
• 이벤트 생성 비활성화: 매우 빈번히 실행되는 스크립트는 이벤트 로그가 커질 수 있으므로 이벤트 생성을 비활성화 추천.

 

https://help.autodesk.com/view/SGDEV/ENU/?guid=SGD_py_python_api_best_practices_html

Help