Spaces:
Running on Zero
Running on Zero
File size: 1,867 Bytes
79cf149 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | """Command-line plumbing shared by the entry points in this package.
Each script had its own `logging.basicConfig` call and its own format string,
and two of them separately re-encoded stdout for the same reason. Both belong
in one place: the reason for the console fix is worth stating once, and three
named formats are easier to choose between than six ad-hoc ones.
"""
import logging
import sys
from typing import Optional, TextIO
# Level with no name, for a terse one-shot command.
PLAIN: str = "%(levelname)s %(message)s"
# Level and logger name, for output where the source module matters.
NAMED: str = "%(levelname)-7s %(name)s: %(message)s"
# Stamped, for a long run where elapsed time is the useful signal.
TIMED: str = "%(asctime)s %(levelname)-7s %(name)s: %(message)s"
CLOCK: str = "%H:%M:%S"
def console_utf8() -> None:
"""Makes stdout tolerate the characters filings actually contain.
Filings carry rupee signs and typographic dashes. A Windows console
defaults to cp1252 and raises on the first one, which would end a run
that had otherwise succeeded.
"""
if not hasattr(sys.stdout, "reconfigure"):
return
try:
sys.stdout.reconfigure(encoding="utf-8", errors="replace")
except (ValueError, OSError): # pragma: no cover - redirected stdout
pass
def setup(
level: int = logging.INFO,
fmt: str = PLAIN,
stream: Optional[TextIO] = None,
datefmt: Optional[str] = None,
) -> None:
"""Prepares the console and root logging for a command-line run.
Args:
level: Root logging level.
fmt: One of `PLAIN`, `NAMED` or `TIMED`.
stream: Where records go; stderr keeps them clear of piped output.
datefmt: Timestamp format, for `TIMED`.
"""
console_utf8()
logging.basicConfig(level=level, format=fmt, stream=stream, datefmt=datefmt)
|