Pdf

sereto.pdf

find_and_generate_pdf_finding_group(project, target_selector, finding_group_selector, converter, renderer, version)

Generate a finding group PDF from given target and finding group selectors.

Parameters:

Name	Type	Description	Default
project	Project	Project's representation.	required
target_selector	int | str | None	The target selector (1-based index or unique name). If None, the only target is selected.	required
finding_group_selector	int | str | None	The finding group selector (1-based index or unique name). If None, the only finding group is selected.	required
converter	str | None	The convert recipe used for file format transformations. If None, the first recipe is used.	required
renderer	str | None	The recipe used for generating the finding group. If None, the first recipe is used.	required
version	ProjectVersion | None	The version of the project to use. If None, the last version is used.	required

Returns:

Type	Description
FilePath	Path to the generated finding group PDF.

Source code in sereto/pdf.py

@validate_call
def find_and_generate_pdf_finding_group(
    project: Project,
    target_selector: int | str | None,
    finding_group_selector: int | str | None,
    converter: str | None,
    renderer: str | None,
    version: ProjectVersion | None,
) -> FilePath:
    """Generate a finding group PDF from given target and finding group selectors.

    Args:
        project: Project's representation.
        target_selector: The target selector (1-based index or unique name). If None, the only target is selected.
        finding_group_selector: The finding group selector (1-based index or unique name). If None, the only finding
            group is selected.
        converter: The convert recipe used for file format transformations. If None, the first recipe is used.
        renderer: The recipe used for generating the finding group. If None, the first recipe is used.
        version: The version of the project to use. If None, the last version is used.

    Returns:
        Path to the generated finding group PDF.
    """
    if version is None:
        version = project.config.last_version

    # Select target and finding group
    target = project.config.at_version(version).select_target(
        categories=project.settings.categories, selector=target_selector
    )
    fg = target.findings.select_group(selector=finding_group_selector)

    # Create missing objects
    project_create_missing(project=project, version_config=project.config.at_version(version))

    return generate_pdf_finding_group(
        project=project,
        target=target,
        fg=fg,
        converter=converter,
        renderer=renderer,
        version=version,
    )

generate_all_pdf_finding_groups(project, converter, renderer, version)

Generate all finding group PDFs.

Parameters:

Name	Type	Description	Default
project	Project	Project's representation.	required
converter	str | None	The convert recipe used for file format transformations. If None, the first recipe is used.	required
renderer	str | None	The recipe used for generating the finding group. If None, the first recipe is used.	required
version	ProjectVersion | None	The version of the project to use. If None, the last version is used.	required

Returns:

Type	Description
list[FilePath]	List of paths to the generated finding group PDFs.

Source code in sereto/pdf.py

@validate_call
def generate_all_pdf_finding_groups(
    project: Project,
    converter: str | None,
    renderer: str | None,
    version: ProjectVersion | None,
) -> list[FilePath]:
    """Generate all finding group PDFs.

    Args:
        project: Project's representation.
        converter: The convert recipe used for file format transformations. If None, the first recipe is used.
        renderer: The recipe used for generating the finding group. If None, the first recipe is used.
        version: The version of the project to use. If None, the last version is used.

    Returns:
        List of paths to the generated finding group PDFs.
    """
    if version is None:
        version = project.config.last_version

    # Create missing objects
    project_create_missing(project=project, version_config=project.config.at_version(version))

    return [
        generate_pdf_finding_group(
            project=project,
            target=target,
            fg=fg,
            converter=converter,
            renderer=renderer,
            version=version,
        )
        for target in project.config.at_version(version).targets
        for fg in target.findings.groups
    ]

generate_pdf_finding_group(project, target, fg, converter, renderer, version)

Generate a finding group PDF.

You should call project_create_missing before calling this function.

Parameters:

