Skip to content

Commit 38ad3b2

Browse files
authored
Add new function: get_col_outline_level (#10)
- Update unie tests
1 parent da46454 commit 38ad3b2

File tree

3 files changed

+48
-0
lines changed

3 files changed

+48
-0
lines changed

excelize.py

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1536,6 +1536,35 @@ def get_cell_value(
15361536
err = res.err.decode(ENCODE)
15371537
return res.val.decode(ENCODE), None if err == "" else Exception(err)
15381538

1539+
def get_col_outline_level(
1540+
self, sheet: str, col: str
1541+
) -> Tuple[int, Optional[Exception]]:
1542+
"""
1543+
Get outline level of a single column by given worksheet name and column
1544+
name.
1545+
1546+
Args:
1547+
sheet (str): The worksheet name
1548+
col (str): The column name
1549+
1550+
Returns:
1551+
Tuple[int, Optional[Exception]]: A tuple containing the column
1552+
outline level and an exception if an error occurred, otherwise None.
1553+
1554+
Example:
1555+
For example, get outline level of column D in Sheet1:
1556+
1557+
.. code-block:: python
1558+
1559+
level, err = f.get_col_outline_level("Sheet1", "D")
1560+
"""
1561+
lib.GetColOutlineLevel.restype = types_go._IntErrorResult
1562+
res = lib.GetColOutlineLevel(
1563+
self.file_index, sheet.encode(ENCODE), col.encode(ENCODE)
1564+
)
1565+
err = res.err.decode(ENCODE)
1566+
return res.val, None if err == "" else Exception(err)
1567+
15391568
def get_col_style(self, sheet: str, col: str) -> Tuple[int, Optional[Exception]]:
15401569
"""
15411570
Get column style ID by given worksheet name and column name.

main.go

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1126,6 +1126,22 @@ func GetCellValue(idx int, sheet, cell *C.char, opts *C.struct_Options) C.struct
11261126
return C.struct_StringErrorResult{val: C.CString(val), err: C.CString(emptyString)}
11271127
}
11281128

1129+
// GetColOutlineLevel provides a function to get outline level of a single
1130+
// column by given worksheet name and column name.
1131+
//
1132+
//export GetColOutlineLevel
1133+
func GetColOutlineLevel(idx int, sheet, col *C.char) C.struct_IntErrorResult {
1134+
f, ok := files.Load(idx)
1135+
if !ok {
1136+
return C.struct_IntErrorResult{val: C.int(0), err: C.CString(errFilePtr)}
1137+
}
1138+
val, err := f.(*excelize.File).GetColOutlineLevel(C.GoString(sheet), C.GoString(col))
1139+
if err != nil {
1140+
return C.struct_IntErrorResult{val: C.int(int32(val)), err: C.CString(err.Error())}
1141+
}
1142+
return C.struct_IntErrorResult{val: C.int(int32(val)), err: C.CString(emptyString)}
1143+
}
1144+
11291145
// GetColStyle provides a function to get column style ID by given worksheet
11301146
// name and column name. This function is concurrency safe.
11311147
//

test_excelize.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,9 @@ def test_style(self):
288288
self.assertIsNone(err)
289289

290290
self.assertIsNone(f.set_col_outline_level("Sheet1", "D", 2))
291+
level, err = f.get_col_outline_level("Sheet1", "D")
292+
self.assertEqual(level, 2)
293+
self.assertIsNone(err)
291294
self.assertIsNone(f.set_row_outline("Sheet1", 2, 1))
292295

293296
self.assertIsNone(f.set_sheet_background("Sheet2", "chart.png"))

0 commit comments

Comments
 (0)