imas_validator.validate.explore.explore¶

imas_validator.validate.explore.explore(validate_options: ValidateOptions = ValidateOptions(rulesets=[], use_bundled_rulesets=True, extra_rule_dirs=[], apply_generic=True, use_pdb=False, rule_filter=RuleFilter(name=[], ids=[]), explore=True, track_node_dict=False, stop_at_load_error=False), show_empty: bool = True, docstring_level: int = 1) → None¶

Function used to get an overview of validation rules inside a rule folder.

Parameters:

validate_options: ValidateOptions = ValidateOptions(rulesets=[], use_bundled_rulesets=True, extra_rule_dirs=[], apply_generic=True, use_pdb=False, rule_filter=RuleFilter(name=[], ids=[]), explore=True, track_node_dict=False, stop_at_load_error=False)¶

dataclass with options for validate function

show_empty: bool = True¶

whether or not to show folders and files without any found rules

docstring_level: int = 1¶

0 for no docstrings, 1 for shortened and 2 for full docstrings.