package csv
import "encoding/csv"
Package csv reads and writes comma-separated values (CSV) files.
A csv file contains zero or more records of one or more fields per record. Each record is separated by the newline character. The final record may optionally be followed by a newline character.
field1,field2,field3
White space is considered part of a field.
Carriage returns before newline characters are silently removed.
Blank lines are ignored. A line with only whitespace characters (excluding the ending newline character) is not considered a blank line.
Fields which start and stop with the quote character " are called quoted-fields. The beginning and ending quote are not part of the field.
The source:
normal string,"quoted-field"
results in the fields
{`normal string`, `quoted-field`}
Within a quoted-field a quote character followed by a second quote character is considered a single quote.
"the ""word"" is true","a ""quoted-field"""
results in
{`the "word" is true`, `a "quoted-field"`}
Newlines and commas may be included in a quoted-field
"Multi-line field","comma is ,"
results in
{`Multi-line field`, `comma is ,`}
Index ¶
- Variables
- type ParseError
- type Reader
- func NewReader(r io.Reader) *Reader
- func (r *Reader) Read() (record []string, err error)
- func (r *Reader) ReadAll() (records [][]string, err error)
- type Writer
Examples ¶
Variables ¶
var ( ErrTrailingComma = errors.New("extra delimiter at end of line") // no longer used ErrBareQuote = errors.New("bare \" in non-quoted-field") ErrQuote = errors.New("extraneous \" in field") ErrFieldCount = errors.New("wrong number of fields in line") )
These are the errors that can be returned in ParseError.Error
Types ¶
type ParseError ¶
type ParseError struct { Line int // Line where the error occurred Column int // Column (rune index) where the error occurred Err error // The actual error }
A ParseError is returned for parsing errors. The first line is 1. The first column is 0.
func (*ParseError) Error ¶
func (e *ParseError) Error() string
type Reader ¶
type Reader struct { Comma rune // field delimiter (set to ',' by NewReader) Comment rune // comment character for start of line FieldsPerRecord int // number of expected fields per record LazyQuotes bool // allow lazy quotes TrailingComma bool // ignored; here for backwards compatibility TrimLeadingSpace bool // trim leading space // contains filtered or unexported fields }
A Reader reads records from a CSV-encoded file.
As returned by NewReader, a Reader expects input conforming to RFC 4180. The exported fields can be changed to customize the details before the first call to Read or ReadAll.
Comma is the field delimiter. It defaults to ','.
Comment, if not 0, is the comment character. Lines beginning with the Comment character are ignored.
If FieldsPerRecord is positive, Read requires each record to have the given number of fields. If FieldsPerRecord is 0, Read sets it to the number of fields in the first record, so that future records must have the same field count. If FieldsPerRecord is negative, no check is made and records may have a variable number of fields.
If LazyQuotes is true, a quote may appear in an unquoted field and a non-doubled quote may appear in a quoted field.
If TrimLeadingSpace is true, leading white space in a field is ignored.
Code:play
Output: This example shows how csv.Reader can be configured to handle other
types of CSV files.
Code:play
Output:Example¶
package main
import (
"encoding/csv"
"fmt"
"io"
"log"
"strings"
)
func main() {
in := `first_name,last_name,username
"Rob","Pike",rob
Ken,Thompson,ken
"Robert","Griesemer","gri"
`
r := csv.NewReader(strings.NewReader(in))
for {
record, err := r.Read()
if err == io.EOF {
break
}
if err != nil {
log.Fatal(err)
}
fmt.Println(record)
}
}
[first_name last_name username]
[Rob Pike rob]
[Ken Thompson ken]
[Robert Griesemer gri]
Example (Options)¶
package main
import (
"encoding/csv"
"fmt"
"log"
"strings"
)
func main() {
in := `first_name;last_name;username
"Rob";"Pike";rob
# lines beginning with a # character are ignored
Ken;Thompson;ken
"Robert";"Griesemer";"gri"
`
r := csv.NewReader(strings.NewReader(in))
r.Comma = ';'
r.Comment = '#'
records, err := r.ReadAll()
if err != nil {
log.Fatal(err)
}
fmt.Print(records)
}
[[first_name last_name username] [Rob Pike rob] [Ken Thompson ken] [Robert Griesemer gri]]
func NewReader ¶
NewReader returns a new Reader that reads from r.
func (*Reader) Read ¶
Read reads one record from r. The record is a slice of strings with each string representing one field.
func (*Reader) ReadAll ¶
ReadAll reads all the remaining records from r.
Each record is a slice of fields.
A successful call returns err == nil, not err == EOF. Because ReadAll is
defined to read until EOF, it does not treat end of file as an error to be
reported.
Code:play
Output:Example¶
package main
import (
"encoding/csv"
"fmt"
"log"
"strings"
)
func main() {
in := `first_name,last_name,username
"Rob","Pike",rob
Ken,Thompson,ken
"Robert","Griesemer","gri"
`
r := csv.NewReader(strings.NewReader(in))
records, err := r.ReadAll()
if err != nil {
log.Fatal(err)
}
fmt.Print(records)
}
[[first_name last_name username] [Rob Pike rob] [Ken Thompson ken] [Robert Griesemer gri]]
type Writer ¶
type Writer struct { Comma rune // Field delimiter (set to ',' by NewWriter) UseCRLF bool // True to use \r\n as the line terminator // contains filtered or unexported fields }
A Writer writes records to a CSV encoded file.
As returned by NewWriter, a Writer writes records terminated by a newline and uses ',' as the field delimiter. The exported fields can be changed to customize the details before the first call to Write or WriteAll.
Comma is the field delimiter.
If UseCRLF is true, the Writer ends each record with \r\n instead of \n.
Code:play
Output:Example¶
package main
import (
"encoding/csv"
"log"
"os"
)
func main() {
records := [][]string{
{"first_name", "last_name", "username"},
{"Rob", "Pike", "rob"},
{"Ken", "Thompson", "ken"},
{"Robert", "Griesemer", "gri"},
}
w := csv.NewWriter(os.Stdout)
for _, record := range records {
if err := w.Write(record); err != nil {
log.Fatalln("error writing record to csv:", err)
}
}
// Write any buffered data to the underlying writer (standard output).
w.Flush()
if err := w.Error(); err != nil {
log.Fatal(err)
}
}
first_name,last_name,username
Rob,Pike,rob
Ken,Thompson,ken
Robert,Griesemer,gri
func NewWriter ¶
NewWriter returns a new Writer that writes to w.
func (*Writer) Error ¶
Error reports any error that has occurred during a previous Write or Flush.
func (*Writer) Flush ¶
func (w *Writer) Flush()
Flush writes any buffered data to the underlying io.Writer. To check if an error occurred during the Flush, call Error.
func (*Writer) Write ¶
Writer writes a single CSV record to w along with any necessary quoting. A record is a slice of strings with each string being one field.
func (*Writer) WriteAll ¶
WriteAll writes multiple CSV records to w using Write and then calls Flush.
Code:play
Output:Example¶
package main
import (
"encoding/csv"
"log"
"os"
)
func main() {
records := [][]string{
{"first_name", "last_name", "username"},
{"Rob", "Pike", "rob"},
{"Ken", "Thompson", "ken"},
{"Robert", "Griesemer", "gri"},
}
w := csv.NewWriter(os.Stdout)
w.WriteAll(records) // calls Flush internally
if err := w.Error(); err != nil {
log.Fatalln("error writing csv:", err)
}
}
first_name,last_name,username
Rob,Pike,rob
Ken,Thompson,ken
Robert,Griesemer,gri
Source Files ¶
- Version
- v1.5.0-beta.3
- Published
- Jul 30, 2015
- Platform
- darwin/amd64
- Imports
- 8 packages
- Last checked
- 2 minutes ago –
Tools for package owners.