imas_validator.validate_options.ValidateOptions¶

class imas_validator.validate_options.ValidateOptions(rulesets: ~typing.List[str] = <factory>, use_bundled_rulesets: bool = True, extra_rule_dirs: ~typing.List[~pathlib.Path] = <factory>, apply_generic: bool = True, use_pdb: bool = False, rule_filter: ~imas_validator.validate_options.RuleFilter = <factory>, explore: bool = False, track_node_dict: bool = False, stop_at_load_error: bool = False)¶

Bases: object

Dataclass for validate options

__init__(rulesets: ~typing.List[str] = <factory>, use_bundled_rulesets: bool = True, extra_rule_dirs: ~typing.List[~pathlib.Path] = <factory>, apply_generic: bool = True, use_pdb: bool = False, rule_filter: ~imas_validator.validate_options.RuleFilter = <factory>, explore: bool = False, track_node_dict: bool = False, stop_at_load_error: bool = False)¶

Methods

__init__([rulesets, use_bundled_rulesets, ...])

Attributes

apply_generic	Whether or not to apply the generic ruleset
explore	Whether this is an explore run or validate run.
stop_at_load_error	Whether or not to raise an error when an IDS cannot be loaded.
track_node_dict	Whether or not a node coverage dictionary should be created.
use_bundled_rulesets	Whether or not to load the rulesets bundled with imas_validator.
use_pdb	Whether or not to drop into debugger for failed tests
rulesets	Names of rulesets to be applied
extra_rule_dirs	Paths where to look for rule sets
rule_filter	Dictionary of filter criteria

apply_generic : bool = True¶

Whether or not to apply the generic ruleset

explore : bool = False¶

Whether this is an explore run or validate run.

extra_rule_dirs : List[Path]¶

Paths where to look for rule sets

rule_filter : RuleFilter¶

Dictionary of filter criteria

rulesets : List[str]¶

Names of rulesets to be applied

stop_at_load_error : bool = False¶

Whether or not to raise an error when an IDS cannot be loaded.

track_node_dict : bool = False¶

Whether or not a node coverage dictionary should be created.

use_bundled_rulesets : bool = True¶

Whether or not to load the rulesets bundled with imas_validator.

Bundled rule sets can be found in the imas_validator/assets/rulesets folder.

use_pdb : bool = False¶

Whether or not to drop into debugger for failed tests