Name	Type	Description	Default
project	Project	Project's representation.	required
target	Target	The target containing the finding group.	required
fg	FindingGroup	The finding group to generate.	required
converter	str | None	The convert recipe used for file format transformations. If None, the first recipe is used.	required
renderer	str | None	The recipe used for generating the finding group. If None, the first recipe is used.	required
version	ProjectVersion	The version of the project to use.	required

Returns:

Type	Description
FilePath	Path to the generated finding group PDF.

Source code in sereto/pdf.py

@validate_call
def generate_pdf_finding_group(
    project: Project,
    target: Target,
    fg: FindingGroup,
    converter: str | None,
    renderer: str | None,
    version: ProjectVersion,
) -> FilePath:
    """Generate a finding group PDF.

    You should call `project_create_missing` before calling this function.

    Args:
        project: Project's representation.
        target: The target containing the finding group.
        fg: The finding group to generate.
        converter: The convert recipe used for file format transformations. If None, the first recipe is used.
        renderer: The recipe used for generating the finding group. If None, the first recipe is used.
        version: The version of the project to use.

    Returns:
        Path to the generated finding group PDF.
    """
    Console().log(f"Rendering partial report for finding group {fg.uname!r}")

    # Build finding group to TeX
    build_finding_group_dependencies(
        project=project, target=target, finding_group=fg, version=version, converter=converter
    )
    finding_group_tex = build_finding_group_to_tex(project=project, target=target, finding_group=fg, version=version)

    # Render PDF
    recipe = project.settings.render.get_finding_group_recipe(name=renderer)
    finding_group_pdf = render_tex_to_pdf(
        file=finding_group_tex,
        templates=project.settings.templates_path,
        render=project.settings.render,
        recipe=recipe,
    )

    # Move the finding group PDF to the "pdf" directory
    pdf_dir = project.ensure_dir("pdf")
    return finding_group_pdf.replace(pdf_dir / f"{target.uname}_{finding_group_pdf.name}")

generate_pdf_report(project, template, report_recipe=None, convert_recipe=None, version=None)

Generate a report PDF.

Parameters:

Name	Type	Description	Default
project	Project	Project's representation.	required
template	str	The template used for generating the report.	required
report_recipe	str | None	The recipe used for generating the report. If None, the first recipe is used.	None
convert_recipe	str | None	The convert recipe used for file format transformations. If None, the first recipe is used.	None
version	ProjectVersion | None	The version of the project to use. If None, the last version	None

Returns:

Type	Description
Path	Path to the generated report PDF.

Source code in sereto/pdf.py

@validate_call
def generate_pdf_report(
    project: Project,
    template: str,
    report_recipe: str | None = None,
    convert_recipe: str | None = None,
    version: ProjectVersion | None = None,
) -> Path:
    """Generate a report PDF.

    Args:
        project: Project's representation.
        template: The template used for generating the report.
        report_recipe: The recipe used for generating the report. If None, the first recipe is used.
        convert_recipe: The convert recipe used for file format transformations. If None, the first recipe is used.
        version: The version of the project to use. If None, the last version

    Returns:
        Path to the generated report PDF.
    """
    if version is None:
        version = project.config.last_version

    Console().log(f"Rendering report version: '{version}'")

    project_create_missing(project=project, version_config=project.config.at_version(version))

    # Build report to TeX
    report_tex = build_report_to_tex(project=project, template=template, version=version, converter=convert_recipe)

    # Render PDF
    recipe = project.settings.render.get_report_recipe(name=report_recipe)
    report_pdf = render_tex_to_pdf(
        file=report_tex, templates=project.settings.templates_path, render=project.settings.render, recipe=recipe
    )

    # Create directory for the PDF results if it does not exist
    if not (pdf_dir := project.path / "pdf").is_dir():
        pdf_dir.mkdir()

    # Move the report PDF to the "pdf" directory
    version_config = project.config.at_version(version) if version else project.config.last_config
    report_pdf = report_pdf.rename(project.path / "pdf" / version_config.report_name)

    return report_pdf

generate_pdf_sow(project, sow_recipe, version)

Generate a Statement of Work (SoW) PDF.

Parameters:

