Administration/pmbootstrap-meow
2
0
Fork 0
forked from Mirror/pmbootstrap
Code Pull requests Activity Actions

helpers: logging: fixes + details_to_stdout in color (MR 2252)

Browse source 
* Fix details_to_stdout which was broken due to a previous commit.
* Improve support for custom colors with "@COLOR@" (e.g. "@BLUE@"), stop
  it from being printed unformatted to the logfile.
* Rework how the logfd is handled so that --details-to-stdout won't
  disable all color output.

Signed-off-by: Caleb Connolly <caleb@postmarketos.org>
This commit is contained in:
Caleb Connolly 2024-06-14 03:14:32 +02:00 • committed by Oliver Smith
parent 53bdb523e3
commit c4b4c41b8d
No known key found for this signature in database
GPG key ID: 5AE7F5513E0885CB
1 changed files with 22 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

47
pmb/helpers/logging.py
View file

@ -4,7 +4,7 @@ import logging
import os
from pathlib import Path
import sys
from typing import TextIO
from typing import Dict, TextIO
import pmb.config
logfd: TextIO
@ -24,7 +24,7 @@ class log_handler(logging.StreamHandler):
def __init__(self, details_to_stdout: bool=False, quiet: bool=False):
super().__init__()
self.details_to_stdout = False
self.details_to_stdout = details_to_stdout
self.quiet = False
def emit(self, record):
@ -32,9 +32,9 @@ class log_handler(logging.StreamHandler):
msg = self.format(record)
# INFO or higher: Write to stdout
if (not self.details_to_stdout and
not self.quiet and
record.levelno >= logging.INFO):
if (self.details_to_stdout or
(not self.quiet and
record.levelno >= logging.INFO)):
stream = self.stream
styles = pmb.config.styles
@ -65,28 +65,13 @@ class log_handler(logging.StreamHandler):
f"{styles['GREEN']}*** ",
1,
)
.replace(
"@BLUE@",
f"{styles['BLUE']}",
)
.replace(
"@YELLOW@",
f"{styles['YELLOW']}",
)
.replace(
"@RED@",
f"{styles['RED']}",
)
.replace(
"@GREEN@",
f"{styles['GREEN']}",
)
.replace(
"@END@",
f"{styles['END']}",
)
)
for key, value in styles.items():
msg_col = msg_col.replace(f"@{key}@", value)
# Strip from the normal log message
msg = msg.replace(f"@{key}@", "")
msg_col += styles["END"]
stream.write(msg_col)
@ -94,6 +79,7 @@ class log_handler(logging.StreamHandler):
self.flush()
# Everything: Write to logfd
if not self.details_to_stdout:
msg = "(" + str(os.getpid()).zfill(6) + ") " + msg
logfd.write(msg + "\n")
logfd.flush()
@ -131,19 +117,16 @@ def init(logfile: Path, verbose: bool, details_to_stdout: bool=False):
warning("Logging already initialized, skipping...")
return
# Set log file descriptor (logfd)
if details_to_stdout:
logfd = sys.stdout
else:
# Require containing directory to exist (so we don't create the work
# folder and break the folder migration logic, which needs to set the
# version upon creation)
dir = os.path.dirname(logfile)
if os.path.exists(dir):
if not details_to_stdout and logfile.parent.exists():
logfd = open(logfile, "a+")
logfd.write("\n\n")
elif details_to_stdout:
logfd = sys.stdout
else:
logfd = open(os.devnull, "a+")
logfd = open(os.devnull, "w")
# Set log format
root_logger = logging.getLogger()