Update PDF Forms in Python SDK
Update all of the form fields from a PDF Document using Python Cloud SDK
Get StartedHow to update an AcroForms via Python SDK
The provided Python code is designed to update form fields in a PDF document using the Aspose PDF Cloud API. It imports necessary modules, reads a local PDF file, uploads it to the cloud, and then updates specific fields in the PDF. The function updateFormFields encapsulates the entire process, handling both file operations and API interactions. It also includes error handling to manage potential issues during file reading and API requests.
In order to update an AcroForm to PDF, we’ll use Aspose.PDF Cloud Python SDK. This Cloud SDK assists Python programmers in developing cloud-based PDF creator, annotator, editor, and converter apps using Python programming language via Aspose.PDF REST API. Simply create an account at Aspose for Cloud and get your application information. Once you have the App SID & key, you are ready to give the Aspose.PDF Cloud Python SDK.
Installation from Github
pip install git+https://github.com/aspose-pdf-cloud/aspose-pdf-cloud-python.git
Package Manager Console Command
pip install asposepdfcloud
Steps to update AcroForms via Cloud Python
Aspose.PDF Cloud developers can easily load & update acroforms in PDF in just a few lines of code.
Reads PDF file from local path.
Upload the PDF file to the Aspose.PDF Cloud storage.
Creates a new form field with the name from “fieldName” parameter and sets its value to “aspose-pdf-cloud@example.com” value.
Updates the form fields in the PDF file on the Aspose.PDF Cloud storage.
Download the result if needed it
Download the result if needed it
This sample code shows updating an AcroForms in PDF documents using Python
import os
import logging
from pathlib import Path
from asposepdfcloud import PdfApi, Field, Fields, FieldType, Rectangle
# Configure logging
logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
class PdfAcroforms:
def __init__():
"""Initialize the API client."""
credentials_file = Path(r"..\credentials.json")
with credentials_file.open("r", encoding="utf-8") as file:
credentials = json.load(file)
api_key, app_id = credentials.get("key"), credentials.get("id")
self.pdf_api = PdfApi(ApiClient(api_key, app_id))
def updateField(self, documentName: str, outputDocumentName: str, fieldName: str, localFolder: Path, remoteFolder: str):
""" Upload a local fileName to the Aspose Cloud server. """
file_path = localFolder / documentName
self.pdf_api.upload_file(os.path.join(remoteFolder, fileName), file_path)
field = Field(
name=fieldName,
type=FieldType.TEXT,
values=["aspose-pdf-cloud@example.com"],
rect= Rectangle( llx=125, lly=735, urx=200, ury=752),
)
fields = Fields(list=[field])
try:
response = self.pdf_api.put_update_fields(documentName, fields, folder=remoteFolder)
if response.code == 200:
logging.info(f"PdfAcroformsUpdate(): Form filed '{fieldName}' successfully updated in the document.")
"""Download the processed PDF document from the Aspose Cloud server."""
temp_file = self.pdf_api.download_file(str(remoteFolder) + '/' + documentName)
local_path = localFolder / outputDocumentName
shutil.move(temp_file, str(local_path))
else:
logging.error(f"PdfAcroformsAdd(): Failed to add filed 'Email' to the page #1. Response code: {response.code}")
except Exception as e:
logging.error(f"PdfAcroforms(): Error while adding form field: {e}")
Work with the AcroForms via Python SDK
Updating AcroForms in a PDF involves modifying or enhancing existing interactive form fields. Improve field alignment, add tooltips, or adjust tab orders to make the form more intuitive and easier to use. Include additional fields such as checkboxes, dropdowns, or digital signature areas to accommodate new data collection needs. Update AcroForms to comply with accessibility standards, such as adding labels or improving compatibility with assistive technologies. Update AcroForms to ensure compatibility with modern devices, browsers, or software tools. Update the AcroForms into PDF documents with Aspose.PDF Cloud Python SDK.
With our Python library you can
- Add PDF document’s header & footer in text or image format.
- Add tables & stamps (text or image) to PDF documents.
- Append multiple PDF documents to an existing file.
- Work with PDF attachments, annotations, & form fields.
- Apply encryption or decryption to PDF documents & set a password.
- Delete all stamps & tables from a page or entire PDF document.
- Delete a specific stamp or table from the PDF document by its ID.
- Replace single or multiple instances of text on a PDF page or from the entire document.
- Extensive support for converting PDF documents to various other file formats.
- Extract various elements of PDF files & make PDF documents optimized.
- You can try out our free App to update the AcroForms into PDF files online and test the functionality.
- Learning Resources
- Documentation
- Source Code
- API References
- Product Support
- Free Support
- Paid Support
- Blog
- Why Aspose.PDF Cloud for Python?
- Customers List
- Security