lories.io.csv#

Functions#

read_file(→ pandas.DataFrame)

Reads the content of a specified CSV file.

Module Contents#

lories.io.csv.read_file(path: str, index_column: str = 'Timestamp', index_type: str = 'Timestamp', timezone: pytz.tzinfo | None = None, separator: str = ',', decimal: str = '.', rename: Mapping[str, str] | None = None, encoding: str = 'utf-8-sig') → pandas.DataFrame[source]#

Reads the content of a specified CSV file.

Parameters:

  • path (string) – the full path to the CSV file.

  • index_column (string) – the column name of the CSV file index.

  • index_type (string) – the index type, either “Timestamp”, “UNIX” oder “None”.

  • separator (string) – the separator character of the CSV file.

  • decimal (string) – the decimal character used for the CSV file.

  • timezone – the timezone for the timestamp to be converted or localized to.

  • rename (dict) – the dictionary to rename columns by after reading, if not None.

  • encoding (string) – the encoding to read_file the file with.

Returns:

the retrieved columns, indexed by their timestamp

Return type:

pandas.DataFrame