Spaces:
Sleeping
Sleeping
File size: 5,441 Bytes
72a3513 |
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 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
"""
Generic logging helpers for scripts, notebooks and Ray clusters.
"""
from __future__ import annotations
import logging, sys, os, warnings
from pathlib import Path
from datetime import datetime
from typing import Iterable, Optional
from IPython import get_ipython
# --------------------------------------------------------------------------- #
# Helper classes #
# --------------------------------------------------------------------------- #
class DisableLogger:
"""Context‑manager that suppresses *all* logging inside its scope."""
def __enter__(self):
logging.disable(logging.CRITICAL)
def __exit__(self, exc_type, exc_val, exc_tb):
logging.disable(logging.NOTSET)
class HiddenPrints:
"""Context‑manager that suppresses *print* output inside its scope."""
def __enter__(self):
self._orig = sys.stdout
sys.stdout = open(os.devnull, "w")
def __exit__(self, exc_type, exc_val, exc_tb):
sys.stdout.close()
sys.stdout = self._orig
# --------------------------------------------------------------------------- #
# Notebook‑aware console handler #
# --------------------------------------------------------------------------- #
def _in_notebook() -> bool:
ip = get_ipython()
return bool(ip) and ip.__class__.__name__ == "ZMQInteractiveShell"
class TqdmHandler(logging.StreamHandler):
"""Write via tqdm.write so log lines don't break progress bars."""
def emit(self, record):
try:
from tqdm import tqdm
tqdm.write(self.format(record), end=self.terminator)
except ModuleNotFoundError:
super().emit(record)
# --------------------------------------------------------------------------- #
# Public initialisation API #
# --------------------------------------------------------------------------- #
def init_logger(
*,
name: str = "app",
console_level: str | int = "ERROR",
file_level: str | int = "INFO",
log_dir: str | os.PathLike = ".",
redirect_tqdm: bool = True,
) -> logging.Logger:
"""
Initialise (or fetch) a namespaced logger that works in scripts &
notebooks. Idempotent ‑ safe to call multiple times.
Returns
-------
logging.Logger
Configured logger instance.
"""
logger = logging.getLogger(name)
if logger.handlers: # already configured
return logger
logger.setLevel("DEBUG") # capture everything; handlers filter
# console / notebook handler
if _in_notebook() or (redirect_tqdm and "tqdm" in sys.modules):
ch: logging.Handler = TqdmHandler()
else:
ch = logging.StreamHandler(sys.stderr)
ch.setLevel(console_level)
ch.setFormatter(
logging.Formatter(
"%(asctime)s | %(levelname)-8s | %(message)s",
datefmt="%H:%M:%S",
)
)
logger.addHandler(ch)
# rotating file handler (one file per session)
Path(log_dir).mkdir(parents=True, exist_ok=True)
stamp = datetime.now().strftime("%Y%m%d_%H%M%S")
fh = logging.FileHandler(Path(log_dir) / f"{name}_{stamp}.log", encoding="utf-8")
fh.setLevel(file_level)
fh.setFormatter(
logging.Formatter(
"%(asctime)s | %(name)s | %(levelname)-8s | %(message)s",
datefmt="%Y-%m-%d %H:%M:%S",
)
)
logger.addHandler(fh)
# logger.propagate = False # Removed correctly
log_file_path = fh.baseFilename
logger.info("Logging initialised → %s", log_file_path)
return logger, log_file_path # <-- Return path too
# --------------------------------------------------------------------------- #
# Optional Ray‑specific configuration helpers #
# --------------------------------------------------------------------------- #
def init_ray_logging(
*,
python_level: str | int = "ERROR",
backend_level: str = "error",
log_to_driver: bool = False,
filter_userwarnings: bool = True,
) -> "ray.LoggingConfig":
"""
Prepare environment + Ray LoggingConfig **before** `ray.init()`.
Returns
-------
ray.LoggingConfig
Pass as `logging_config=` argument to `ray.init()`.
"""
# 1) silence C++ backend (raylet / plasma) BEFORE importing ray
os.environ.setdefault("RAY_BACKEND_LOG_LEVEL", backend_level)
# 2) optional warnings filter
if filter_userwarnings:
warnings.filterwarnings("ignore", category=UserWarning)
import ray # local import to avoid hard dep
# 3) global Python logger levels for every worker
ray_logger_names: Iterable[str] = (
"ray",
"ray.worker",
"ray.runtime",
"ray.dashboard",
"ray.tune",
"ray.serve",
)
for n in ray_logger_names:
logging.getLogger(n).setLevel(python_level)
# 4) build LoggingConfig that propagates to workers
return ray.LoggingConfig(
log_to_driver=log_to_driver,
log_level=python_level,
)
def silence_logger(
logger_name: str,
level: int | str = logging.ERROR,
):
"""
Call at the *top* of every `@ray.remote` function or actor `__init__`
to raise the threshold of a chatty library **inside the worker**.
"""
logging.getLogger(logger_name).setLevel(level)
|