Read, Add, and Edit Threaded Comments in Excel using Python

MS Excel is a powerful and easy-to-use tool that is always considered to be the top choice for data analysis. In Excel, we can achieve new heights of collaboration by using threaded comments. In this article, we will learn how to programmatically read, add, edit, and delete threaded comments in Excel using Python.

This article covers the following topics:

Python API to Process Threaded Comments in Excel

Aspose.Cells is a widely used library that allows manipulating Microsoft Excel files in various programming languages, including Python, with APIs. We will use Aspose.Cells for Python via .NET for adding, reading, editing, or deleting threaded comments in Excel worksheets. It allows developers to generate, transform, or modify the Excel supported file formats in their Python applications.

pip install aspose-cells-python

Add Threaded Comments in Excel using Python

We can easily add a threaded comment to an Excel worksheet by following the steps below:

  1. Create an instance of the Workbook class.
  2. Add an author to the threaded_comment_authors collection using the add(name, user_id, provider_id) method.
  3. Get the ThreadedCommentAuthor class object for the newly created author by its index.
  4. Add the threaded comment using the add_threaded_comment() method. It takes the cell name, comment text, and ThreadedCommentAuthor object as arguments.
  5. Save the Excel file using the Workbook.save(string) method.

The following code sample shows how to add a threaded comment to an Excel worksheet using Python.

# This code example demonstrates how to add threaded comments in an Excel worksheet
# Create an instance of the Workbook class
workbook = Workbook();
# Add an Author
authorIndex = workbook.worksheets.threaded_comment_authors.add("Aspose Test", "", "");
author = workbook.worksheets.threaded_comment_authors[authorIndex];
# Add Threaded Comment
workbook.worksheets[0].comments.add_threaded_comment("A1", "Test Threaded Comment", author);
# Save the output file
workbook.save("D:\\Files\\AddThreadedComments_out.xlsx");
view raw threaded-comments-in-excel-using-python_add.py hosted with ❤ by GitHub

Read Threaded Comments for the Specific Cell in Python

We can read threaded comments for the specified cell from an Excel worksheet by following the steps below:

  1. Load an existing Excel file using the Workbook class.
  2. Access the worksheet by its index.
  3. Get threaded comments for a specific cell using the get_threaded_comments() method. It takes the cell name as an argument.
  4. Loop through all the threaded comments and read the details.

The following code sample shows how to read threaded comments for the specified column from an Excel worksheet using Python.

# This code example demonstrates how to read threaded comments for a specified cell in an Excel worksheet
# Load an existing Excel file
workbook = Workbook("D:\\Files\\AddThreadedComments_out.xlsx")
# Access the first worksheet
worksheet = workbook.worksheets[0];
# Get Threaded Comments for a specific cell
threadedComments = worksheet.comments.get_threaded_comments("A1");
# Read the threaded comments
for comment in threadedComments:
print("Author Name: " + comment.author.name)
print("Threaded comment Notes:" + comment.notes)
view raw threaded-comments-in-excel-using-python_read.py hosted with ❤ by GitHub 
Author Name: Aspose Test
Threaded comment Notes:Test Threaded Comment

Read all Threaded Comments from Excel in Python

Similarly, we can read all the threaded comments available in an Excel worksheet by following the steps below:

  1. Load an existing Excel file using the Workbook class.
  2. Loop through all the comments and read threaded comments for each comment.

The following code sample shows how to read all the threaded comments from an Excel worksheet using Python.

# This code example demonstrates how to read all threaded comments from an Excel worksheet
# Load an existing Excel file
workbook = Workbook("D:\\Files\\MultipleThreadedComments_out.xlsx")
# Access the first worksheet
worksheet = workbook.worksheets[0];
# Get all the comments
comments = worksheet.comments
# Read all the threaded comments
for comment in comments:
# Process threaded comments
for threadedComment in comment.threaded_comments:
print("Author Name: " + threadedComment.author.name)
print("Threaded comment author User Id: " + threadedComment.author.user_id)
print("Threaded comment author ProviderId:" + threadedComment.author.provider_id)
print("Threaded comment Notes:" + threadedComment.notes)
view raw threaded-comments-in-excel-using-python_read_all.py hosted with ❤ by GitHub

Edit Threaded Comments in Excel using Python

Please follow the steps below in order to update any of the threaded comments in an Excel worksheet:

  1. Load an existing Excel file using the Workbook class.
  2. Access the worksheet by its index.
  3. Get threaded comments for a specific cell using the get_threaded_comments() method. It takes the cell name as an argument.
  4. Update the comment’s notes property.
  5. Save the Excel file using the Workbook.save(string) method.

The following code sample shows how to edit threaded comments in an Excel worksheet using Python.

# This code example demonstrates how to edit threaded comments in an Excel worksheet
# Load an existing Excel file
workbook = Workbook("D:\\Files\\AddThreadedComments_out.xlsx")
# Access the first worksheet
worksheet = workbook.worksheets[0];
# Get Threaded Comments for a specific cell
threadedComments = worksheet.comments.get_threaded_comments("A1");
comment = threadedComments[0]
# Update the comment note
comment.notes = "Updated Comment";
# Save the output file
workbook.save("D:\\Files\\EditThreadedComments.xlsx");
view raw threaded-comments-in-excel-using-python_edit.py hosted with ❤ by GitHub

Delete Threaded Comments in Excel using Python

We can also delete the threaded comments for a specific cell in an Excel worksheet by following the steps below:

  1. Load an existing Excel file using the Workbook class.
  2. Access the worksheet by its index.
  3. Remove a comment from the comments collection using the remove_at() method. It takes the cell name as an argument.
  4. Save the Excel file using the save(string) method.

The following code sample shows how to delete threaded comments in an Excel worksheet using Python.

# This code example demonstrates how to delete threaded comments in an Excel worksheet
# Load an existing Excel file
workbook = Workbook("D:\\Files\\AddThreadedComments_out.xlsx")
# Get all the comments
comments = workbook.worksheets[0].comments
# Remove Comments
comments.remove_at("A1")
# Save the output file
workbook.save("D:\\Files\\DeleteThreadedComments.xlsx");
view raw threaded-comments-in-excel-using-python_delete.py hosted with ❤ by GitHub

Get a Free License

You can use Aspose.Cells for Python without evaluation limitations using a temporary license.

Threaded Comments in Excel – Learning Resources

Besides working with threaded comments in Excel worksheets, learn more about creating, manipulating, and converting Excel files, and explore various other features of the library using the resources below:

Conclusion

In this article, we have learned how to read, add, edit, and delete threaded comments from Excel worksheets using Python. By leveraging Aspose.Cell for Python, you can easily manipulate Excel worksheets in your Python applications. In case of any ambiguity, please contact us on our free support forum.

See Also