Source code for statick_tool.plugins.discovery.yaml

"""Discover YAML files to analyze."""

import logging
from collections import OrderedDict
from typing import Optional

from statick_tool.discovery_plugin import DiscoveryPlugin
from statick_tool.exceptions import Exceptions
from statick_tool.package import Package




class YAMLDiscoveryPlugin(DiscoveryPlugin):
    """Discover YAML files to analyze."""



    def get_name(self) -> str:
        """Get name of discovery type."""
        return "yaml"




    def scan(
        self, package: Package, level: str, exceptions: Optional[Exceptions] = None
    ) -> None:
        """Scan package looking for YAML files.

        Args:
            package: The Package object that was analyzed.
            level: Name of the level used in the scan.
            exceptions: Optional exceptions to filter out files.

        Returns:
            None
        """
        yaml_files: list[str] = []
        yaml_extensions = (".yaml", ".yml")

        self.find_files(package)

        for file_dict in package.files.values():
            if file_dict["name"].endswith(yaml_extensions):
                yaml_files.append(file_dict["path"])

        yaml_files = list(OrderedDict.fromkeys(yaml_files))

        logging.info("  %d YAML files found.", len(yaml_files))
        if exceptions:
            original_file_count = len(yaml_files)
            yaml_files = exceptions.filter_file_exceptions_early(package, yaml_files)
            if original_file_count > len(yaml_files):
                logging.info(
                    "  After filtering, %d YAML files will be scanned.", len(yaml_files)
                )

        package["yaml"] = yaml_files