How to get comments from a Word DOCX document hierarchically in Python

Retrieving DOCX comments might not be too bad of a task on its own, but the time and effort requirement are multiplied when it needs to be done hierarchically. Why go to all that trouble when you could use this shortcut.

First, install:

pip install cloudmersive-convert-api-client

Next in line comes our API instance creation and function call:

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'
# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
req_config = cloudmersive_convert_api_client.GetDocxGetCommentsHierarchicalRequest() # GetDocxGetCommentsHierarchicalRequest | Document input request
try:
# Get comments from a Word DOCX document hierarchically
api_response = api_instance.edit_document_docx_get_comments_hierarchical(req_config)
pprint(api_response)
except ApiException as e:
print("Exception when calling EditDocumentApi->edit_document_docx_get_comments_hierarchical: %s\n" % e)

Now edit_document_docx_get_comments_hierarchical can be called on your DOCX to retrieve all of the comments present and return them in a hierarchy. If you only need a flat list, there is also edit_document_docx_get_comments, as well as edit_pdf_get_annotations for PDF documents.

Why spend your time coding when you could be drinking coffee instead?