SidecarValidator

class SidecarValidator(hed_schema)[source]

Methods

SidecarValidator.__init__(hed_schema)

Constructor for the SidecarValidator class.

SidecarValidator.validate(sidecar[, ...])

Validate the input data using the schema

SidecarValidator.validate_structure(sidecar, ...)

Validate the raw structure of this sidecar.

Attributes

SidecarValidator.reserved_category_values

SidecarValidator.reserved_column_names

SidecarValidator.__init__(hed_schema)[source]

Constructor for the SidecarValidator class.

Parameters:

hed_schema (HedSchema) – HED schema object to use for validation.

SidecarValidator.validate(sidecar, extra_def_dicts=None, name=None, error_handler=None)[source]

Validate the input data using the schema

Parameters:

  • sidecar (Sidecar) – Input data to be validated.

  • extra_def_dicts (list or DefinitionDict) – extra def dicts in addition to sidecar

  • name (str) – The name to report this sidecar as

  • error_handler (ErrorHandler) – Error context to use. Creates a new one if None

Returns:

A list of issues associated with each level in the HED string.

Return type:

issues (list of dict)

SidecarValidator.validate_structure(sidecar, error_handler)[source]

Validate the raw structure of this sidecar.

Parameters:

  • sidecar (Sidecar) – the sidecar to validate

  • error_handler (ErrorHandler) – The error handler to use for error context

Returns:

A list of issues found with the structure

Return type:

issues(list)

SidecarValidator.reserved_category_values = ['n/a']
SidecarValidator.reserved_column_names = ['HED']