Add 2 functions: get_row_outline_level and get_row_height (#22)

- Rename set_row_outline to set_row_outline_level
- Update unit tests

Author: xiaoq898

excelize.py

@@ -779,7 +779,7 @@ def add_comment(self, sheet: str, opts: Comment) -> None:
 
     def add_form_control(self, sheet: str, opts: FormControl) -> None:
         """
-        Add form control button in a worksheet by given worksheet name and form
+        Add form control object in a worksheet by given worksheet name and form
         control options. Supported form control type: button, check box, group
         box, label, option button, scroll bar and spinner. If set macro for the
         form control, the workbook extension should be XLSM or XLTM. Scroll
@@ -1554,8 +1554,8 @@ def get_app_props(self) -> Optional[AppProperties]:
         Get document application properties.
 
         Returns:
-            Optional[AppProperties]: Return the the app properties if no
-            error occurred, otherwise raise a RuntimeError with the message.
+            Optional[AppProperties]: Return the app properties if no error
+            occurred, otherwise raise a RuntimeError with the message.
         """
         lib.GetAppProps.restype = types_go._GetAppPropsResult
         res = lib.GetAppProps(self.file_index)
@@ -1699,6 +1699,65 @@ def get_cell_value(self, sheet: str, cell: str, *opts: Options) -> str:
             return res.val.decode(ENCODE)
         raise RuntimeError(err)
 
+    def get_row_outline_level(self, sheet: str, row: int) -> int:
+        """
+        Get outline level of a single row by given worksheet name and row
+        number.
+
+        Args:
+            sheet (str): The worksheet name
+            row (int): The row number
+
+        Returns:
+            int: Return the row outline level if no error occurred, otherwise
+            raise a RuntimeError with the message.
+
+        Example:
+            For example, get outline level of row 5 in Sheet1:
+
+            ```python
+            try:
+                level = f.get_row_outline_level("Sheet1", 5)
+            except RuntimeError as err:
+                print(err)
+            ```
+        """
+        lib.GetRowOutlineLevel.restype = types_go._IntErrorResult
+        res = lib.GetRowOutlineLevel(self.file_index, sheet.encode(ENCODE), row)
+        err = res.err.decode(ENCODE)
+        if not err:
+            return res.val
+        raise RuntimeError(err)
+
+    def get_row_height(self, sheet: str, row: int) -> float:
+        """
+        Get row height by given worksheet name and row number.
+
+        Args:
+            sheet (str): The worksheet name
+            row (int): The row number
+
+        Returns:
+            float: Return the row height if no error occurred, otherwise
+            raise a RuntimeError with the message.
+
+        Example:
+            For example, get height of row 5 in Sheet1:
+
+            ```python
+            try:
+                height = f.get_row_height("Sheet1", 5)
+            except RuntimeError as err:
+                print(err)
+            ```
+        """
+        lib.GetRowHeight.restype = types_go._Float64ErrorResult
+        res = lib.GetRowHeight(self.file_index, sheet.encode(ENCODE), row)
+        err = res.err.decode(ENCODE)
+        if not err:
+            return res.val
+        raise RuntimeError(err)
+
     def get_col_outline_level(self, sheet: str, col: str) -> int:
         """
         Get outline level of a single column by given worksheet name and column
@@ -1975,7 +2034,7 @@ def get_sheet_map(self) -> Dict[int, str]:
         sheets ID, and name maps of the workbook.
 
         Returns:
-            dict[int, str]: Return the sheet ID and name map if no error
+            Dict[int, str]: Return the sheet ID and name map if no error
             occurred, otherwise return an empty dictionary.
         """
         lib.GetSheetMap.restype = types_go._GetSheetMapResult
@@ -3378,7 +3437,7 @@ def set_row_height(self, sheet: str, row: int, height: float) -> None:
         if err != "":
             raise RuntimeError(err)
 
-    def set_row_outline(self, sheet: str, row: int, level: int) -> None:
+    def set_row_outline_level(self, sheet: str, row: int, level: int) -> None:
         """
         Set outline level number of a single row by given worksheet name and
         Excel row number. The value of parameter 'level' is 1-7.
@@ -3397,7 +3456,7 @@ def set_row_outline(self, sheet: str, row: int, level: int) -> None:
 
             ```python
             try:
-                f.set_row_outline("Sheet1", 2, 1)
+                f.set_row_outline_level("Sheet1", 2, 1)
             except RuntimeError as err:
                 print(err)
             ```

main.go

@@ -524,7 +524,7 @@ func AddComment(idx int, sheet *C.char, opts *C.struct_Comment) *C.char {
 	return C.CString(emptyString)
 }
 
-// AddFormControl provides the method to add form control button in a worksheet
+// AddFormControl provides the method to add form control object in a worksheet
 // by given worksheet name and form control options. Supported form control
 // type: button, check box, group box, label, option button, scroll bar and
 // spinner. If set macro for the form control, the workbook extension should be
@@ -1229,6 +1229,38 @@ func GetDefaultFont(idx int) C.struct_StringErrorResult {
 	return C.struct_StringErrorResult{val: C.CString(val), err: C.CString(emptyString)}
 }
 
+// GetRowHeight provides a function to get row height by given worksheet name
+// and row number.
+//
+//export GetRowHeight
+func GetRowHeight(idx int, sheet *C.char, row C.int) C.struct_Float64ErrorResult {
+	f, ok := files.Load(idx)
+	if !ok {
+		return C.struct_Float64ErrorResult{val: C.double(0), err: C.CString(errFilePtr)}
+	}
+	val, err := f.(*excelize.File).GetRowHeight(C.GoString(sheet), int(row))
+	if err != nil {
+		return C.struct_Float64ErrorResult{val: C.double(val), err: C.CString(err.Error())}
+	}
+	return C.struct_Float64ErrorResult{val: C.double(val), err: C.CString(emptyString)}
+}
+
+// GetRowOutlineLevel provides a function to get outline level of a single row
+// by given worksheet name and row number.
+//
+//export GetRowOutlineLevel
+func GetRowOutlineLevel(idx int, sheet *C.char, row C.int) C.struct_IntErrorResult {
+	f, ok := files.Load(idx)
+	if !ok {
+		return C.struct_IntErrorResult{val: C.int(0), err: C.CString(errFilePtr)}
+	}
+	val, err := f.(*excelize.File).GetRowOutlineLevel(C.GoString(sheet), int(row))
+	if err != nil {
+		return C.struct_IntErrorResult{val: C.int(int32(val)), err: C.CString(err.Error())}
+	}
+	return C.struct_IntErrorResult{val: C.int(int32(val)), err: C.CString(emptyString)}
+}
+
 // GetRowVisible provides a function to get visible of a single row by given
 // worksheet name and Excel row number.
 //

test_excelize.py

@@ -349,9 +349,14 @@ def test_style(self):
         with self.assertRaises(RuntimeError) as context:
             _ = f.get_col_outline_level("SheetN", "D")
         self.assertEqual(str(context.exception), "sheet SheetN does not exist")
-        self.assertIsNone(f.set_row_outline("Sheet1", 2, 1))
+
+        self.assertIsNone(f.set_row_outline_level("Sheet1", 2, 1))
+        with self.assertRaises(RuntimeError) as context:
+            f.set_row_outline_level("SheetN", 2, 1)
+        self.assertEqual(str(context.exception), "sheet SheetN does not exist")
+        self.assertEqual(f.get_row_outline_level("Sheet1", 2), 1)
         with self.assertRaises(RuntimeError) as context:
-            f.set_row_outline("SheetN", 2, 1)
+            _ = f.get_row_outline_level("SheetN", 2)
         self.assertEqual(str(context.exception), "sheet SheetN does not exist")
 
         self.assertIsNone(f.set_sheet_background("Sheet2", "chart.png"))
@@ -1229,6 +1234,10 @@ def test_cell_hyperlink(self):
     def test_cell_rich_text(self):
         f = excelize.new_file()
         self.assertIsNone(f.set_row_height("Sheet1", 1, 35))
+        self.assertEqual(f.get_row_height("Sheet1", 1), 35)
+        with self.assertRaises(RuntimeError) as context:
+            f.get_row_height("SheetN", 1)
+        self.assertEqual(str(context.exception), "sheet SheetN does not exist")
 
         with self.assertRaises(RuntimeError) as context:
             f.set_row_height("Sheet1", 0, 35)