Skip to content

Inspect form field data⚓︎

Once a PDF form is prepared, PyPDFForm can help you inspect its fields to determine the data needed to fill it. Several inspection methods are available to choose from.

This section of the documentation uses this PDF as an example.

Generate a JSON schema that describes a PDF form⚓︎

You can describe the dictionary used to fill a PDF form using a JSON schema. For example:

import json
from PyPDFForm import PdfWrapper

pdf_form_schema = PdfWrapper("sample_template.pdf").schema

print(json.dumps(pdf_form_schema, indent=4, sort_keys=True))

{
    "properties": {
        "check": {
            "type": "boolean"
        },
        "check_2": {
            "type": "boolean"
        },
        "check_3": {
            "type": "boolean"
        },
        "test": {
            "type": "string"
        },
        "test_2": {
            "type": "string"
        },
        "test_3": {
            "type": "string"
        }
    },
    "type": "object"
}

In this example, sample_template.pdf contains three text fields (test, test_2, and test_3) of type string and three checkboxes (check, check_2, and check_3) of type boolean.

You can use the PyPDFForm-generated JSON schema to validate the data used for filling a PDF form.

Inspect PDF form data⚓︎

To inspect the current filled data of a PDF form, use the .data attribute. For example, the following snippet inspects the current filled data for this PDF:

from pprint import pprint
from PyPDFForm import PdfWrapper

pprint(PdfWrapper("sample_template_filled.pdf").data)

{'check': True,
'check_2': True,
'check_3': True,
'test': 'test',
'test_2': 'test2',
'test_3': 'test3'}

Generate sample data⚓︎

PyPDFForm can also generate sample data for filling a PDF form:

from pprint import pprint
from PyPDFForm import PdfWrapper

pprint(PdfWrapper("sample_template.pdf").sample_data)

{'check': True,
'check_2': True,
'check_3': True,
'test': 'test',
'test_2': 'test_2',
'test_3': 'test_3'}