-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into feature/json-feed-client
- Loading branch information
Showing
12 changed files
with
271 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| #! python3 # noqa: E265 | ||
|
|
||
| """Helper to configure logging depending on CLI options.""" | ||
|
|
||
| # ############################################################################ | ||
| # ########## IMPORTS ############# | ||
| # ################################ | ||
|
|
||
| # standard library | ||
| import logging | ||
| from getpass import getuser | ||
| from logging.handlers import RotatingFileHandler | ||
| from os import environ, getenv | ||
| from os.path import expanduser, expandvars | ||
| from pathlib import Path | ||
| from platform import architecture, platform | ||
| from socket import gethostname | ||
| from typing import Optional | ||
|
|
||
| # package | ||
| from geotribu_cli.__about__ import __title__, __version__ | ||
| from geotribu_cli.constants import GeotribuDefaults | ||
| from geotribu_cli.utils.check_path import check_path | ||
| from geotribu_cli.utils.proxies import get_proxy_settings | ||
| from geotribu_cli.utils.str2bool import str2bool | ||
|
|
||
| # ############################################################################ | ||
| # ########## GLOBALS ############# | ||
| # ################################ | ||
|
|
||
| # logs | ||
| logger = logging.getLogger(__name__) | ||
| default_settings = GeotribuDefaults() | ||
|
|
||
| # ############################################################################ | ||
| # ########## FUNCTIONS ########### | ||
| # ################################ | ||
|
|
||
|
|
||
| def configure_logger(verbosity: int = 1, logfile: Optional[Path] = None): | ||
| """Configure logging according to verbosity from CLI. | ||
| Args: | ||
| verbosity (int): verbosity level | ||
| logfile (Path, optional): file where to store log. Defaults to None. | ||
| """ | ||
| # handle log level overridden by environment variable | ||
| verbosity = getenv("GEOTRIBU_LOGS_LEVEL", verbosity) | ||
| try: | ||
| verbosity = int(verbosity) | ||
| except ValueError as err: | ||
| logger.error(f"Bad verbosity value type: {err}. Fallback to 1.") | ||
| verbosity = 1 | ||
|
|
||
| # set log level depending on verbosity argument | ||
| if 0 < verbosity < 4: | ||
| verbosity = 40 - (10 * verbosity) | ||
| elif verbosity >= 4: | ||
| # debug is the limit | ||
| verbosity = 40 - (10 * 3) | ||
| else: | ||
| verbosity = 0 | ||
|
|
||
| # set console handler | ||
| log_console_handler = logging.StreamHandler() | ||
| log_console_handler.setLevel(verbosity) | ||
|
|
||
| # set log file | ||
| if not logfile: | ||
| logging.basicConfig( | ||
| level=verbosity, | ||
| format="%(asctime)s||%(levelname)s||%(module)s||%(funcName)s||%(lineno)d||%(message)s", | ||
| datefmt="%Y-%m-%d %H:%M:%S", | ||
| handlers=[log_console_handler], | ||
| ) | ||
|
|
||
| else: | ||
| if getenv("GEOTRIBU_LOGS_DIR") and check_path( | ||
| input_path=Path(expandvars(expanduser(getenv("GEOTRIBU_LOGS_DIR")))), | ||
| must_be_a_file=False, | ||
| must_be_a_folder=True, | ||
| must_be_writable=True, | ||
| raise_error=False, | ||
| ): | ||
| logs_folder = Path(expandvars(expanduser(getenv("GEOTRIBU_LOGS_DIR")))) | ||
| logger.debug( | ||
| f"Logs folder set with GEOTRIBU_LOGS_DIR environment variable: {logs_folder}" | ||
| ) | ||
| else: | ||
| logs_folder: Path = default_settings.geotribu_working_folder.joinpath( | ||
| "logs" | ||
| ) | ||
| logger.debug( | ||
| "Logs folder specified in GEOTRIBU_LOGS_DIR environment variable " | ||
| f"{getenv('GEOTRIBU_LOGS_DIR')} can't be used (see logs above). Fallback on " | ||
| f"default folder: {logs_folder}" | ||
| ) | ||
|
|
||
| # make sure folder exists | ||
| logs_folder.mkdir(exist_ok=True, parents=True) | ||
| logs_filepath = Path(logs_folder, logfile) | ||
|
|
||
| log_file_handler = RotatingFileHandler( | ||
| backupCount=10, | ||
| delay=True, | ||
| encoding="UTF-8", | ||
| filename=logs_filepath, | ||
| maxBytes=3000000, | ||
| mode="a", | ||
| ) | ||
| # force new file by execution | ||
| if logs_filepath.is_file(): | ||
| log_file_handler.doRollover() | ||
|
|
||
| logging.basicConfig( | ||
| level=verbosity, | ||
| format="%(asctime)s||%(levelname)s||%(module)s||%(funcName)s||%(lineno)d||%(message)s", | ||
| datefmt="%Y-%m-%d %H:%M:%S", | ||
| handlers=[log_console_handler, log_file_handler], | ||
| ) | ||
|
|
||
| logger.info(f"Log file: {logs_filepath}") | ||
|
|
||
| headers() | ||
|
|
||
|
|
||
| def headers(): | ||
| """Basic information to log before other message.""" | ||
| # initialize the log | ||
| logger.info(f"{'='*10} {__title__} - {__version__} {'='*10}") | ||
| logger.debug(f"Operating System: {platform()}") | ||
| logger.debug(f"Architecture: {architecture()[0]}") | ||
| logger.debug(f"Computer: {gethostname()}") | ||
| logger.debug(f"Launched by user: {getuser()}") | ||
|
|
||
| if getenv("userdomain"): | ||
| logger.debug(f"OS Domain: {getenv('userdomain')}") | ||
|
|
||
| if get_proxy_settings(): | ||
| logger.debug(f"Network proxies detected: {get_proxy_settings()}") | ||
| else: | ||
| logger.debug("No network proxies detected") | ||
|
|
||
| if str2bool(getenv("QDT_SSL_USE_SYSTEM_STORES", False)): | ||
| logger.debug("Option to use native system certificates stores is enabled.") | ||
| if "REQUESTS_CA_BUNDLE" in environ: | ||
| environ.pop("REQUESTS_CA_BUNDLE") | ||
| logger.debug( | ||
| "Custom path to CA Bundle (REQUESTS_CA_BUNDLE) has been removed from " | ||
| "environment variables." | ||
| ) | ||
| if "CURL_CA_BUNDLE" in environ: | ||
| environ.pop("CURL_CA_BUNDLE") | ||
| logger.debug( | ||
| "Custom path to CA Bundle (CURL_CA_BUNDLE) has been removed from " | ||
| "environment variables." | ||
| ) | ||
|
|
||
|
|
||
| def get_logger_filepath() -> Optional[Path]: | ||
| """Retrieve log filepath within logger handlers. | ||
| Returns: | ||
| Path | None: path to the logfile or None if no handler has baseFilename attr. | ||
| """ | ||
| if logger.root.hasHandlers(): | ||
| for handler in logger.root.handlers: | ||
| if hasattr(handler, "baseFilename"): | ||
| return Path(handler.baseFilename) | ||
|
|
||
| logger.warning("No file found in ay log handlers.") | ||
| return None |
Oops, something went wrong.