pyarrow.csv.ParseOptions

class pyarrow.csv.ParseOptions(delimiter=None, quote_char=None, double_quote=None, escape_char=None, header_rows=None, newlines_in_values=None, ignore_empty_lines=None)

Bases: object

Options for parsing CSV files.

Parameters:
  • delimiter (1-character string, optional (default ',')) – The character delimiting individual cells in the CSV data.
  • quote_char (1-character string or False, optional (default '"')) – The character used optionally for quoting CSV values (False if quoting is not allowed).
  • double_quote (bool, optional (default True)) – Whether two quotes in a quoted CSV value denote a single quote in the data.
  • escape_char (1-character string or False, optional (default False)) – The character used optionally for escaping special characters (False if escaping is not allowed).
  • header_rows (int, optional (default 1)) – The number of rows to skip at the start of the CSV data.
  • newlines_in_values (bool, optional (default False)) – Whether newline characters are allowed in CSV values. Setting this to True reduces the performance of multi-threaded CSV reading.
  • ignore_empty_lines (bool, optional (default True)) – Whether empty lines are ignored in CSV input. If False, an empty line is interpreted as containing a single empty value (assuming a one-column CSV file).
__init__()

Initialize self. See help(type(self)) for accurate signature.

Attributes

delimiter The character delimiting individual cells in the CSV data.
double_quote Whether two quotes in a quoted CSV value denote a single quote in the data.
escape_char The character used optionally for escaping special characters (False if escaping is not allowed).
header_rows The number of rows to skip at the start of the CSV data.
ignore_empty_lines Whether empty lines are ignored in CSV input.
newlines_in_values Whether newline characters are allowed in CSV values.
quote_char The character used optionally for quoting CSV values (False if quoting is not allowed).
delimiter

The character delimiting individual cells in the CSV data.

double_quote

Whether two quotes in a quoted CSV value denote a single quote in the data.

escape_char

The character used optionally for escaping special characters (False if escaping is not allowed).

header_rows

The number of rows to skip at the start of the CSV data.

ignore_empty_lines

Whether empty lines are ignored in CSV input. If False, an empty line is interpreted as containing a single empty value (assuming a one-column CSV file).

newlines_in_values

Whether newline characters are allowed in CSV values. Setting this to True reduces the performance of multi-threaded CSV reading.

quote_char

The character used optionally for quoting CSV values (False if quoting is not allowed).