Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6090995eba | ||
|
|
60db747d6d | ||
|
|
a7a4141f58 | ||
|
|
2b04cbe239 | ||
|
|
765cc061c1 | ||
|
|
80319385f0 | ||
|
|
29dd906fe0 | ||
|
|
d5dc4028c3 | ||
|
|
0df049d453 |
2
ToDo.md
2
ToDo.md
@@ -3,3 +3,5 @@
|
|||||||
- [x] stub files .pyi
|
- [x] stub files .pyi
|
||||||
- [ ] Add tests for all, we need 100% test coverate
|
- [ ] Add tests for all, we need 100% test coverate
|
||||||
- [x] Log: add custom format for "stack_correct" if set, this will override the normal stack block
|
- [x] Log: add custom format for "stack_correct" if set, this will override the normal stack block
|
||||||
|
- [ ] Log: add rotate for size based
|
||||||
|
- [ ] All folders and file names need to be revisited for naming and content collection
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
# MARK: Project info
|
# MARK: Project info
|
||||||
[project]
|
[project]
|
||||||
name = "corelibs"
|
name = "corelibs"
|
||||||
version = "0.21.1"
|
version = "0.22.3"
|
||||||
description = "Collection of utils for Python scripts"
|
description = "Collection of utils for Python scripts"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
requires-python = ">=3.13"
|
requires-python = ">=3.13"
|
||||||
|
|||||||
@@ -7,8 +7,10 @@ attach "init_worker_logging" with the set log_queue
|
|||||||
import re
|
import re
|
||||||
import logging.handlers
|
import logging.handlers
|
||||||
import logging
|
import logging
|
||||||
|
from datetime import datetime
|
||||||
import time
|
import time
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
import atexit
|
||||||
from typing import MutableMapping, TextIO, TypedDict, Any, TYPE_CHECKING, cast
|
from typing import MutableMapping, TextIO, TypedDict, Any, TYPE_CHECKING, cast
|
||||||
from corelibs.logging_handling.logging_level_handling.logging_level import LoggingLevel
|
from corelibs.logging_handling.logging_level_handling.logging_level import LoggingLevel
|
||||||
from corelibs.string_handling.text_colors import Colors
|
from corelibs.string_handling.text_colors import Colors
|
||||||
@@ -23,6 +25,7 @@ class LogSettings(TypedDict):
|
|||||||
"""log settings, for Log setup"""
|
"""log settings, for Log setup"""
|
||||||
log_level_console: LoggingLevel
|
log_level_console: LoggingLevel
|
||||||
log_level_file: LoggingLevel
|
log_level_file: LoggingLevel
|
||||||
|
per_run_log: bool
|
||||||
console_enabled: bool
|
console_enabled: bool
|
||||||
console_color_output_enabled: bool
|
console_color_output_enabled: bool
|
||||||
add_start_info: bool
|
add_start_info: bool
|
||||||
@@ -280,6 +283,15 @@ class LogParent:
|
|||||||
return False
|
return False
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
def _cleanup(self):
|
||||||
|
"""cleanup for any open queues in case we have an abort"""
|
||||||
|
if not self.log_queue:
|
||||||
|
return
|
||||||
|
self.flush()
|
||||||
|
# Close the queue properly
|
||||||
|
self.log_queue.close()
|
||||||
|
self.log_queue.join_thread()
|
||||||
|
|
||||||
# MARK: log level handling
|
# MARK: log level handling
|
||||||
def set_log_level(self, handler_name: str, log_level: LoggingLevel) -> bool:
|
def set_log_level(self, handler_name: str, log_level: LoggingLevel) -> bool:
|
||||||
"""
|
"""
|
||||||
@@ -392,6 +404,7 @@ class Log(LogParent):
|
|||||||
DEFAULT_LOG_SETTINGS: LogSettings = {
|
DEFAULT_LOG_SETTINGS: LogSettings = {
|
||||||
"log_level_console": DEFAULT_LOG_LEVEL_CONSOLE,
|
"log_level_console": DEFAULT_LOG_LEVEL_CONSOLE,
|
||||||
"log_level_file": DEFAULT_LOG_LEVEL_FILE,
|
"log_level_file": DEFAULT_LOG_LEVEL_FILE,
|
||||||
|
"per_run_log": False,
|
||||||
"console_enabled": True,
|
"console_enabled": True,
|
||||||
"console_color_output_enabled": True,
|
"console_color_output_enabled": True,
|
||||||
"add_start_info": True,
|
"add_start_info": True,
|
||||||
@@ -440,7 +453,7 @@ class Log(LogParent):
|
|||||||
# in the file writer too, for the ones where color is set BEFORE the format
|
# in the file writer too, for the ones where color is set BEFORE the format
|
||||||
# Any is logging.StreamHandler, logging.FileHandler and all logging.handlers.*
|
# Any is logging.StreamHandler, logging.FileHandler and all logging.handlers.*
|
||||||
self.handlers: dict[str, Any] = {}
|
self.handlers: dict[str, Any] = {}
|
||||||
self.add_handler('file_handler', self.__create_timed_rotating_file_handler(
|
self.add_handler('file_handler', self.__create_file_handler(
|
||||||
'file_handler', self.log_settings['log_level_file'], log_path)
|
'file_handler', self.log_settings['log_level_file'], log_path)
|
||||||
)
|
)
|
||||||
if self.log_settings['console_enabled']:
|
if self.log_settings['console_enabled']:
|
||||||
@@ -492,6 +505,7 @@ class Log(LogParent):
|
|||||||
default_log_settings[__log_entry] = LoggingLevel.from_any(__log_level)
|
default_log_settings[__log_entry] = LoggingLevel.from_any(__log_level)
|
||||||
# check bool
|
# check bool
|
||||||
for __log_entry in [
|
for __log_entry in [
|
||||||
|
"per_run_log",
|
||||||
"console_enabled",
|
"console_enabled",
|
||||||
"console_color_output_enabled",
|
"console_color_output_enabled",
|
||||||
"add_start_info",
|
"add_start_info",
|
||||||
@@ -566,24 +580,35 @@ class Log(LogParent):
|
|||||||
return console_handler
|
return console_handler
|
||||||
|
|
||||||
# MARK: file handler
|
# MARK: file handler
|
||||||
def __create_timed_rotating_file_handler(
|
def __create_file_handler(
|
||||||
self, handler_name: str,
|
self, handler_name: str,
|
||||||
log_level_file: LoggingLevel, log_path: Path,
|
log_level_file: LoggingLevel, log_path: Path,
|
||||||
|
# for TimedRotating, if per_run_log is off
|
||||||
when: str = "D", interval: int = 1, backup_count: int = 0
|
when: str = "D", interval: int = 1, backup_count: int = 0
|
||||||
) -> logging.handlers.TimedRotatingFileHandler:
|
) -> logging.handlers.TimedRotatingFileHandler | logging.FileHandler:
|
||||||
# file logger
|
# file logger
|
||||||
# when: S/M/H/D/W0-W6/midnight
|
# when: S/M/H/D/W0-W6/midnight
|
||||||
# interval: how many, 1D = every day
|
# interval: how many, 1D = every day
|
||||||
# backup_count: how many old to keep, 0 = all
|
# backup_count: how many old to keep, 0 = all
|
||||||
if not self.validate_log_level(log_level_file):
|
if not self.validate_log_level(log_level_file):
|
||||||
log_level_file = self.DEFAULT_LOG_LEVEL_FILE
|
log_level_file = self.DEFAULT_LOG_LEVEL_FILE
|
||||||
file_handler = logging.handlers.TimedRotatingFileHandler(
|
if self.log_settings['per_run_log']:
|
||||||
filename=log_path,
|
# log path, remove them stem (".log"), then add the datetime and add .log again
|
||||||
encoding="utf-8",
|
now = datetime.now()
|
||||||
when=when,
|
# we add microseconds part to get milli seconds
|
||||||
interval=interval,
|
new_stem=f"{log_path.stem}.{now.strftime('%Y-%m-%d_%H-%M-%S')}.{str(now.microsecond)[:3]}"
|
||||||
backupCount=backup_count
|
file_handler = logging.FileHandler(
|
||||||
)
|
filename=log_path.with_name(f"{new_stem}{log_path.suffix}"),
|
||||||
|
encoding="utf-8",
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
file_handler = logging.handlers.TimedRotatingFileHandler(
|
||||||
|
filename=log_path,
|
||||||
|
encoding="utf-8",
|
||||||
|
when=when,
|
||||||
|
interval=interval,
|
||||||
|
backupCount=backup_count
|
||||||
|
)
|
||||||
formatter_file_handler = logging.Formatter(
|
formatter_file_handler = logging.Formatter(
|
||||||
(
|
(
|
||||||
# time stamp
|
# time stamp
|
||||||
@@ -619,6 +644,7 @@ class Log(LogParent):
|
|||||||
if log_queue is None:
|
if log_queue is None:
|
||||||
return
|
return
|
||||||
self.log_queue = log_queue
|
self.log_queue = log_queue
|
||||||
|
atexit.register(self.stop_listener)
|
||||||
self.listener = logging.handlers.QueueListener(
|
self.listener = logging.handlers.QueueListener(
|
||||||
self.log_queue,
|
self.log_queue,
|
||||||
*self.handlers.values(),
|
*self.handlers.values(),
|
||||||
@@ -633,6 +659,7 @@ class Log(LogParent):
|
|||||||
if self.listener is not None:
|
if self.listener is not None:
|
||||||
self.flush()
|
self.flush()
|
||||||
self.listener.stop()
|
self.listener.stop()
|
||||||
|
self._cleanup()
|
||||||
|
|
||||||
# MARK: init main log
|
# MARK: init main log
|
||||||
def __init_log(self, log_name: str) -> None:
|
def __init_log(self, log_name: str) -> None:
|
||||||
|
|||||||
@@ -24,6 +24,7 @@ def main():
|
|||||||
# "log_level_console": None,
|
# "log_level_console": None,
|
||||||
"log_level_file": 'DEBUG',
|
"log_level_file": 'DEBUG',
|
||||||
# "console_color_output_enabled": False,
|
# "console_color_output_enabled": False,
|
||||||
|
"per_run_log": True
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
logn = Logger(log.get_logger_settings())
|
logn = Logger(log.get_logger_settings())
|
||||||
|
|||||||
4
uv.lock
generated
4
uv.lock
generated
@@ -1,5 +1,5 @@
|
|||||||
version = 1
|
version = 1
|
||||||
revision = 2
|
revision = 3
|
||||||
requires-python = ">=3.13"
|
requires-python = ">=3.13"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@@ -44,7 +44,7 @@ wheels = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "corelibs"
|
name = "corelibs"
|
||||||
version = "0.21.0"
|
version = "0.22.2"
|
||||||
source = { editable = "." }
|
source = { editable = "." }
|
||||||
dependencies = [
|
dependencies = [
|
||||||
{ name = "jmespath" },
|
{ name = "jmespath" },
|
||||||
|
|||||||
Reference in New Issue
Block a user