HTML JPG PDF XML DOCX
  Product Family
PDF

在 Python SDK 中向 PDF 添加附件

使用 Aspose.PDF Cloud Python SDK 向 PDF 文档中添加附件的 API

Get Started

如何使用 Cloud Python SDK 在 PDF 文档中附加附件

为了处理 PDF 文档中的附件,我们将使用 Aspose.PDF Cloud Python SDK 该 Cloud 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 SDK 添加附件的步骤

Aspose.PDF Cloud Python 开发人员可以轻松在 PDF 文档中附加附件。开发人员只需几行代码。

  1. 从 JSON 文件加载您的应用程序秘密和密钥或以其他方式设置凭据
  2. 创建一个对象以连接到 Cloud API
  3. 设置文档文件的名称和路径
  4. 执行附加附件的操作
  5. 如果成功,修改后的 PDF 将被下载并保存到指定文件
  6. 如果在过程中发生任何错误,将被捕获并打印
 

此示例代码显示如何使用 PDF Cloud Python SDK 向 PDF 文档附加文件


    import shutil
    import json
    import logging
    from pathlib import Path
    from asposepdfcloud import ApiClient, PdfApi, AttachmentInfo

    # Configure logging
    logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")


    class Config:
        """Configuration parameters."""
        CREDENTIALS_FILE = Path(r"C:\\Projects\\ASPOSE\\Pdf.Cloud\\Credentials\\credentials.json")
        LOCAL_FOLDER = Path(r"C:\Samples")
        PDF_DOCUMENT_NAME = "sample.pdf"
        LOCAL_RESULT_DOCUMENT_NAME = "output_sample.pdf"
        NEW_ATTACHMENT_FILE = "sample_video.mp4"
        NEW_ATTACHMENT_MIME = "video/mp4"
        PAGE_NUMBER = 2

    class PdfAttachments:
        """Class for managing PDF attachments using Aspose PDF Cloud API."""
        def __init__(self, credentials_file: Path = Config.CREDENTIALS_FILE):
            self.pdf_api = None
            self._init_api(credentials_file)

        def _init_api(self, credentials_file: Path):
            """Initialize the API client."""
            try:
                with credentials_file.open("r", encoding="utf-8") as file:
                    credentials = json.load(file)
                    api_key, app_id = credentials.get("key"), credentials.get("id")
                    if not api_key or not app_id:
                        raise ValueError("init_api(): Error: Missing API keys in the credentials file.")
                    self.pdf_api = PdfApi(ApiClient(api_key, app_id))
            except (FileNotFoundError, json.JSONDecodeError, ValueError) as e:
                logging.error(f"init_api(): Failed to load credentials: {e}")

        def upload_file(self, fileName: str):
            """ Upload a local fileName to the Aspose Cloud server. """
            if self.pdf_api:
                file_path = Config.LOCAL_FOLDER / fileName
                try:
                    self.pdf_api.upload_file(fileName, str(file_path))
                    logging.info(f"upload_file(): File '{fileName}' uploaded successfully.")
                except Exception as e:
                    logging.error(f"upload_document(): Failed to upload file: {e}")

        def upload_document(self):
            """ Upload a PDF document to the Aspose Cloud server. """
            self.upload_file(Config.PDF_DOCUMENT_NAME)

        def download_result(self):
            """ Download the processed PDF document from the Aspose Cloud server. """
            if self.pdf_api:
                try:
                    temp_file = self.pdf_api.download_file(Config.PDF_DOCUMENT_NAME)
                    local_path = Config.LOCAL_FOLDER / Config.LOCAL_RESULT_DOCUMENT_NAME
                    shutil.move(temp_file, str(local_path))
                    logging.info(f"download_result(): File successfully downloaded: {local_path}")
                except Exception as e:
                    logging.error(f"download_result(): Failed to download file: {e}")

        def append_attachmnet(self):
            """Append a new attachment to the PDF document."""
            if self.pdf_api:
                new_attachment = AttachmentInfo(
                    path = Config.NEW_ATTACHMENT_FILE,
                    description = 'This is a sample attachment',
                    mime_type = Config.NEW_ATTACHMENT_MIME,
                    name = Config.NEW_ATTACHMENT_FILE
                )

                try:
                    response = self.pdf_api.post_add_document_attachment(Config.PDF_DOCUMENT_NAME, new_attachment)
                    if response.code == 200:
                        logging.info(f"append_attachment(): attachment '{Config.NEW_ATTACHMENT_FILE}' added to the document '{Config.PDF_DOCUMENT_NAME}'.")
                    else:
                        logging.error(f"append_attachment(): Failed to add attachment to the document. Response code: {response.code}")
                except Exception as e:
                    logging.error(f"append_attachment(): Error while adding attachment: {e}")


    if __name__ == "__main__":
        pdf_attachments = PdfAttachments()
        pdf_attachments.upload_document()
        pdf_attachments.upload_file(Config.NEW_ATTACHMENT_FILE)
        pdf_attachments.append_attachmnet()
        pdf_attachments.download_result()