Coverage for kiirastuli/__init__.py: 97.78%

1"""Purgatory (Finnish: kiirastuli) - purge like hell to stay out of trouble.""" 

2 

3import datetime as dti 

4import logging 

5import os 

6import pathlib 

7from typing import List, no_type_check 

8 

9# [[[fill git_describe()]]] 

10__version__ = '2023.10.21+parent.9566ac5b' 

11# [[[end]]] (checksum: c137e319a8e17488efb630dba6452af1) 

12__version_info__ = tuple( 

13 e if '-' not in e else e.split('-')[0] for part in __version__.split('+') for e in part.split('.') if e != 'parent' 

14) 

15 

16APP_ALIAS = str(pathlib.Path(__file__).parent.name) 

17APP_ENV = APP_ALIAS.upper() 

18APP_NAME = locals()['__doc__'] 

19DEBUG = bool(os.getenv(f'{APP_ENV}_DEBUG', '')) 

20VERBOSE = bool(os.getenv(f'{APP_ENV}_VERBOSE', '')) 

21QUIET = False 

22STRICT = bool(os.getenv(f'{APP_ENV}_STRICT', '')) 

23ENCODING = 'utf-8' 

24ENCODING_ERRORS_POLICY = 'ignore' 

25DEFAULT_CONFIG_NAME = f'.{APP_ALIAS}.json' 

26 

27COMMA = ',' 

28DEFAULT_LF_ONLY = 'YES' 

29log = logging.getLogger() # Module level logger is sufficient 

30LOG_FOLDER = pathlib.Path('logs') 

31LOG_FILE = f'{APP_ALIAS}.log' 

32LOG_PATH = pathlib.Path(LOG_FOLDER, LOG_FILE) if LOG_FOLDER.is_dir() else pathlib.Path(LOG_FILE) 

33LOG_LEVEL = logging.INFO 

34 

35TS_FORMAT_LOG = '%Y-%m-%dT%H:%M:%S' 

36TS_FORMAT_PAYLOADS = '%Y-%m-%d %H:%M:%S.%f UTC' 

37 

38__all__: List[str] = [ 

39 'APP_ALIAS', 

40 'APP_NAME', 

41 'COMMA', 

42 'DEBUG', 

43 'log', 

44 'parse_csl', 

45] 

46 

47 

48def parse_csl(csl: str) -> List[str]: 

49 """DRY.""" 

50 return [fmt.strip().lower() for fmt in csl.split(COMMA) if fmt.strip()] 

51 

52 

53@no_type_check 

54def formatTime_RFC3339(self, record, datefmt=None): # noqa 

55 """HACK A DID ACK we could inject .astimezone() to localize ...""" 

56 return dti.datetime.fromtimestamp(record.created, dti.timezone.utc).isoformat() # pragma: no cover 

57 

58 

59@no_type_check 

60def init_logger(name=None, level=None): 

61 """Initialize module level logger""" 

62 global log # pylint: disable=global-statement 

63 

64 log_format = { 

65 'format': '%(asctime)s %(levelname)s [%(name)s]: %(message)s', 

66 'datefmt': TS_FORMAT_LOG, 

67 # 'filename': LOG_PATH, 

68 'level': LOG_LEVEL if level is None else level, 

69 } 

70 logging.Formatter.formatTime = formatTime_RFC3339 

71 logging.basicConfig(**log_format) 

72 log = logging.getLogger(APP_ENV if name is None else name) 

73 log.propagate = True 

74 

75 

76init_logger(name=APP_ENV, level=logging.DEBUG if DEBUG else None)