PNG JPG BMP TIFF PDF
Aspose.PDF  for Python

通过 Python SDK 向 PDF 添加高亮文本注释

使用云 Python SDK 向 PDF 文档添加注释的 API。

Get Started

如何通过云 Python SDK 向 PDF 添加注释

为了在 PDF 中添加高亮文本注释,我们将使用 Aspose.PDF Cloud Python SDK。该云 SDK 帮助 Python 程序员使用 Python 编程语言通过 Aspose.PDF REST API 开发基于云的 PDF 创建、注释、编辑和转换应用程序。只需在 Aspose for Cloud 创建一个帐户并获取您的应用程序信息。一旦您拥有 App SID 和密钥,您就可以使用 Aspose.PDF Cloud Python SDK。如果 python 包托管在 Github 上,您可以直接从 Github 安装:

从 Github 安装


     
    pip install git+https://github.com/aspose-pdf-cloud/aspose-pdf-cloud-python.git

包管理器控制台命令

     
    pip install asposepdfcloud

通过 Python 添加注释到 PDF 的步骤

Aspose.PDF Cloud 开发人员可以仅用几行代码轻松加载并添加注释到 PDF。

  1. 安装 Python SDK
  2. 将 PDF 上传到云存储。
  3. 创建具有定义位置、颜色、文本和样式的新高亮注释。
  4. 使用 Aspose Cloud API 将注释发送到指定页面。
  5. 检查响应并记录结果。
  6. 下载更新后的文件以供本地使用。
 

使用 Python 向 PDF 添加注释


    from annotations_helper import Config, PdfAnnotationsHelper, logging
    from asposepdfcloud import PdfApi, HighlightAnnotation, Rectangle, Color, Point, AnnotationFlags, HorizontalAlignment, VerticalAlignment

    class PdfAddHighlightAnnotations:
        """Class for managing PDF annotations using Aspose PDF Cloud API."""
        def __init__(self, pdf_api: PdfApi, helper: PdfAnnotationsHelper):
            self.pdfApi = pdf_api
            self.helper = helper

        def append_highlight_annotation(self):
            """Append a new highlight text annotation to the PDF document."""
            if self.pdfApi:
                self.helper.uploadFile(Config.PDF_DOCUMENT_NAME, Config.LOCAL_FOLDER, Config.REMOTE_FOLDER)

                args = {
                    "folder": Config.REMOTE_FOLDER
                }

                new_annotation = HighlightAnnotation(
                    rect = Rectangle(llx=100, lly=350, urx=450, ury=400),
                    name = 'Highlight_Text_Annotation',
                    flags = [AnnotationFlags.DEFAULT],
                    horizontal_alignment = HorizontalAlignment.LEFT,
                    vertical_alignment = VerticalAlignment.TOP,
                    rich_text = Config.NEW_HL_ANNOTATION_TEXT,
                    subject = Config.NEW_HL_ANNOTATION_SUBJECT,
                    contents= Config.NEW_HL_ANNOTATION_CONTENTS,
                    title = Config.NEW_HL_ANNOTATION_DESCRIPTION,
                    z_index = 1,
                    color=Color(a=0xFF, r=0, g=0xFF, b=0),
                    quad_points = [
                        Point(10, 10),
                        Point(20, 10),
                        Point(10, 20),
                        Point(10, 10)
                    ],
                    modified = '03/27/2025 00:00:00.000 AM',
                )
                try:
                    response = self.pdfApi.post_page_highlight_annotations(Config.PDF_DOCUMENT_NAME, Config.PAGE_NUMBER, [new_annotation], **args)
                    if response.code == 200:
                        logging.info(f"append_highlight_annotation(): annotation '{Config.NEW_HL_ANNOTATION_TEXT}' added to the document '{Config.PDF_DOCUMENT_NAME}'.")
                        self.helper.downloadFile(Config.PDF_DOCUMENT_NAME, Config.LOCAL_RESULT_DOCUMENT_NAME, Config.LOCAL_FOLDER, Config.REMOTE_FOLDER, "add_highlight_")
                    else:
                        logging.error(f"append_highlight_annotation(): Failed to add annotation to the document. Response code: {response.code}")
                except Exception as e:
                    logging.error(f"append_highlight_annotation(): Error while adding annotation: {e}")