PyPDFForm Documentation

CLI tests follow a four-step pattern:

1. Define the expected PDF file.
2. Write input data (e.g., YAML) to tmp_path.
3. Invoke the CLI command using typer.testing.CliRunner.
4. Compare the generated PDF with the expected file.

Key requirements:

• Mark tests with @pytest.mark.cli_test.
• Use CliRunner from typer.testing.
• Import cli_app from PyPDFForm.cli.root.

Example implementation:

@pytest.mark.cli_test
def test_fill(pdf_samples, tmp_path):
    expected_path = os.path.join(pdf_samples, "docs", "test_fill_text_check.pdf")
    input_path = os.path.join(tmp_path, "input.yaml")
    output_path = os.path.join(tmp_path, "output.pdf")
    fill_data = {
        "test": "test_1",
        "check": True,
        "test_2": "test_2",
        "check_2": False,
        "test_3": "test_3",
        "check_3": True,
    }

    with open(input_path, "w") as f:
        yaml.safe_dump(fill_data, f)

    result = runner.invoke(
        cli_app,
        [
            "fill",
            os.path.join(pdf_samples, "sample_template.pdf"),
            "-f",
            input_path,
            "-o",
            output_path,
        ],
    )
    assert result.exit_code == 0

    with open(expected_path, "rb") as f1, open(output_path, "rb") as f2:
        expected = f1.read()
        actual = f2.read()

        assert len(expected) == len(actual)
        assert expected == actual

Library tests typically follow a three-step pattern:

1. Define the expected PDF file.
2. Use PdfWrapper to generate a PDF from test inputs.
3. Compare the generated PDF with the expected file.

To make expected PDF regeneration easier, include these lines in your tests to attach the expected path and stream to the pytest request object:

request.config.results["expected_path"] = expected_path
request.config.results["stream"] = obj.read()

Example implementation:

def test_fill(pdf_samples, request):
    expected_path = os.path.join(pdf_samples, "sample_filled.pdf")
    with open(expected_path, "rb+") as f:
        obj = PdfWrapper(os.path.join(pdf_samples, "sample_template.pdf")).fill(
            {
                "test": "test_1",
                "check": True,
                "test_2": "test_2",
                "check_2": False,
                "test_3": "test_3",
                "check_3": True,
            },
        )

        request.config.results["expected_path"] = expected_path
        request.config.results["stream"] = obj.read()

        expected = f.read()

        assert len(obj.read()) == len(expected)
        assert obj.read() == expected

You can use PyPDFForm as a Python library to create, style, fill, and save PDF forms. The workflow typically involves creating a PdfWrapper with a BlankPage, drawing raw elements (like labels) using RawElements, creating form fields using Fields, inspecting the schema, styling widgets via the widgets dictionary, filling the form with data, and finally writing to a file.

from pprint import pprint
from PyPDFForm import BlankPage, Fields, PdfWrapper, RawElements

# Create a blank PDF
pdf = PdfWrapper(BlankPage())

# Draw labeling texts
pdf.draw(
    [
        RawElements.RawText("My Textfield:", 1, 100, 600),
        RawElements.RawText("My Checkbox:", 1, 100, 550),
    ]
)

# Create text and checkbox fields
pdf.bulk_create_fields(
    [
        Fields.TextField("my_textfield", 1, 180, 596, height=16),
        Fields.CheckBoxField("my_checkbox", 1, 180, 546, size=16),
    ]
)

# Inspect the fields via JSON schema
pprint(pdf.schema)

# Change the field styles
pdf.widgets["my_textfield"].font_color = (1, 0, 0)
pdf.widgets["my_textfield"].alignment = 1

# Fill the newly created form
pdf.fill(
    {
        "my_textfield": "this is a text field",
        "my_checkbox": True,
    }
)

# Save the new form
pdf.write("output.pdf")