본문으로 건너뛰기

프로젝트 문서를 파일로 내보내기

선택한 저장 Flow·Report와 Function·Report 첨부파일을 내보냅니다.

문법

text
client.export_documents(output: 'str | os.PathLike', *, flows: dict | None = None, reports: dict | None = None) -> dict

예제

python
manifest = client.export_documents("./export", flows={"model.pxflow": flow}, reports={"note.pxreport": report})

규칙

대상 폴더는 없어야 하고 부모 폴더는 있어야 합니다. 읽기·검증 실패 시 임시 파일을 정리합니다. report는 이 Client가 소유한 저장 handle이어야 합니다. document-export.json에 파일별 target을 기록합니다. 외부 package는 pin만 기록하며 설치하지 않습니다. 전체 Project backup이나 .pxproject 실행 package가 아닙니다.

첨부파일은 본문 내부의 중첩 블록과 입력 attachment 레지스트리에서 함께 수집합니다. 입력으로 등록되지 않은 본문 PDF도 포함하며, 같은 콘텐츠는 한 번만 복사합니다. 콘텐츠 참조에 기록된 크기가 서로 다르거나 실제 바이트의 해시가 일치하지 않으면 내보내기를 거절합니다. 선택한 Report가 참조하는 보존된 분석·인용·번역과 그 부모인 정확한 분석·원본 PDF도 함께 포함합니다. 같은 Project에 보존돼 있어도 선택한 Report가 가리키지 않는 결과는 포함하지 않습니다. 일반 JSON 문자열에서 참조를 추측하지 않습니다.

보존 참조가 있으면 document-export.json은 V2이며 documentContents에 Report 파일별 Core 참조 집합을 기록합니다. 보존 참조가 없으면 기존 V1을 유지합니다. 구버전 SDK는 V2를 거절하므로 파생 참조를 무시한 채 불완전하게 가져오지 않습니다.

현재 Report 내보내기는 안정적인 principal의 단독 Desktop 로컬 문서 권한이 필요합니다. 권한을 해석할 수 없는 관리형·임시 principal 경로는 거절하며 파생 데이터를 생략한 결과를 반환하지 않습니다. Flow만 선택한 기존 내보내기에는 이 문서 권한을 요구하지 않습니다.

전이 참조의 저장 계약과 현재 제공 범위는 문서 처리 결과의 원본과 보존 참조를 따릅니다.

정확한 저장 경계는 SDK 문법을 따릅니다.

flows의 값에는 작성한 px.Flow와 저장된 px.FlowRef를 지정할 수 있습니다. FlowRef는 같은 Client Project의 정확한 revision만 읽으며, 반환 bytes의 digest를 확인합니다. Plan/Apply로 편집한 revision과 이전 revision을 각각 내보낼 수 있습니다.