1#!python3
  2"""Hello World 👋🌎
  3This is Forest Fire Analytics 🌲🔥🧠
  4
  5When developing fire2a, AVOID writing code like this: 
  6    
  7    from fire2a.module import function 
  8
  9Use this instead:
 10
 11    from .module import function
 12
 13UNTIL WE CAN DISTRIBUTE ON PYPI!!
 14 
 15This is fire2a-lib distribution, fire2a package docstring
 16More info on:
 17
 18    fire2a.github.io/fire2a-lib  
 19    fire2a.github.io/docs  
 20    www.fire2a.com  
 21"""  # fmt: skip
 22__author__ = "Fernando Badilla"
 23__revision__ = "$Format:%H$"
 24
 25import logging
 26from importlib.metadata import PackageNotFoundError, distribution
 27from pathlib import Path
 28from typing import Any, Dict, List, Tuple, Union
 29
 30logger = logging.getLogger(__name__)
 31
 32try:
 33    __version__ = distribution("fire2a-lib").version
 34    version_from = "importlib"
 35except PackageNotFoundError:
 36    if (Path(__file__).parent / "_version.py").exists():
 37        from ._version import __version__
 38
 39        version_from = "_version.py"
 40    else:
 41        __version__ = "0.0.0"
 42        version_from = "fallback"
 43
 44# logger.warning("%s Package version: %s, from %s", __name__, __version__, version_from)
 45
 46
 47
 48def setup_logger(name: str = __name__, verbosity: int = 0, logfile: Path = None):
 49    r"""Capture the logger and setup name, verbosity, stream handler & rotating logfile if provided.
 50    Args:
 51        name (str, optional): Name of the logger. Defaults to \__name __ 
 52        verbosity (str | int): Verbosity level, implemented, WARNING:1, INFO:2 (default), or DEBUG:3
 53        logfile (Path, optional): Create a -rotated- logfile (5 files, 25MB each).
 54    Returns:
 55        logger (Logger):  All code in this pkg uses logger.info("..."), logger.debug, etc.
 56
 57    ## Developers implementing their own logger
 58        * All fire2a modules uses `logger = logging.getLogger(__name__)`
 59
 60    # Regular Usage Guideline  
 61    logging.critical("Something went wrong, exception info?", exc_info=True)  
 62    logging.error("Something went wrong, but we keep going?")  
 63    logging.warning("Default message level")  
 64    logging.info("Something planned happened")  
 65    logging.debug("Details of the planned thing that happened")  
 66    print("Normal program output, not logged")
 67    """  # fmt: skip
 68    # Capture the logger
 69    if name:
 70        # specific logger
 71        logger = logging.getLogger(name)
 72    else:
 73        # root logger
 74        logger = logging.getLogger()
 75
 76    # Create a stream handler
 77    import sys
 78
 79    stream_handler = logging.StreamHandler(sys.stdout)
 80
 81    # Create a rotating file handler
 82    if logfile:
 83        from logging.handlers import RotatingFileHandler
 84
 85        rf_handler = RotatingFileHandler(logfile, maxBytes=25 * 1024, backupCount=5)
 86
 87    # Set the logs level
 88    if verbosity in ["CRITICAL", "FATAL"] or verbosity == -1:
 89        level = logging.CRITICAL
 90    elif verbosity == "ERROR" or verbosity == 0:
 91        level = logging.WARNING
 92    elif verbosity == "WARNING" or verbosity == 1:
 93        level = logging.WARNING
 94    elif verbosity == "INFO" or verbosity == 2:
 95        level = logging.INFO
 96    elif verbosity == "DEBUG" or verbosity == 3:
 97        level = logging.DEBUG
 98    else:
 99        level = logging.DEBUG
100    logger.setLevel(level)
101    stream_handler.setLevel(level)
102    if logfile:
103        rf_handler.setLevel(level)
104
105    # formatter
106    # "%(asctime)s %(levelname)s %(name)s %(filename)s:%(lineno)d %(message)s", datefmt="%Y-%m-%d %H:%M:%S"
107    formatter = logging.Formatter(
108        "%(asctime)s %(levelname)s %(name)s %(message)s",
109        datefmt="%Y-%m-%d %H:%M:%S",
110    )
111    stream_handler.setFormatter(formatter)
112    if logfile:
113        rf_handler.setFormatter(formatter)
114
115    # Add the handlers to the logger
116    logger.addHandler(stream_handler)
117    if logfile:
118        logger.addHandler(rf_handler)
119    logger.debug("Logger initialized @level %s", logging.getLevelName(level))
120
121    return logger
122
123
124def setup_file(name="unknown", filepath=Path().cwd()):
125    """Setups the NAME and FILEPATH variables for modules
126    Tries getting them from __main__.__file__ and __main__.__package__
127    If it's the __main__ entry point, tries to use the package name
128    Args:
129        main: __main__ from the calling script
130        name: if fails, returns name (default "unknown")
131        here: if fails, returns here Path (default "cwd")
132    """
133    import __main__
134
135    if filestr := getattr(__main__, "__file__", None):
136        file = Path(filestr)
137        NAME = file.stem
138        if NAME == "__main__":
139            if package := getattr(__main__, "__package__", None):
140                NAME = package + "_main"
141            else:
142                NAME = name
143        FILEPATH = file.parent
144    else:
145        NAME = name
146        FILEPATH = filepath
147    logger.warning("setup_file(%s, %s) __main__:%s", NAME, FILEPATH, __main__)
148    return NAME, FILEPATH