Framework for Python

Data

data_info()

How to read a data file, given a catalog name or a file path.

path is a dot-notation catalog name ("inputs.raw.survey"), a path relative to the current folder (anything with a slash), or an absolute path. Catalog paths are relative to the project root.

Usage

data_info(path: str) -> DataInfo

Arguments

Name Type Description
path required str

A dot-notation catalog name, a relative path containing a slash, or an absolute path.

Value

The file's path, type, and catalog fields.

Raises

  • DataNotFoundError: The name is not in the catalog, or its entry has no path.