Framework for Python

Errors and Types

DataInfo

How to read one data file.

Fields

Name Type Description
path Path

Absolute path to the file.

type str

File type: csv, parquet, rds, excel, stata, spss, spss_por, sas, or sas_xpt.

delimiter str | None

For delimited text: comma, tab, semicolon, or space. None means it is guessed from the extension.

locked bool

Whether the file's hash is checked against framework.db on read.

private bool

Whether the file is in a private folder: one whose name contains private, confidential, or sensitive, at any depth below the project root.

description str | None

Shown when the data is read.

name str | None

The catalog name, when the file was found by name.

extra dict[str, Any]

Any other fields of the catalog entry.