optimize code and comments: use println errors instead of panic

xuri · xuri · commit 5ca7231ed408 · 2020-01-03T23:57:25.000+08:00
diff --git a/cell_test.go b/cell_test.go
@@ -110,7 +110,7 @@ func ExampleFile_SetCellFloat() {
 	f := NewFile()
 	var x = 3.14159265
 	if err := f.SetCellFloat("Sheet1", "A1", x, 2, 64); err != nil {
-		fmt.Println(err)
+		println(err.Error())
 	}
 	val, _ := f.GetCellValue("Sheet1", "A1")
 	fmt.Println(val)
diff --git a/excelize_test.go b/excelize_test.go
@@ -1259,7 +1259,7 @@ func fillCells(f *File, sheet string, colCount, rowCount int) {
 		for row := 1; row <= rowCount; row++ {
 			cell, _ := CoordinatesToCellName(col, row)
 			if err := f.SetCellStr(sheet, cell, cell); err != nil {
-				panic(err)
+				println(err.Error())
 			}
 		}
 	}
diff --git a/file_test.go b/file_test.go
@@ -12,18 +12,17 @@ func BenchmarkWrite(b *testing.B) {
 			for col := 1; col <= 20; col++ {
 				val, err := CoordinatesToCellName(col, row)
 				if err != nil {
-					panic(err)
+					b.Error(err)
 				}
 				if err := f.SetCellDefault("Sheet1", val, s); err != nil {
-					panic(err)
+					b.Error(err)
 				}
 			}
 		}
 		// Save xlsx file by the given path.
 		err := f.SaveAs("./test.xlsx")
 		if err != nil {
-			panic(err)
+			b.Error(err)
 		}
 	}
-
 }
diff --git a/merge.go b/merge.go
diff --git a/merge_test.go b/merge_test.go
diff --git a/rows.go b/rows.go
@@ -63,7 +63,6 @@ type Rows struct {
 	err                        error
 	curRow, totalRow, stashRow int
 	sheet                      string
-	stashColumn                []string
 	rows                       []xlsxRow
 	f                          *File
 	decoder                    *xml.Decoder
@@ -111,7 +110,6 @@ func (rows *Rows) Columns() ([]string, error) {
 						}
 						if row > rows.curRow {
 							rows.stashRow = row - 1
-							rows.stashColumn = columns
 							return columns, err
 						}
 					}
