Package eido Documentation

def validate_project(project, schema, exclude_case=False)

Validate a project object against a schema

Parameters:

  • project (peppy.Sample): a project object to validate
  • schema (str | dict): schema dict to validate against or a path to one
  • exclude_case (bool): whether to exclude validated objectsfrom the error. Useful when used ith large projects
def validate_sample(project, sample_name, schema, exclude_case=False)

Validate the selected sample object against a schema

Parameters:

  • project (peppy.Project): a project object to validate
  • sample_name (str | int): name or index of the sample to validate
  • schema (str | dict): schema dict to validate against or a path to one
  • exclude_case (bool): whether to exclude validated objectsfrom the error. Useful when used ith large projects
def validate_config(project, schema, exclude_case=False)

Validate the config part of the Project object against a schema

Parameters:

  • project (peppy.Project): a project object to validate
  • schema (str | dict): schema dict to validate against or a path to one
  • exclude_case (bool): whether to exclude validated objectsfrom the error. Useful when used ith large projects
def read_schema(schema)

Safely read schema from YAML-formatted file.

If the schema imports any other schemas, they will be read recursively.

Parameters:

  • schema (str | Mapping): path to the schema fileor schema in a dict form

Returns:

  • list[dict]: read schemas

Raises:

  • TypeError: if the schema arg is neither a Mapping nor a file path orif the 'imports' sections in any of the schemas is not a list
def inspect_project(p, sample_names=None, max_attr=10)

Print inspection info: Project or, if sample_names argument is provided, matched samples

Parameters:

  • p (peppy.Project): project to inspect
  • sample_names (Iterable[str]): list of samples to inspect
  • max_attr (int): max number of sample attributes to display

Version Information: eido v0.1.1, generated by lucidoc v0.4.2