Python API Reference

Reading CSV Files

Functions for reading CSV files

read_csv(path: str, separator: str | None = None, quote: str | None = None, has_header: bool = True, num_threads: typing.SupportsInt | None = None, error_mode: str | None = None, max_errors: typing.SupportsInt | None = None, encoding: str | None = None, comment: str | None = None, skip_empty_rows: bool = True, guess_integer: bool = True, trim_ws: bool = True, escape_backslash: bool = False, decimal_mark: str = ‘.’, skip: typing.SupportsInt = 0) -> vroom_csv._core.Table

Data Conversion

Functions for converting CSV to other formats

to_parquet

to_parquet(input_path: str, output_path: str, compression: str | None = None, row_group_size: typing.SupportsInt | None = None, num_threads: typing.SupportsInt | None = None, error_mode: str | None = None, max_errors: typing.SupportsInt | None = None, comment: str | None = None, skip_empty_rows: bool = True, guess_integer: bool = True, trim_ws: bool = True, escape_backslash: bool = False, decimal_mark: str = ‘.’, skip: typing.SupportsInt = 0) -> None

to_arrow_ipc

to_arrow_ipc(input_path: str, output_path: str, batch_size: typing.SupportsInt | None = None, num_threads: typing.SupportsInt | None = None, guess_integer: bool = True, trim_ws: bool = True, escape_backslash: bool = False, decimal_mark: str = ‘.’, skip: typing.SupportsInt = 0) -> None

Data Classes

Classes representing parsed CSV data

Table

A table of data read from a CSV file.

Exceptions

Exception classes for error handling

VroomError	Base exception for vroom-csv errors.
ParseError	Exception raised when CSV parsing fails.
IOError	Exception raised for I/O errors.