作為 Python 開發人員，您可以在雲上以編程方式註釋任何 Word(.doc 或 .docx)文件。您還可以使用 Python 從 Word 文件中提取或刪除所有註釋。註釋包括註釋、彈出窗口和文檔中提供附加信息的各種其他圖形對象。本文將重點介紹如何使用 Python 中的 REST API 從 DOCX 文件中提取或刪除註釋。
本文應涵蓋以下主題：
文檔註釋 REST API 和 Python SDK
為了從 DOC 或 DOCX 文件中提取或刪除註釋，我將使用 GroupDocs.Annotation Cloud 的 Python SDK API。它允許您以編程方式構建在線文檔和圖像註釋工具。此類工具可用於向所有流行格式的業務文檔添加註釋、水印疊加、文本替換、編輯、便籤和文本標記。它還為雲 API 提供 .NET、Java、PHP、Ruby 和 Node.js SDK 作為其 文檔註釋系列成員。
您可以在控制台中使用以下命令將 GroupDocs.Annotation Cloud 安裝到您的 Python 項目：
pip install groupdocs_annotation_cloud
在開始執行步驟和可用代碼示例之前，請從 dashboard 獲取您的 Client ID 和 Client Secret。獲得 ID 和密碼後，添加如下所示的代碼：
client_id = "da0c487d-c1c0-45ae-b7bf-43eaf53c5ad5"
client_secret = "479db2b01dcb93a3d4d20efb16dea971"
configuration = groupdocs_annotation_cloud.Configuration(client_id, client_secret)
configuration.api_base_url = "https://api.groupdocs.cloud"
在 Python 中使用 REST API 從 DOCX 文件中提取或刪除註釋
您可以按照下面提到的簡單步驟從 DOCX 文件中提取或刪除所有註釋：
- 上傳DOCX文件到雲端
- 在 Python 中從 DOCX 文件中提取註釋
- 在 Python 中從 DOCX 文件中刪除註釋
- 下載更新文件
上傳文件
首先，使用下面給出的代碼示例將 DOCX 文件上傳到雲端：
# 接口實例
file_api = groupdocs_annotation_cloud.FileApi.from_config(configuration)
# 上傳文件
request = groupdocs_annotation_cloud.UploadFileRequest("input.docx", "C:\\Files\\input.docx", my_storage)
response = file_api.upload_file(request)
因此，上傳的 DOCX 文件 (input.docx) 將在雲端儀表板的 文件部分 中可用。
在 Python 中從 DOCX 文件中提取註釋
請按照下面提到的步驟以編程方式從 Word 文檔中提取註釋。
- 創建 AnnotateApi 實例
- 創建一個 FileInfo 實例
- 設置文件路徑
- 通過調用 ExtractRequest 方法創建請求
- 調用AnnotateApi.extract()方法獲取結果
以下代碼片段顯示瞭如何使用 REST API 從 Word 文檔中提取註釋。
# 接口實例
api = groupdocs_annotation_cloud.AnnotateApi.from_config(configuration)
# 輸入文件詳細信息
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "input.docx"
# 提取註解請求
request = groupdocs_annotation_cloud.ExtractRequest(file_info)
result = api.extract(request)
print("ExtractAnnotations: annotations count: " + str(len(result)))
上面的代碼示例將以 JSON 格式返回所有註釋的數組，如下所示：
使用 Python 從 DOCX 文件中提取註釋
在 Python 中從 DOCX 文件中刪除註釋
請按照下面提到的步驟以編程方式從 Word 文檔中刪除註釋。
- 創建 AnnotateApi 實例
- 創建一個 FileInfo 實例
- 設置文件路徑
- 定義刪除選項
- 將文件信息設置為 AnnotateOptions
- 提供要刪除的註解 ID
- 設置輸出文件路徑
- 通過調用 RemoveAnnotationsRequest 方法創建請求
- 調用AnnotateApi.remove\annotations()方法獲取結果
以下代碼片段顯示瞭如何使用 REST API 從 Word 文檔中刪除註釋。您需要提及需要從文檔中刪除的註釋 ID。
# 接口實例
api = groupdocs_annotation_cloud.AnnotateApi.from_keys(client_id, client_secret)
# 輸入文件詳細信息
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "input.docx"
# 刪除選項
options = groupdocs_annotation_cloud.RemoveOptions()
options.file_info = file_info
options.annotation_ids = [0,1,2,3,4,5,6,7,8,9,10,11]
# 輸出文件
options.output_path = "output.docx"
# 刪除請求
request = groupdocs_annotation_cloud.RemoveAnnotationsRequest(options)
result = api.remove_annotations(request)
print("RemoveAnnotations: Annotations removed: " + result['href'])
使用 Python 從 DOCX 文件中刪除註釋
下載輸出文件
上面的代碼示例將在雲端刪除註釋後保存輸出的 DOCX 文件(output.docx)。您可以使用以下代碼示例下載它：
# 接口實例
file_api = groupdocs_annotation_cloud.FileApi.from_config(configuration)
# 下載文件請求
request = groupdocs_annotation_cloud.DownloadFileRequest("output.docx", my_storage)
response = file_api.download_file(request)
# 將下載的文件移動到您的工作目錄
shutil.move(response, "C:\\Files\\")
在線試用
請試用以下使用上述API開發的免費在線DOCX標註工具。 https://products.groupdocs.app/annotation/docx
結論
在本文中，您學習瞭如何使用 Python 從雲端的 Word 文檔中提取或刪除批註。您還學習瞭如何以編程方式將 DOCX 文件上傳到雲端以及從雲端下載文件。您可以使用 文檔 了解有關 GroupDocs.Annotation Cloud API 的更多信息。我們還提供了一個 API 參考 部分，讓您可以直接通過瀏覽器可視化我們的 API 並與之交互。如有任何歧義，請隨時在論壇上與我們聯繫。