imas_validator.rules.docs_dataclass.RuleData¶

class imas_validator.rules.docs_dataclass.RuleData(name: str, docstring: str, path: ~pathlib.Path = <factory>, ids_names: ~typing.Tuple[str, ...] = <factory>)¶

Bases: object

Dataclass for explorer rule data

__init__(name: str, docstring: str, path: ~pathlib.Path = <factory>, ids_names: ~typing.Tuple[str, ...] = <factory>)¶

Methods

__init__(name, docstring[, path, ids_names])

Attributes

name	Name of validation function
docstring	Function level docstring
path	Path to file in which validation function is defined
ids_names	IDS names that the validation function should be applied to

docstring : str¶

Function level docstring

ids_names : Tuple[str, ...]¶

IDS names that the validation function should be applied to

name : str¶

Name of validation function

path : Path¶

Path to file in which validation function is defined