본문으로 건너뛰기

Report에 section 추가하기

용도

report.section(...)report = px.Report(...)로 만든 Report 객체의 메서드입니다. 관련 text, 값, 표와 result 위치를 제목 아래에 묶는 section을 추가합니다.

Report Workbench에서 보이는 것

Report Workbench의 Add section과 같은 작업입니다. section은 본문 순서에 표시되며 이후 추가하는 block의 부모가 됩니다.

문법

python
report.section(section_key, title=...)

예제

python
from pipelinexlab import px


report = px.Report("girder_report", title="Girder review")

basis = report.section(
    "design_basis",
    title="Design basis",
)

매개변수

이름설명
section_keyReport 안에서 section을 계속 찾는 lower_snake_case 고유 key
titleReport Workbench에 표시할 section 제목

반환

text, value, table, attachment, result_slot, result_table, artifact_slot을 추가할 section handle을 반환합니다.

규칙

  • section_key는 같은 Report 안에서 유일하게 정합니다.
  • section 순서는 Report에 보이는 순서만 정하며 Flow 실행 순서는 바꾸지 않습니다.
  • section과 하위 block은 report.save()에서 같은 .pxreport revision에 저장됩니다.
  • section 추가는 계산 Run을 시작하지 않습니다.

다음 단계