Jako programista Python możesz programowo dodawać adnotacje do dowolnego pliku programu Word (.doc lub .docx) w chmurze. Adnotacje to zazwyczaj metadane w postaci komentarzy, notatek, wyjaśnień lub innego rodzaju zewnętrznych uwag w dokumencie, dostarczających dodatkowych informacji o istniejących danych. Ten artykuł skupi się na tym, jak dodawać adnotacje do plików DOCX za pomocą interfejsu API REST w Python.

W tym artykule zostaną omówione następujące tematy:

Adnotacje w dokumentach REST API i Python SDK

GroupDocs.Annotation Cloud

Do dodawania adnotacji do dokumentów DOC lub DOCX będę używać API Python SDK of GroupDocs.Annotation Cloud. Umożliwia programowe tworzenie narzędzi do adnotacji dokumentów i obrazów online. Takie narzędzia mogą być używane do dodawania adnotacji, nakładek ze znakami wodnymi, zastępowania tekstu, redagowania, karteczek samoprzylepnych i znaczników tekstowych do dokumentów biznesowych we wszystkich popularnych formatach. Udostępnia również zestawy SDK .NET, Java, PHP, Ruby i Node.js jako członkowie rodziny adnotacji dokumentów dla Cloud API.

Możesz zainstalować GroupDocs.Annotation Cloud w swoim projekcie Python za pomocą następującego polecenia w konsoli:

pip install groupdocs_annotation_cloud

Zanim zaczniesz postępować zgodnie z instrukcjami i dostępnymi przykładami kodu, uzyskaj swój identyfikator klienta i klucz tajny klienta z panelu nawigacyjnego. Dodaj swój identyfikator i klucz tajny w kodzie, jak pokazano poniżej:

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"

Adnotuj pliki DOCX za pomocą interfejsu API REST w Python

Możesz dodać adnotacje do pliku DOCX, wykonując proste czynności wymienione poniżej:

Prześlij dokument

Przede wszystkim prześlij plik DOCX do chmury, korzystając z przykładowego kodu podanego poniżej:

# Utwórz instancję interfejsu 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)

W rezultacie przesłany plik DOCX będzie dostępny w sekcji plików Twojego pulpitu nawigacyjnego w chmurze.

Dodaj adnotacje do plików DOCX w Python

Wykonaj czynności wymienione poniżej, aby programowo wstawić adnotacje do dokumentu programu Word.

  • Utwórz instancję AnnotationInfo
  • Ustaw różne właściwości adnotacji, np. pozycję, typ, tekst itp.
  • Utwórz instancję FileInfo
  • Ustaw ścieżkę pliku
  • Utwórz instancję AnnotateOptions
  • Ustaw informacje o pliku na AnnotateOptions
  • Ustaw adnotację na AnnotateOptions
  • Utwórz żądanie, wywołując metodę AnnotateRequest
  • Uzyskaj wyniki, wywołując metodę AnnotateApi.annotate().

Poniższy fragment kodu przedstawia sposób wstawiania adnotacji obszaru w dokumencie programu Word przy użyciu interfejsu API REST.

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

# Dodaj adnotację obszaru
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)

W rezultacie adnotacje obszaru zostaną wstawione do dokumentu, jak pokazano poniżej.

Dodaj adnotacje do plików DOCX w Python

Obsługiwane typy adnotacji

Poniżej znajduje się lista obsługiwanych typów adnotacji, które możesz dodać do plików DOCX, wykonując czynności wymienione wcześniej:

  • Obszar
  • Dystans
  • Połączyć
  • Punkt
  • Polilinia
  • Obraz
  • Tekst
  • znak wodny
  • Strzałka

Pobierz zaktualizowany plik

Powyższy przykładowy kod zapisze plik DOCX z adnotacjami w chmurze. Możesz go pobrać, korzystając z następującego przykładowego kodu:

# Utwórz instancję interfejsu 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)

# Przenieś pobrany plik do katalogu roboczego
shutil.move(response, "C:\\Files\\")

Dodaj wiele adnotacji za pomocą Python

Wykonaj czynności wymienione poniżej, aby programowo dodać wiele adnotacji do plików DOCX.

  • Utwórz pierwszą instancję AnnotationInfo
  • Ustaw różne właściwości adnotacji dla pierwszej instancji, np. pozycja, typ, tekst itp.
  • Utwórz drugą instancję AnnotationInfo
  • Ustaw różne właściwości adnotacji dla drugiej instancji, np. pozycja, typ, tekst itp.
  • Utwórz instancję FileInfo
  • Ustaw ścieżkę pliku
  • Utwórz instancję AnnotateOptions
  • Ustaw informacje o pliku na AnnotateOptions
  • Ustaw pierwszą i drugą adnotację na AnnotateOptions
  • Utwórz żądanie, wywołując metodę AnnotateRequest
  • Uzyskaj wyniki, wywołując metodę AnnotateApi.annotate().

Poniższy fragment kodu pokazuje, jak dodać wiele adnotacji do pliku DOCX za pomocą interfejsu API REST. Wykonaj czynności wymienione wcześniej, aby przesłać i pobrać plik.

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)

W rezultacie adnotacje dotyczące obrazu i znaku wodnego zostaną wstawione do dokumentu, jak pokazano poniżej.

adnotacje dotyczące obrazu i znaku wodnego

Wniosek

W tym artykule nauczyłeś się, jak dodawać różne typy adnotacji do dokumentów programu Word w chmurze za pomocą interfejsu API REST dokumentu Annotation przy użyciu języka Python. Nauczyłeś się również, jak programowo przesyłać plik DOCX do chmury, a następnie pobierać plik z adnotacjami z chmury. Możesz dowiedzieć się więcej o GroupDocs.Annotation Cloud API, korzystając z dokumentacji. Udostępniamy również sekcję Informacje o interfejsach API, która umożliwia wizualizację naszych interfejsów API i interakcję z nimi bezpośrednio w przeglądarce. W przypadku jakichkolwiek niejasności prosimy o kontakt na forum.