@@ -153,12 +151,19 @@ func (err ErrSheetNotExist) Error() string {
 // Rows return a rows iterator. For example:
 //
 //    rows, err := f.Rows("Sheet1")
+//    if err != nil {
+//        println(err.Error())
+//        return
+//    }
 //    for rows.Next() {
 //        row, err := rows.Columns()
+//        if err != nil {
+//            println(err.Error())
+//        }
 //        for _, colCell := range row {
-//            fmt.Print(colCell, "\t")
+//            print(colCell, "\t")
 //        }
-//        fmt.Println()
+//        println()
 //    }
 //
 func (f *File) Rows(sheet string) (*Rows, error) {
diff --git a/rows_test.go b/rows_test.go
@@ -143,6 +143,7 @@ func TestColumns(t *testing.T) {
 	rows.decoder = f.xmlNewDecoder(bytes.NewReader([]byte(`<worksheet><sheetData><row r="2"><c r="A1" t="s"><v>1</v></c></row></sheetData></worksheet>`)))
 	rows.curRow = 1
 	_, err = rows.Columns()
+	assert.NoError(t, err)
 
 	rows.decoder = f.xmlNewDecoder(bytes.NewReader([]byte(`<worksheet><sheetData><row r="A"><c r="A1" t="s"><v>1</v></c></row><row r="A"><c r="2" t="str"><v>B</v></c></row></sheetData></worksheet>`)))
 	rows.stashRow, rows.curRow = 0, 1
diff --git a/sheet.go b/sheet.go
@@ -339,12 +339,12 @@ func (f *File) GetSheetIndex(name string) int {
 // GetSheetMap provides a function to get worksheet name and index map of XLSX.
 // For example:
 //
-//    f, err := excelize.OpenFile("./Book1.xlsx")
+//    f, err := excelize.OpenFile("Book1.xlsx")
 //    if err != nil {
 //        return
 //    }
 //    for index, name := range f.GetSheetMap() {
-//        fmt.Println(index, name)
+//        println(index, name)
 //    }
 //
 func (f *File) GetSheetMap() map[int]string {
diff --git a/sheet_test.go b/sheet_test.go
@@ -19,15 +19,15 @@ func ExampleFile_SetPageLayout() {
 		"Sheet1",
 		excelize.PageLayoutOrientation(excelize.OrientationLandscape),
 	); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 	if err := f.SetPageLayout(
 		"Sheet1",
 		excelize.PageLayoutPaperSize(10),
 		excelize.FitToHeight(2),
 		excelize.FitToWidth(2),
 	); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 	// Output:
 }
@@ -41,17 +41,17 @@ func ExampleFile_GetPageLayout() {
 		fitToWidth  excelize.FitToWidth
 	)
 	if err := f.GetPageLayout("Sheet1", &orientation); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 	if err := f.GetPageLayout("Sheet1", &paperSize); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 	if err := f.GetPageLayout("Sheet1", &fitToHeight); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 
 	if err := f.GetPageLayout("Sheet1", &fitToWidth); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 	fmt.Println("Defaults:")
 	fmt.Printf("- orientation: %q\n", orientation)
diff --git a/sheetpr_test.go b/sheetpr_test.go
@@ -40,7 +40,7 @@ func ExampleFile_SetSheetPrOptions() {
 		excelize.AutoPageBreaks(true),
 		excelize.OutlineSummaryBelow(false),
 	); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 	// Output:
 }
@@ -66,7 +66,7 @@ func ExampleFile_GetSheetPrOptions() {
 		&autoPageBreaks,
 		&outlineSummaryBelow,
 	); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 	fmt.Println("Defaults:")
 	fmt.Printf("- codeName: %q\n", codeName)
@@ -189,7 +189,7 @@ func ExampleFile_SetPageMargins() {
 		excelize.PageMarginRight(1.0),
 		excelize.PageMarginTop(1.0),
 	); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 	// Output:
 }
@@ -215,7 +215,7 @@ func ExampleFile_GetPageMargins() {
 		&marginRight,
 		&marginTop,
 	); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 	fmt.Println("Defaults:")
 	fmt.Println("- marginBottom:", marginBottom)
diff --git a/sheetview_test.go b/sheetview_test.go
@@ -47,30 +47,30 @@ func ExampleFile_SetSheetViewOptions() {
 		excelize.ZoomScale(80),
 		excelize.TopLeftCell("C3"),
 	); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 
 	var zoomScale excelize.ZoomScale
 	fmt.Println("Default:")
 	fmt.Println("- zoomScale: 80")
 
 	if err := f.SetSheetViewOptions(sheet, 0, excelize.ZoomScale(500)); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 
 	if err := f.GetSheetViewOptions(sheet, 0, &zoomScale); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 
 	fmt.Println("Used out of range value:")
 	fmt.Println("- zoomScale:", zoomScale)
 
 	if err := f.SetSheetViewOptions(sheet, 0, excelize.ZoomScale(123)); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 
 	if err := f.GetSheetViewOptions(sheet, 0, &zoomScale); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 
 	fmt.Println("Used correct value:")
@@ -111,7 +111,7 @@ func ExampleFile_GetSheetViewOptions() {
 		&zoomScale,
 		&topLeftCell,
 	); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 
 	fmt.Println("Default:")
@@ -125,27 +125,27 @@ func ExampleFile_GetSheetViewOptions() {
 	fmt.Println("- topLeftCell:", `"`+topLeftCell+`"`)
 
 	if err := f.SetSheetViewOptions(sheet, 0, excelize.TopLeftCell("B2")); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 
 	if err := f.GetSheetViewOptions(sheet, 0, &topLeftCell); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 
 	if err := f.SetSheetViewOptions(sheet, 0, excelize.ShowGridLines(false)); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 
 	if err := f.GetSheetViewOptions(sheet, 0, &showGridLines); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 
 	if err := f.SetSheetViewOptions(sheet, 0, excelize.ShowZeros(false)); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 
 	if err := f.GetSheetViewOptions(sheet, 0, &showZeros); err != nil {
-		panic(err)
+		println(err.Error())
 	}
 
 	fmt.Println("After change:")
diff --git a/sparkline_test.go b/sparkline_test.go
@@ -298,12 +298,12 @@ func prepareSparklineDataset() *File {
 	f.NewSheet("Sheet3")
 	for row, data := range sheet2 {
 		if err := f.SetSheetRow("Sheet2", fmt.Sprintf("A%d", row+1), &data); err != nil {
-			panic(err)
+			println(err.Error())
 		}
 	}
 	for row, data := range sheet3 {
 		if err := f.SetSheetRow("Sheet3", fmt.Sprintf("A%d", row+1), &data); err != nil {
-			panic(err)
+			println(err.Error())
 		}
 	}
 	return f

Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ func ExampleFile_SetCellFloat() {`
`110`	`110`	`f := NewFile()`
`111`	`111`	`var x = 3.14159265`
`112`	`112`	`if err := f.SetCellFloat("Sheet1", "A1", x, 2, 64); err != nil {`
`113`		`- fmt.Println(err)`
	`113`	`+ println(err.Error())`
`114`	`114`	`}`
`115`	`115`	`val, _ := f.GetCellValue("Sheet1", "A1")`
`116`	`116`	`fmt.Println(val)`
Original file line number	Diff line number	Diff line change
`@@ -1259,7 +1259,7 @@ func fillCells(f *File, sheet string, colCount, rowCount int) {`
`1259`	`1259`	`for row := 1; row <= rowCount; row++ {`
`1260`	`1260`	`cell, _ := CoordinatesToCellName(col, row)`
`1261`	`1261`	`if err := f.SetCellStr(sheet, cell, cell); err != nil {`
`1262`		`- panic(err)`
	`1262`	`+ println(err.Error())`
`1263`	`1263`	`}`
`1264`	`1264`	`}`
`1265`	`1265`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,18 +12,17 @@ func BenchmarkWrite(b *testing.B) {`
`12`	`12`	`for col := 1; col <= 20; col++ {`
`13`	`13`	`val, err := CoordinatesToCellName(col, row)`
`14`	`14`	`if err != nil {`
`15`		`- panic(err)`
	`15`	`+ b.Error(err)`
`16`	`16`	`}`
`17`	`17`	`if err := f.SetCellDefault("Sheet1", val, s); err != nil {`
`18`		`- panic(err)`
	`18`	`+ b.Error(err)`
`19`	`19`	`}`
`20`	`20`	`}`
`21`	`21`	`}`
`22`	`22`	`// Save xlsx file by the given path.`
`23`	`23`	`err := f.SaveAs("./test.xlsx")`
`24`	`24`	`if err != nil {`
`25`		`- panic(err)`
	`25`	`+ b.Error(err)`
`26`	`26`	`}`
`27`	`27`	`}`
`28`		`-`
`29`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,15 +19,15 @@ func ExampleFile_SetPageLayout() {`
`19`	`19`	`"Sheet1",`
`20`	`20`	`excelize.PageLayoutOrientation(excelize.OrientationLandscape),`
`21`	`21`	`); err != nil {`
`22`		`- panic(err)`
	`22`	`+ println(err.Error())`
`23`	`23`	`}`
`24`	`24`	`if err := f.SetPageLayout(`
`25`	`25`	`"Sheet1",`
`26`	`26`	`excelize.PageLayoutPaperSize(10),`
`27`	`27`	`excelize.FitToHeight(2),`
`28`	`28`	`excelize.FitToWidth(2),`
`29`	`29`	`); err != nil {`
`30`		`- panic(err)`
	`30`	`+ println(err.Error())`
`31`	`31`	`}`
`32`	`32`	`// Output:`
`33`	`33`	`}`
`@@ -41,17 +41,17 @@ func ExampleFile_GetPageLayout() {`
`41`	`41`	`fitToWidth excelize.FitToWidth`
`42`	`42`	`)`
`43`	`43`	`if err := f.GetPageLayout("Sheet1", &orientation); err != nil {`
`44`		`- panic(err)`
	`44`	`+ println(err.Error())`
`45`	`45`	`}`
`46`	`46`	`if err := f.GetPageLayout("Sheet1", &paperSize); err != nil {`
`47`		`- panic(err)`
	`47`	`+ println(err.Error())`
`48`	`48`	`}`
`49`	`49`	`if err := f.GetPageLayout("Sheet1", &fitToHeight); err != nil {`
`50`		`- panic(err)`
	`50`	`+ println(err.Error())`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`if err := f.GetPageLayout("Sheet1", &fitToWidth); err != nil {`
`54`		`- panic(err)`
	`54`	`+ println(err.Error())`
`55`	`55`	`}`
`56`	`56`	`fmt.Println("Defaults:")`
`57`	`57`	`fmt.Printf("- orientation: %q\n", orientation)`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ func ExampleFile_SetSheetPrOptions() {`
`40`	`40`	`excelize.AutoPageBreaks(true),`
`41`	`41`	`excelize.OutlineSummaryBelow(false),`
`42`	`42`	`); err != nil {`
`43`		`- panic(err)`
	`43`	`+ println(err.Error())`
`44`	`44`	`}`
`45`	`45`	`// Output:`
`46`	`46`	`}`
`@@ -66,7 +66,7 @@ func ExampleFile_GetSheetPrOptions() {`
`66`	`66`	`&autoPageBreaks,`
`67`	`67`	`&outlineSummaryBelow,`
`68`	`68`	`); err != nil {`
`69`		`- panic(err)`
	`69`	`+ println(err.Error())`
`70`	`70`	`}`
`71`	`71`	`fmt.Println("Defaults:")`
`72`	`72`	`fmt.Printf("- codeName: %q\n", codeName)`
`@@ -189,7 +189,7 @@ func ExampleFile_SetPageMargins() {`
`189`	`189`	`excelize.PageMarginRight(1.0),`
`190`	`190`	`excelize.PageMarginTop(1.0),`
`191`	`191`	`); err != nil {`
`192`		`- panic(err)`
	`192`	`+ println(err.Error())`
`193`	`193`	`}`
`194`	`194`	`// Output:`
`195`	`195`	`}`
`@@ -215,7 +215,7 @@ func ExampleFile_GetPageMargins() {`
`215`	`215`	`&marginRight,`
`216`	`216`	`&marginTop,`
`217`	`217`	`); err != nil {`
`218`		`- panic(err)`
	`218`	`+ println(err.Error())`
`219`	`219`	`}`
`220`	`220`	`fmt.Println("Defaults:")`
`221`	`221`	`fmt.Println("- marginBottom:", marginBottom)`
Original file line number	Diff line number	Diff line change
`@@ -47,30 +47,30 @@ func ExampleFile_SetSheetViewOptions() {`
`47`	`47`	`excelize.ZoomScale(80),`
`48`	`48`	`excelize.TopLeftCell("C3"),`
`49`	`49`	`); err != nil {`
`50`		`- panic(err)`
	`50`	`+ println(err.Error())`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`var zoomScale excelize.ZoomScale`
`54`	`54`	`fmt.Println("Default:")`
`55`	`55`	`fmt.Println("- zoomScale: 80")`
`56`	`56`
`57`	`57`	`if err := f.SetSheetViewOptions(sheet, 0, excelize.ZoomScale(500)); err != nil {`
`58`		`- panic(err)`
	`58`	`+ println(err.Error())`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`if err := f.GetSheetViewOptions(sheet, 0, &zoomScale); err != nil {`
`62`		`- panic(err)`
	`62`	`+ println(err.Error())`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`fmt.Println("Used out of range value:")`
`66`	`66`	`fmt.Println("- zoomScale:", zoomScale)`
`67`	`67`
`68`	`68`	`if err := f.SetSheetViewOptions(sheet, 0, excelize.ZoomScale(123)); err != nil {`
`69`		`- panic(err)`
	`69`	`+ println(err.Error())`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`if err := f.GetSheetViewOptions(sheet, 0, &zoomScale); err != nil {`
`73`		`- panic(err)`
	`73`	`+ println(err.Error())`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`fmt.Println("Used correct value:")`
`@@ -111,7 +111,7 @@ func ExampleFile_GetSheetViewOptions() {`
`111`	`111`	`&zoomScale,`
`112`	`112`	`&topLeftCell,`
`113`	`113`	`); err != nil {`
`114`		`- panic(err)`
	`114`	`+ println(err.Error())`
`115`	`115`	`}`
`116`	`116`
`117`	`117`	`fmt.Println("Default:")`
`@@ -125,27 +125,27 @@ func ExampleFile_GetSheetViewOptions() {`
`125`	`125`	fmt.Println("- topLeftCell:", `"`+topLeftCell+`"`)
`126`	`126`
`127`	`127`	`if err := f.SetSheetViewOptions(sheet, 0, excelize.TopLeftCell("B2")); err != nil {`
`128`		`- panic(err)`
	`128`	`+ println(err.Error())`
`129`	`129`	`}`
`130`	`130`
`131`	`131`	`if err := f.GetSheetViewOptions(sheet, 0, &topLeftCell); err != nil {`
`132`		`- panic(err)`
	`132`	`+ println(err.Error())`
`133`	`133`	`}`
`134`	`134`
`135`	`135`	`if err := f.SetSheetViewOptions(sheet, 0, excelize.ShowGridLines(false)); err != nil {`
`136`		`- panic(err)`
	`136`	`+ println(err.Error())`
`137`	`137`	`}`
`138`	`138`
`139`	`139`	`if err := f.GetSheetViewOptions(sheet, 0, &showGridLines); err != nil {`
`140`		`- panic(err)`
	`140`	`+ println(err.Error())`
`141`	`141`	`}`
`142`	`142`
`143`	`143`	`if err := f.SetSheetViewOptions(sheet, 0, excelize.ShowZeros(false)); err != nil {`
`144`		`- panic(err)`
	`144`	`+ println(err.Error())`
`145`	`145`	`}`
`146`	`146`
`147`	`147`	`if err := f.GetSheetViewOptions(sheet, 0, &showZeros); err != nil {`
`148`		`- panic(err)`
	`148`	`+ println(err.Error())`
`149`	`149`	`}`
`150`	`150`
`151`	`151`	`fmt.Println("After change:")`
Original file line number	Diff line number	Diff line change
`@@ -298,12 +298,12 @@ func prepareSparklineDataset() *File {`
`298`	`298`	`f.NewSheet("Sheet3")`
`299`	`299`	`for row, data := range sheet2 {`
`300`	`300`	`if err := f.SetSheetRow("Sheet2", fmt.Sprintf("A%d", row+1), &data); err != nil {`
`301`		`- panic(err)`
	`301`	`+ println(err.Error())`
`302`	`302`	`}`
`303`	`303`	`}`
`304`	`304`	`for row, data := range sheet3 {`
`305`	`305`	`if err := f.SetSheetRow("Sheet3", fmt.Sprintf("A%d", row+1), &data); err != nil {`
`306`		`- panic(err)`
	`306`	`+ println(err.Error())`
`307`	`307`	`}`
`308`	`308`	`}`
`309`	`309`	`return f`