Function _validate_structure

scenedetect/_cli/config.py:535–576

Validates the layout of the section/option mapping. Returns a bool indicating if validation was successful, and a list of log messages for the init log.

(parser: ConfigParser)

def _validate_structure(parser: ConfigParser) -> tuple[bool, list[LogMessage]]:
    """Validates the layout of the section/option mapping. Returns a bool indicating if validation
    was successful, and a list of log messages for the init log."""
    logs: list[LogMessage] = []
    success = True
    all_sections = set(parser.sections())
    for section in all_sections:
        section_name = section
        if section in DEPRECATED_COMMANDS:
            section = DEPRECATED_COMMANDS[section]
            logs.append(
                (
                    logging.WARNING,
                    f"WARNING: [{section_name}] is deprecated and will be removed!"
                    f"Use [{section}] instead.",
                )
            )
            # The parser already handled duplicate sections, but it doesn't know about deprecated
            # aliases. If there's a conflict, make sure we error out instead of warning.
            if section in all_sections:
                success = False
                logs.append(
                    (
                        logging.ERROR,
                        f"[{section_name}] conflicts with [{section}], only specify one.",
                    )
                )
                continue
        elif section not in CONFIG_MAP:
            success = False
            logs.append((logging.ERROR, f"Unsupported config section: [{section_name}]"))
            continue
        for option_name, _ in parser.items(section_name):
            if option_name not in CONFIG_MAP[section]:
                success = False
                logs.append(
                    (
                        logging.ERROR,
                        f"Unsupported config option in [{section_name}]: [{option_name}]",
                    )
                )
    return (success, logs)


def _parse_config(parser: ConfigParser) -> tuple[ConfigDict | None, list[LogMessage]]: