본문으로 건너뛰기

저장된 Report를 PDF로 내보내기

용도

report.export_pdf(...)는 저장된 Report revision을 Runtime이 조판해 지정한 경로에 PDF 파일로 씁니다. 화면 페이지 계획과 같은 layout engine 호출이므로 plan과 PDF가 어긋나지 않습니다.

문법

python
report.export_pdf(path: str | os.PathLike, page_setup: dict | None = None, on_existing: str = "refuse") -> PdfExport

예제

python
report.save()
written = report.export_pdf("girder-review.pdf")
written.page_count

매개변수

  • path — PDF가 놓일 파일 경로. 상대 경로는 호출한 프로세스 기준으로 절대화됩니다.
  • page_setupreport.plan_pages(...)와 같은 페이지 상자 dict. 생략하면 이 Report에 저장된 설정 snapshot의 page_setup을 사용합니다.
  • on_existing — 경로에 파일이 이미 있을 때의 처리. "refuse"(기본)는 기존 파일을 지키고 이름 있는 거부를 돌려주며, "replace"는 덮어씁니다.

반환

PdfExport 객체를 반환합니다. Runtime이 실제로 쓴 파일의 written.path, written.byte_length, written.sha256, written.page_count를 읽고, wire 그대로가 필요하면 written.to_dict()를 사용합니다. PdfExport는 Runtime 응답으로만 만들어지는 output-only 값이므로 직접 생성할 수 없습니다.

규칙

  • 저장된 revision만 내보낼 수 있습니다. report.save() 전에 부르면 이름 있는 거부를 돌려받습니다.
  • PDF 바이트는 SDK로 전달되지 않습니다. 파일은 Runtime이 직접 쓰고, SDK는 그 결과 기록만 받습니다.
  • 덮어쓰기 판단은 Runtime이 내립니다. "refuse" 상태에서 파일이 있으면 ReportPdfDestinationExists로 거부됩니다.