check

check(
    properties: dict[str, Any],
    config: Config = Config(),
    error: bool = False,
)

Checks a Data Package’s properties against the Data Package standard.

Parameters

properties : dict[str, Any]

A Data Package’s metadata from datapackage.json as a Python dictionary.

config : Config = Config()

Configuration for the checks to be done. See the Config class for more details, especially about the default values.

error : bool = False

Whether to treat any issues found as errors. Defaults to False, meaning that issues will be returned as a list of Issue objects. Will internally run explain() on the Issues if set to True.

Returns

list[Issue]

A list of Issue objects representing any issues found while checking the properties. If no issues are found, an empty list is returned.