Add new function: unprotect_sheet (#24)

Author: Jameshu0513

excelize.py

@@ -3952,6 +3952,30 @@ def unmerge_cell(
         if err != "":
             raise RuntimeError(err)
 
+    def unprotect_sheet(self, sheet: str, *password: str) -> None:
+        """
+        Remove protection for a sheet, specified the second optional password
+        parameter to remove sheet protection with password verification.
+
+        Args:
+            sheet (str): The worksheet name
+            *password (str): Optional password for sheet protection verification
+
+        Returns:
+            None: Return None if no error occurred, otherwise raise a
+            RuntimeError with the message.
+        """
+        lib.UnprotectSheet.restype = c_char_p
+        passwd = password[0] if len(password) > 0 else ""
+        err = lib.UnprotectSheet(
+            self.file_index,
+            sheet.encode(ENCODE),
+            passwd.encode(ENCODE),
+            len(password) > 0,
+        ).decode(ENCODE)
+        if err != "":
+            raise RuntimeError(err)
+            
     def update_linked_value(self) -> None:
         """
         Fix linked values within a spreadsheet are not updating in Office Excel

main.go

@@ -2747,6 +2747,28 @@ func UnmergeCell(idx int, sheet, topLeftCell, bottomRightCell *C.char) *C.char {
 	return C.CString(emptyString)
 }
 
+// UnprotectSheet provides a function to remove protection for a sheet,
+// specified the second optional password parameter to remove sheet
+// protection with password verification.
+//
+//export UnprotectSheet
+func UnprotectSheet(idx int, sheet, password *C.char, verify bool) *C.char {
+	f, ok := files.Load(idx)
+	if !ok {
+		return C.CString(errFilePtr)
+	}
+	if verify {
+		if err := f.(*excelize.File).UnprotectSheet(C.GoString(sheet), C.GoString(password)); err != nil {
+			return C.CString(err.Error())
+		}
+		return C.CString(emptyString)
+	}
+	if err := f.(*excelize.File).UnprotectSheet(C.GoString(sheet)); err != nil {
+		return C.CString(err.Error())
+	}
+	return C.CString(emptyString)
+}
+
 // UpdateLinkedValue fix linked values within a spreadsheet are not updating in
 // Office Excel application. This function will be remove value tag when met a
 // cell have a linked value.

test_excelize.py

@@ -450,6 +450,16 @@ def test_style(self):
         with self.assertRaises(RuntimeError) as context:
             f.protect_sheet("SheetN", excelize.SheetProtectionOptions())
         self.assertEqual(str(context.exception), "sheet SheetN does not exist")
+
+        with self.assertRaises(RuntimeError) as context:
+            f.unprotect_sheet("SheetN")
+        self.assertEqual(str(context.exception), "sheet SheetN does not exist")
+        with self.assertRaises(RuntimeError) as context:
+            f.unprotect_sheet("Sheet1", "")
+        self.assertEqual(str(context.exception), "password length invalid")
+        self.assertIsNone(f.unprotect_sheet("Sheet1", "password"))
+        self.assertIsNone(f.unprotect_sheet("Sheet1"))
+
         self.assertIsNone(
             f.protect_workbook(
                 excelize.WorkbookProtectionOptions(