Source code for nucleon_elastic_ff.utilities

"""Utility routines for nucleon_elastic_ff.data module
"""
from typing import List
from typing import Optional
from typing import Union

import logging
import re
import os


def set_up_logger(name: str, mode: str = "a") -> logging.Logger:
    """Sets up command line and file logger.

    Stream logger default level is INFO. File logger default level is DEBUG.
    Only adds handlers if no handlers are present.

    **Arguments**
        name: str
            Name of the logger

        mode: str = "a"
            Default mode for the file logger
    """
    logger = logging.getLogger(name)
    if not logger.handlers:
        logger.setLevel(logging.DEBUG)
        formatter = logging.Formatter("[%(asctime)s|%(name)s@%(levelname)s] %(message)s")

        ch = logging.StreamHandler()
        ch.setLevel(logging.INFO)
        ch.setFormatter(formatter)
        logger.addHandler(ch)

        sh = logging.FileHandler(f"{name}.log", mode=mode)
        sh.setLevel(logging.DEBUG)
        sh.setFormatter(formatter)
        logger.addHandler(sh)

    return logger


LOGGER = set_up_logger("nucleon_elastic_ff")


def has_match(
    string: str, patterns: Union[str, List[str]], match_all: bool = False
) -> bool:
    """Returns if at least one (`match_all = False`) of the regex patterns is matched.

    **Arguments**
        string: str
            The string to check.

        patterns: List[str]
            The regex patterns to match.

        match_all: bool = False
            If true, all pattern must have a match.

    """
    match = []
    patterns = [patterns] if isinstance(patterns, str) else patterns
    for pattern in patterns:
        match.append(bool(re.findall(pattern, string)))
    return all(match) if match_all else any(match)


def find_all_files(
    root: str,
    file_patterns: Optional[List[str]] = None,
    dir_patterns: Optional[List[str]] = None,
    exclude_file_patterns: Optional[List[str]] = None,
    match_all: bool = False,
) -> List[str]:
    """Recursivly iterates directory to all files which match the patterns.

    **Arguments**
        root: str
            The string to check.

        file_patterns: Optional[List[str]] = None
            The regex patterns for files to match.

        dir_patterns: Optional[List[str]] = None
            The regex patterns for directories to match.

        exclude_file_patterns: Optional[List[str]] = None
            The regex patterns for files to not match.

        match_all: bool = False
            If true, all pattern must have a match.
    """
    all_files = []

    LOGGER.info("Searching for files in `%s`", root)
    if file_patterns:
        LOGGER.info("\tFile patterns: `%s`", file_patterns)
    if dir_patterns:
        LOGGER.info("\tDir patterns: `%s`", dir_patterns)
    if exclude_file_patterns:
        LOGGER.info("\tAnd excluding files which match: `%s`", exclude_file_patterns)

    LOGGER.info(
        "All conditions must be fulfilled"
        if match_all
        else "Just one condition must match"
    )

    LOGGER.info("Matches:")
    for file_root, _, files in os.walk(root):
        if dir_patterns is None or has_match(
            file_root, dir_patterns, match_all=match_all
        ):
            for file in files:
                file_match = file_patterns is None or has_match(
                    file, file_patterns, match_all=match_all
                )
                file_match &= exclude_file_patterns is None or not has_match(
                    file, exclude_file_patterns
                )
                if file_match:
                    LOGGER.debug("\t`%s`", os.path.join(file_root, file))
                    all_files.append(os.path.join(file_root, file))

    LOGGER.info("Found %d files.", len(all_files))

    return all_files