How to use Range.ClearComments in the xlwings API way

The ClearComments method in the Range object is a useful feature for managing comments within Excel worksheets. In xlwings, this method allows you to remove all comments from a specified range, which can help in cleaning up data or preparing spreadsheets for further analysis or presentation. This is particularly beneficial when dealing with datasets that have accumulated numerous annotations over time, as it ensures a clean slate without manual deletion.

Functionality:
The primary function of ClearComments is to delete all comment objects associated with the cells in a given range. This includes any text or notes added by users for explanatory purposes. After execution, the cells will no longer display comment indicators, and the comments will be permanently removed. It does not affect other cell properties like values, formats, or formulas.

Syntax:
In xlwings, the ClearComments method is accessed through a Range object. The syntax is straightforward, as it does not require any parameters. Here’s the general format:

range_object.clear_comments()

• range_object: This refers to the xlwings Range object representing the cells from which you want to clear comments. It can be a single cell, a range of cells, or an entire worksheet range.
  Since there are no parameters, calling this method will immediately remove all comments within the specified range.

Examples:
Below are practical examples demonstrating how to use ClearComments with xlwings in Python. These assume you have an Excel workbook open and connected via xlwings.

1. Clearing comments from a specific cell:
   This example targets a single cell, such as “A1”, to remove any comment attached to it.

import xlwings as xw
# Connect to the active workbook
wb = xw.books.active
sheet = wb.sheets['Sheet1']
# Clear comments from cell A1
sheet.range('A1').clear_comments()

2. Clearing comments from a range of cells:
   Here, comments are removed from a larger range, like “B2:D10”, which might contain multiple annotations.

import xlwings as xw
wb = xw.books.active
sheet = wb.sheets['Sheet1']
# Clear comments from the range B2 to D10
sheet.range('B2:D10').clear_comments()

3. Clearing all comments in a worksheet:
   To remove every comment in an entire worksheet, you can use the used_range property or specify the full sheet range. This is efficient for bulk cleanup.

import xlwings as xw
wb = xw.books.active
sheet = wb.sheets['Sheet1']
# Clear comments from all used cells in the sheet
sheet.used_range.clear_comments()