Name	Type	Description	Default
project	Project	Project's representation.	required
sow_recipe	str | None	The recipe used for generating the SoW. If None, the first recipe is used.	required
version	ProjectVersion | None	The version of the project to use. If None, the last version	required

Returns:

Type	Description
Path	Path to the generated Statement of Work (SoW) PDF.

Source code in sereto/pdf.py

@validate_call
def generate_pdf_sow(project: Project, sow_recipe: str | None, version: ProjectVersion | None) -> Path:
    """Generate a Statement of Work (SoW) PDF.

    Args:
        project: Project's representation.
        sow_recipe: The recipe used for generating the SoW. If None, the first recipe is used.
        version: The version of the project to use. If None, the last version

    Returns:
        Path to the generated Statement of Work (SoW) PDF.
    """
    if version is None:
        version = project.config.last_version

    Console().log(f"Rendering SoW version: '{version}'")

    project_create_missing(project=project, version_config=project.config.at_version(version))

    # Build SoW to TeX
    sow_tex = build_sow_to_tex(project=project, version=version)

    # Render PDF
    recipe = project.settings.render.get_sow_recipe(name=sow_recipe)
    sow_pdf = render_tex_to_pdf(
        file=sow_tex, templates=project.settings.templates_path, render=project.settings.render, recipe=recipe
    )

    # Create directory for the PDF results if it does not exist
    if not (pdf_dir := project.path / "pdf").is_dir():
        pdf_dir.mkdir()

    # Move the SoW PDF to the "pdf" directory
    version_config = project.config.at_version(version) if version else project.config.last_config
    sow_pdf = sow_pdf.rename(project.path / "pdf" / version_config.sow_name)

    return sow_pdf

generate_pdf_target(project, target_selector, target_recipe, convert_recipe, version)

Generate a target PDF.

Parameters:

Name	Type	Description	Default
project	Project	Project's representation.	required
target_selector	int | str | None	The target selector (1-based index or unique name). If None, the only target is selected.	required
target_recipe	str | None	The recipe used for generating the target. If None, the first recipe is used.	required
convert_recipe	str | None	The convert recipe used for file format transformations. If None, the first recipe is used.	required
version	ProjectVersion | None	The version of the project to use. If None, the last version	required

Returns:

Type	Description
Path	Path to the generated target PDF.

Source code in sereto/pdf.py

@validate_call
def generate_pdf_target(
    project: Project,
    target_selector: int | str | None,
    target_recipe: str | None,
    convert_recipe: str | None,
    version: ProjectVersion | None,
) -> Path:
    """Generate a target PDF.

    Args:
        project: Project's representation.
        target_selector: The target selector (1-based index or unique name). If None, the only target is selected.
        target_recipe: The recipe used for generating the target. If None, the first recipe is used.
        convert_recipe: The convert recipe used for file format transformations. If None, the first recipe is used.
        version: The version of the project to use. If None, the last version

    Returns:
        Path to the generated target PDF.
    """
    if version is None:
        version = project.config.last_version

    # Select target
    target = project.config.last_config.select_target(categories=project.settings.categories, selector=target_selector)

    Console().log(f"Rendering partial report for target '{target.uname}'")

    project_create_missing(project=project, version_config=project.config.at_version(version))

    # Build target to TeX
    build_target_dependencies(project=project, target=target, version=version, converter=convert_recipe)
    target_tex = build_target_to_tex(project=project, target=target, version=version)

    # Render PDF
    recipe = project.settings.render.get_target_recipe(name=target_recipe)
    target_pdf = render_tex_to_pdf(
        file=target_tex, templates=project.settings.templates_path, render=project.settings.render, recipe=recipe
    )

    # Create directory for the PDF results if it does not exist
    if not (pdf_dir := project.path / "pdf").is_dir():
        pdf_dir.mkdir()

    # Move the target PDF to the "pdf" directory
    target_pdf = target_pdf.rename(project.path / "pdf" / target_pdf.name)

    return target_pdf