csv

README

csv

csv reads comma-separated values files

Functions

read_all(source, comma=",", comment="", lazy_quotes=False, trim_leading_space=False, fields_per_record=0, skip=0) [][]string

read all rows from a source string, returning a list of string lists

parameters:

name	type	description
source	string	input string of csv data
comma	string	comma is the field delimiter, defaults to "," (a comma). comma must be a valid character and must not be \r, \n, or the Unicode replacement character (0xFFFD).
comment	string	comment, if not "", is the comment character. Lines beginning with the comment character without preceding whitespace are ignored. With leading whitespace the comment character becomes part of the field, even if trim_leading_space is True. comment must be a valid character and must not be \r, \n, or the Unicode replacement character (0xFFFD). It must also not be equal to comma.
lazy_quotes	bool	If lazy_quotes is True, a quote may appear in an unquoted field and a non-doubled quote may appear in a quoted field.
trim_leading_space	bool	If trim_leading_space is True, leading white space in a field is ignored. This is done even if the field delimiter, comma, is white space.
fields_per_record	int	fields_per_record is the number of expected fields per record. If fields_per_record is positive, read_all requires each record to have the given number of fields. If fields_per_record is 0, read_all sets it to the number of fields in the first record, so that future records must have the same field count. If fields_per_record is negative, no check is made and records may have a variable number of fields.
skip	int	number of rows to skip, omitting from returned rows

Documentation

Overview

Package csv reads comma-separated values files

outline: csv
  csv reads comma-separated values files
  path: encoding/csv
  functions:
    read_all(source, comma=",", comment="", lazy_quotes=False, trim_leading_space=False, fields_per_record=0, skip=0) [][]string
      read all rows from a source string, returning a list of string lists
      params:
        source string
          input string of csv data
        comma string
          comma is the field delimiter, defaults to "," (a comma).
          comma must be a valid character and must not be \r, \n,
          or the Unicode replacement character (0xFFFD).
        comment string
          comment, if not "", is the comment character. Lines beginning with the
          comment character without preceding whitespace are ignored.
          With leading whitespace the comment character becomes part of the
          field, even if trim_leading_space is True.
          comment must be a valid character and must not be \r, \n,
          or the Unicode replacement character (0xFFFD).
          It must also not be equal to comma.
        lazy_quotes bool
          If lazy_quotes is True, a quote may appear in an unquoted field and
          a non-doubled quote may appear in a quoted field.
        trim_leading_space bool
          If trim_leading_space is True, leading white space in a field is ignored.
          This is done even if the field delimiter, comma, is white space.
        fields_per_record int
          fields_per_record is the number of expected fields per record.
          If fields_per_record is positive, read_all requires each record to
          have the given number of fields. If fields_per_record is 0, read_all sets it to
          the number of fields in the first record, so that future records must
          have the same field count. If fields_per_record is negative, no check is
          made and records may have a variable number of fields.
        skip int
          number of rows to skip, omitting from returned rows
    write_all(source,comma=",") string
      write all rows from source to a csv-encoded string
      params:
        source [][]string
          array of arrays of strings to write to csv
        comma string
          comma is the field delimiter, defaults to "," (a comma).
          comma must be a valid character and must not be \r, \n,
          or the Unicode replacement character (0xFFFD).

Index

• Constants
• func LoadModule() (starlark.StringDict, error)
• func ReadAll(thread *starlark.Thread, _ *starlark.Builtin, args starlark.Tuple, ...) (starlark.Value, error)
• func WriteAll(thread *starlark.Thread, _ *starlark.Builtin, args starlark.Tuple, ...) (starlark.Value, error)

Constants

const ModuleName = "encoding/csv.star"

ModuleName defines the expected name for this Module when used in starlark's load() function, eg: load('csv.star', 'csv')

Functions

func LoadModule

func LoadModule() (starlark.StringDict, error)

LoadModule loads the base64 module. It is concurrency-safe and idempotent.

func ReadAll

func ReadAll(thread *starlark.Thread, _ *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error)

ReadAll gets all values from a csv source

func WriteAll

func WriteAll(thread *starlark.Thread, _ *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error)

WriteAll writes a csv file to a string