Function validate_ignorable_clues

src/licensedcode/models.py:1049–1072

Raises an exception if any ignorable clues declared in a Rule are improperly detected in the rule text file.

(rule_directories, is_builtin)

def validate_ignorable_clues(rule_directories, is_builtin):
    """
    Raises an exception if any ignorable clues declared in a Rule are improperly detected
    in the rule text file.
    """
    messages = ['Errors while validating ignorable rules:']
    error_present = False
    for rules_dir in rule_directories:
        r = list(load_rules(
            rules_data_dir=rules_dir,
            is_builtin=is_builtin,
        ))
        for rule in r:
            if _ignorable_clue_error(rule, rules_dir):
                error_present = True
                result, expected = _ignorable_clue_error(rule, rules_dir)
                messages.append('')
                messages.append(f'{rule!r}')
                messages.append('Result:')
                messages.append(result)
                messages.append('Expected:')
                messages.append(expected)
    if error_present:
        raise InvalidRule('\n'.join(messages))


class InvalidRule(Exception):