mirror of
https://gitlab.com/allianceauth/allianceauth.git
synced 2026-02-10 09:06:21 +01:00
a6b340c179
- update string format method - remove redundant default arguments from function calls - remove unused imports - remove unicode identifier from strings, it's default in py3 (see: https://stackoverflow.com/a/4182635/12201331)
90 lines
2.5 KiB
Python
90 lines
2.5 KiB
Python
import logging
|
|
import os
|
|
|
|
from django.conf import settings
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class LoggerAddTag(logging.LoggerAdapter):
|
|
"""add custom tag to a logger"""
|
|
def __init__(self, logger, prefix):
|
|
super().__init__(logger, {})
|
|
self.prefix = prefix
|
|
|
|
def process(self, msg, kwargs):
|
|
return f'[{self.prefix}] {msg}', kwargs
|
|
|
|
|
|
def clean_setting(
|
|
name: str,
|
|
default_value: object,
|
|
min_value: int = None,
|
|
max_value: int = None,
|
|
required_type: type = None
|
|
):
|
|
"""cleans the input for a custom setting
|
|
|
|
Will use `default_value` if settings does not exit or has the wrong type
|
|
or is outside define boundaries (for int only)
|
|
|
|
Need to define `required_type` if `default_value` is `None`
|
|
|
|
Will assume `min_value` of 0 for int (can be overriden)
|
|
|
|
Returns cleaned value for setting
|
|
"""
|
|
if default_value is None and not required_type:
|
|
raise ValueError('You must specify a required_type for None defaults')
|
|
|
|
if not required_type:
|
|
required_type = type(default_value)
|
|
|
|
if min_value is None and required_type == int:
|
|
min_value = 0
|
|
|
|
if not hasattr(settings, name):
|
|
cleaned_value = default_value
|
|
else:
|
|
if (
|
|
isinstance(getattr(settings, name), required_type)
|
|
and (min_value is None or getattr(settings, name) >= min_value)
|
|
and (max_value is None or getattr(settings, name) <= max_value)
|
|
):
|
|
cleaned_value = getattr(settings, name)
|
|
else:
|
|
logger.warning(
|
|
'You setting for %s it not valid. Please correct it. '
|
|
'Using default for now: %s',
|
|
name,
|
|
default_value
|
|
)
|
|
cleaned_value = default_value
|
|
return cleaned_value
|
|
|
|
|
|
def set_logger_to_file(logger_name: str, name: str) -> object:
|
|
"""set logger for current module to log into a file. Useful for tests.
|
|
|
|
Args:
|
|
- logger: current logger object
|
|
- name: name of current module, e.g. __file__
|
|
|
|
Returns:
|
|
- amended logger
|
|
"""
|
|
|
|
# reconfigure logger so we get logging from tested module
|
|
f_format = logging.Formatter(
|
|
'%(asctime)s - %(levelname)s - %(module)s:%(funcName)s - %(message)s'
|
|
)
|
|
path = os.path.splitext(name)[0]
|
|
f_handler = logging.FileHandler(f'{path}.log', 'w+')
|
|
f_handler.setFormatter(f_format)
|
|
logger = logging.getLogger(logger_name)
|
|
logger.level = logging.DEBUG
|
|
logger.addHandler(f_handler)
|
|
logger.propagate = False
|
|
return logger
|