Als Python-Entwickler können Sie jede Word-Datei (.doc oder .docx) programmgesteuert in der Cloud mit Anmerkungen versehen. Bei Anmerkungen handelt es sich in der Regel um Metadaten in Form von Kommentaren, Notizen, Erklärungen oder anderen Arten von externen Anmerkungen im Dokument, die zusätzliche Informationen zu einem vorhandenen Datenelement bereitstellen. Dieser Artikel konzentriert sich auf das Annotieren von DOCX Dateien mithilfe einer REST-API in Python.
Die folgenden Themen sollen in diesem Artikel behandelt werden:
- Document Annotation REST API und Python SDK
- Kommentieren Sie DOCX Dateien mithilfe einer REST-API
- Fügen Sie mehrere Anmerkungen mit Python hinzu
Document Annotation REST API und Python SDK
Zum Kommentieren von DOC oder DOCX Dokumenten verwende ich die Python SDK of GroupDocs.Annotation Cloud API. Es ermöglicht Ihnen, programmgesteuert Online-Tools für Dokument und Bildanmerkungen zu erstellen. Solche Tools können zum Hinzufügen von Anmerkungen, Wasserzeichenüberlagerungen, Textersetzungen, Schwärzungen, Haftnotizen und Textmarkierungen zu Geschäftsdokumenten aller gängigen Formate verwendet werden. Es stellt außerdem .NET-, Java-, PHP-, Ruby und Node.js-SDKs als Mitglieder der Dokumentanmerkungsfamilie für die Cloud-API bereit.
Sie können GroupDocs.Annotation Cloud mit dem folgenden Befehl in der Konsole in Ihrem Python-Projekt installieren:
pip install groupdocs_annotation_cloud
Bitte rufen Sie Ihre Client-ID und Ihr Client-Geheimnis vom Dashboard ab, bevor Sie mit dem Befolgen der Schritte und verfügbaren Codebeispiele beginnen. Fügen Sie Ihre ID und Ihr Geheimnis wie unten gezeigt in den Code ein:
client_id = "112f0f38-9dae-42d5-b4fc-cc84ae644972"
client_secret = "16ad3fe0bdc39c910f57d2fd48a5d618"
my_storage = ""
configurations = groupdocs_annotation_cloud.Configuration(client_id, client_secret)
configurations.api_base_url = "https://api.groupdocs.cloud"
Kommentieren Sie DOCX Dateien mithilfe einer REST-API in Python
Sie können der DOCX-Datei Anmerkungen hinzufügen, indem Sie die folgenden einfachen Schritte ausführen:
- Hochladen der DOCX-Datei in die Cloud
- Anmerkungen zu DOCX Dateien in Python hinzufügen
- Laden Sie die aktualisierte Datei herunter
Laden Sie das Dokument hoch
Laden Sie zunächst die DOCX-Datei mithilfe des folgenden Codebeispiels in die Cloud hoch:
# Erstellen Sie eine Instanz der API
file_api = groupdocs_annotation_cloud.FileApi.from_config(configurations)
request = groupdocs_annotation_cloud.UploadFileRequest("one-page.docx", "C:\\Files\\one-page.docx", my_storage)
response = file_api.upload_file(request)
Dadurch ist die hochgeladene DOCX-Datei im Dateienbereich Ihres Dashboards in der Cloud verfügbar.
Fügen Sie Anmerkungen zu DOCX Dateien in Python hinzu
Bitte befolgen Sie die unten aufgeführten Schritte, um Anmerkungen programmgesteuert in das Word Dokument einzufügen.
- Erstellen Sie eine Instanz von AnnotationInfo
- Legen Sie verschiedene Anmerkungseigenschaften fest, z. B. Position, Typ, Text usw.
- Erstellen Sie eine FileInfo-Instanz
- Legen Sie den Dateipfad fest
- Erstellen Sie eine Instanz von AnnotateOptions
- Legen Sie die Dateiinformationen auf „AnnotateOptions“ fest
- Annotation auf AnnotateOptions setzen
- Erstellen Sie eine Anfrage, indem Sie die AnnotateRequest-Methode aufrufen
- Erhalten Sie Ergebnisse, indem Sie die Methode AnnotateApi.annotate() aufrufen
Der folgende Codeausschnitt zeigt, wie Sie mithilfe einer REST-API Bereichsanmerkungen in das Word Dokument einfügen.
api = groupdocs_annotation_cloud.AnnotateApi.from_keys(client_id, client_secret)
a1 = groupdocs_annotation_cloud.AnnotationInfo()
a1.annotation_position = groupdocs_annotation_cloud.Point()
a1.annotation_position.x = 1
a1.annotation_position.y = 1
a1.box = groupdocs_annotation_cloud.Rectangle()
a1.box.x = 100
a1.box.y = 100
a1.box.width = 200
a1.box.height = 100
a1.page_number = 0
a1.pen_color = 1201033
a1.pen_style = "Solid"
a1.pen_width = 1
a1.opacity = 0.7
# Bereichsanmerkung hinzufügen
a1.type = "Area"
a1.text = "This is area annotation"
a1.creator_name = "Anonym A."
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "one-page.docx"
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1]
options.output_path = "Output\\output.docx"
request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)
Dadurch werden die Bereichsanmerkungen wie unten gezeigt in das Dokument eingefügt.
Unterstützte Anmerkungstypen
Nachfolgend finden Sie die Liste der unterstützten Anmerkungstypen, die Sie Ihren DOCX Dateien hinzufügen können, indem Sie die zuvor genannten Schritte ausführen:
- Bereich
- Distanz
- Verknüpfung
- Punkt
- Polylinie
- Bild
- Text
- Wasserzeichen
- Pfeil
Laden Sie die aktualisierte Datei herunter
Das obige Codebeispiel speichert die kommentierte DOCX-Datei in der Cloud. Sie können es mit dem folgenden Codebeispiel herunterladen:
# Erstellen Sie eine Instanz der API
file_api = groupdocs_annotation_cloud.FileApi.from_config(configurations)
request = groupdocs_annotation_cloud.DownloadFileRequest("Output\\output.docx", my_storage)
response = file_api.download_file(request)
# Verschieben Sie die heruntergeladene Datei in Ihr Arbeitsverzeichnis
shutil.move(response, "C:\\Files\\")
Fügen Sie mehrere Anmerkungen mit Python hinzu
Bitte befolgen Sie die unten aufgeführten Schritte, um Ihren DOCX Dateien programmgesteuert mehrere Anmerkungen hinzuzufügen.
- Erstellen Sie die erste Instanz von AnnotationInfo
- Legen Sie verschiedene Annotation-Eigenschaften für die erste Instanz fest, z. B. Position, Typ, Text usw.
- Erstellen Sie eine zweite AnnotationInfo-Instanz
- Legen Sie verschiedene Anmerkungseigenschaften für die zweite Instanz fest, z. B. Position, Typ, Text usw.
- Erstellen Sie eine FileInfo-Instanz
- Legen Sie den Dateipfad fest
- Erstellen Sie eine Instanz von AnnotateOptions
- Legen Sie die Dateiinformationen auf „AnnotateOptions“ fest
- Legen Sie die erste und zweite Anmerkung auf „AnnotateOptions“ fest
- Erstellen Sie eine Anfrage, indem Sie die AnnotateRequest-Methode aufrufen
- Erhalten Sie Ergebnisse, indem Sie die Methode AnnotateApi.annotate() aufrufen
Der folgende Codeausschnitt zeigt, wie Sie mithilfe einer REST-API mehrere Anmerkungen zu einer DOCX-Datei hinzufügen. Bitte befolgen Sie die zuvor genannten Schritte, um eine Datei hoch und herunterzuladen.
api = groupdocs_annotation_cloud.AnnotateApi.from_keys(client_id, client_secret)
a1 = groupdocs_annotation_cloud.AnnotationInfo()
a1.annotation_position = groupdocs_annotation_cloud.Point()
a1.annotation_position.x = 1
a1.annotation_position.y = 1
a1.box = groupdocs_annotation_cloud.Rectangle()
a1.box.x = 200
a1.box.y = 200
a1.box.width = 300
a1.box.height = 100
a1.page_number = 0
a1.pen_color = 1201033
a1.pen_style = "Solid"
a1.pen_width = 1
a1.opacity = 0.2
a1.type = "Watermark"
a1.text = "This is watermark annotation"
a1.creator_name = "Anonym A."
a2 = groupdocs_annotation_cloud.AnnotationInfo()
a2.annotation_position = groupdocs_annotation_cloud.Point()
a2.annotation_position.x = 852
a2.annotation_position.y = 59.38
a2.box = groupdocs_annotation_cloud.Rectangle()
a2.box.x = 375.8
a2.box.y = 59.38
a2.box.width = 88
a2.box.height = 37
a2.page_number = 2
a2.pen_color = 1201033
a2.pen_style = "Solid"
a2.pen_width = 1
a2.opacity = 0.9
a2.type = "Image"
a2.text = "This is Image annotation"
a2.creator_name = "Anonym A."
a2.image_path = "JohnSmith.png"
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "ten-pages.docx"
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1, a2]
options.output_path = "Output\\output.docx"
request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)
Dadurch werden die Bild und Wasserzeichenanmerkungen wie unten gezeigt in das Dokument eingefügt.
Abschluss
In diesem Artikel haben Sie erfahren, wie Sie mit der Document Annotation REST API unter Verwendung von Python verschiedene Arten von Anmerkungen zu Word Dokumenten in der Cloud hinzufügen. Sie haben auch gelernt, wie Sie die DOCX-Datei programmgesteuert in die Cloud hochladen und dann die kommentierte Datei aus der Cloud herunterladen. Weitere Informationen zur GroupDocs.Annotation Cloud API finden Sie in der Dokumentation. Wir bieten auch einen Abschnitt API-Referenz an, mit dem Sie unsere APIs direkt über den Browser visualisieren und mit ihnen interagieren können. Bei Unklarheiten können Sie uns gerne im Forum kontaktieren.