File size: 12,207 Bytes
9c6594c |
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 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 |
"""Global functions for printing to stderr for wandb."""
from __future__ import annotations
import contextlib
import logging
import os
import re
import shutil
import sys
import threading
from typing import TYPE_CHECKING, Iterator, Protocol
import click
if TYPE_CHECKING:
import wandb
LOG_STRING = click.style("wandb", fg="blue", bold=True)
LOG_STRING_NOCOLOR = "wandb"
ERROR_STRING = click.style("ERROR", bg="red", fg="green")
WARN_STRING = click.style("WARNING", fg="yellow")
_silent: bool = False
"""If true, _logger is used instead of printing to stderr."""
_logger: SupportsLeveledLogging | None = None
"""A fallback logger for _silent mode."""
_show_info: bool = True
"""If false, then termlog() uses silent mode (see _silent)."""
_show_warnings: bool = True
"""If false, then termwarn() uses silent mode (see _silent)."""
_show_errors: bool = True
"""If false, then termerror() uses silent mode (see _silent)."""
_printed_messages: set[str] = set()
"""Messages logged with repeat=False."""
_dynamic_text_lock = threading.Lock()
"""Lock held for dynamic text operations.
All uses of `_dynamic_blocks` and calls to functions that start with
the `_l_` prefix must be guarded by this lock.
"""
_dynamic_blocks: list[DynamicBlock] = []
"""Active dynamic text areas, created with dynamic_text()."""
class SupportsLeveledLogging(Protocol):
"""Portion of the standard logging.Logger used in this module."""
def info(self, msg: str) -> None: ...
def warning(self, msg: str) -> None: ...
def error(self, msg: str) -> None: ...
def termsetup(
settings: wandb.Settings,
logger: SupportsLeveledLogging | None,
) -> None:
"""Configure the global logging functions.
Args:
settings: The settings object passed to wandb.setup() or wandb.init().
logger: A fallback logger to use for "silent" mode. In this mode,
the logger is used instead of printing to stderr.
"""
global _silent, _show_info, _show_warnings, _show_errors, _logger
_silent = settings.silent
_show_info = settings.show_info
_show_warnings = settings.show_warnings
_show_errors = settings.show_errors
_logger = logger
@contextlib.contextmanager
def dynamic_text() -> Iterator[DynamicBlock | None]:
"""A context manager that provides a handle to a new dynamic text area.
The text goes to stderr. Returns None if dynamic text is not supported.
Dynamic text must only be used while `wandb` has control of the terminal,
or else text written by other programs will be overwritten. It's
appropriate to use during a blocking operation.
```
with term.dynamic_text() as text_area:
if text_area:
text_area.set_text("Writing to a terminal.")
for i in range(2000):
text_area.set_text(f"Still going... ({i}/2000)")
time.sleep(0.001)
else:
wandb.termlog("Writing to a file or dumb terminal.")
time.sleep(1)
wandb.termlog("Finished 1000/2000 tasks, still working...")
time.sleep(1)
wandb.termlog("Done!", err=True)
```
"""
# For now, dynamic text always corresponds to the "INFO" level.
if _silent or not _show_info:
yield None
return
# NOTE: In Jupyter notebooks, this will return False. Notebooks
# support ANSI color sequences and the '\r' character, but not
# cursor motions or line clear commands.
if not _sys_stderr_isatty():
yield None
return
# This is a convention to indicate that the terminal doesn't support
# clearing the screen / positioning the cursor.
if os.environ.get("TERM") == "dumb":
yield None
return
# NOTE: On Windows < 10, ANSI escape sequences such as \x1b[Am and \x1b[2K,
# used to move the cursor and clear text, aren't supported by the built-in
# console. However, we rely on the click library's use of colorama which
# emulates support for such sequences.
#
# For this reason, we don't have special checks for Windows.
block = DynamicBlock()
with _dynamic_text_lock:
_dynamic_blocks.append(block)
try:
yield block
finally:
with _dynamic_text_lock:
block._lines_to_print = []
_l_rerender_dynamic_blocks()
_dynamic_blocks.remove(block)
def _sys_stderr_isatty() -> bool:
"""Returns sys.stderr.isatty().
Defined here for patching in tests.
"""
return sys.stderr.isatty()
def termlog(
string: str = "",
newline: bool = True,
repeat: bool = True,
prefix: bool = True,
) -> None:
r"""Log an informational message to stderr.
The message may contain ANSI color sequences and the \n character.
Colors are stripped if stderr is not a TTY.
Args:
string: The message to display.
newline: Whether to add a newline to the end of the string.
repeat: If false, then the string is not printed if an exact match has
already been printed through any of the other logging functions
in this file.
prefix: Whether to include the 'wandb:' prefix.
"""
_log(
string,
newline=newline,
repeat=repeat,
prefix=prefix,
silent=not _show_info,
)
def termwarn(
string: str,
newline: bool = True,
repeat: bool = True,
prefix: bool = True,
) -> None:
"""Log a warning to stderr.
The arguments are the same as for `termlog()`.
"""
string = "\n".join([f"{WARN_STRING} {s}" for s in string.split("\n")])
_log(
string,
newline=newline,
repeat=repeat,
prefix=prefix,
silent=not _show_warnings,
level=logging.WARNING,
)
def termerror(
string: str,
newline: bool = True,
repeat: bool = True,
prefix: bool = True,
) -> None:
"""Log an error to stderr.
The arguments are the same as for `termlog()`.
"""
string = "\n".join([f"{ERROR_STRING} {s}" for s in string.split("\n")])
_log(
string,
newline=newline,
repeat=repeat,
prefix=prefix,
silent=not _show_errors,
level=logging.ERROR,
)
class DynamicBlock:
"""A handle to a changeable text area in the terminal."""
def __init__(self):
self._lines_to_print = []
self._num_lines_printed = 0
def set_text(self, text: str, prefix=True) -> None:
r"""Replace the text in this block.
Args:
text: The text to put in the block, with lines separated
by \n characters. The text should not end in \n unless
a blank line at the end of the block is desired.
prefix: Whether to include the "wandb:" prefix.
"""
with _dynamic_text_lock:
self._lines_to_print = text.splitlines()
if prefix:
self._lines_to_print = [
f"{LOG_STRING}: {line}" for line in self._lines_to_print
]
_l_rerender_dynamic_blocks()
def _l_clear(self) -> None:
"""Send terminal commands to clear all previously printed lines.
The lock must be held, and the cursor must be on the line after this
block of text.
"""
# NOTE: We rely on the fact that click.echo() uses colorama which
# emulates these ANSI sequences on older Windows versions.
#
# \r move cursor to start of line
# \x1b[Am move cursor up
# \x1b[2K delete line (sometimes moves cursor)
# \r move cursor to start of line
move_up_and_delete_line = "\r\x1b[Am\x1b[2K\r"
click.echo(
move_up_and_delete_line * self._num_lines_printed,
file=sys.stderr,
nl=False,
)
self._num_lines_printed = 0
def _l_print(self) -> None:
"""Print out this block of text.
The lock must be held.
"""
if self._lines_to_print:
# Trim lines before printing. This is crucial because the \x1b[Am
# (cursor up) sequence used when clearing the text moves up by one
# visual line, and the terminal may be wrapping long lines onto
# multiple visual lines.
#
# There is no ANSI escape sequence that moves the cursor up by one
# "physical" line instead. Note that the user may resize their
# terminal.
term_width = _shutil_get_terminal_width()
click.echo(
"\n".join(
_ansi_shorten(line, term_width) #
for line in self._lines_to_print
),
file=sys.stderr,
)
self._num_lines_printed += len(self._lines_to_print)
def _shutil_get_terminal_width() -> int:
"""Returns the width of the terminal.
Defined here for patching in tests.
"""
columns, _ = shutil.get_terminal_size()
return columns
_ANSI_RE = re.compile("\x1b\\[(K|.*?m)")
def _ansi_shorten(text: str, width: int) -> str:
"""Shorten text potentially containing ANSI sequences to fit a width."""
first_ansi = _ANSI_RE.search(text)
if not first_ansi:
return _raw_shorten(text, width)
if first_ansi.start() > width - 3:
return _raw_shorten(text[: first_ansi.start()], width)
return text[: first_ansi.end()] + _ansi_shorten(
text[first_ansi.end() :],
# Key part: the ANSI sequence doesn't reduce the remaining width.
width - first_ansi.start(),
)
def _raw_shorten(text: str, width: int) -> str:
"""Shorten text to fit a width, replacing the end with "...".
Unlike textwrap.shorten(), this does not drop whitespace or do anything
smart.
"""
if len(text) <= width:
return text
return text[: width - 3] + "..."
def _log(
string="",
newline=True,
repeat=True,
prefix=True,
silent=False,
level=logging.INFO,
) -> None:
with _dynamic_text_lock, _l_above_dynamic_text():
if not repeat:
if string in _printed_messages:
return
if len(_printed_messages) < 1000:
_printed_messages.add(string)
if prefix:
string = "\n".join([f"{LOG_STRING}: {s}" for s in string.split("\n")])
silent = silent or _silent
if not silent:
click.echo(string, file=sys.stderr, nl=newline)
elif not _logger:
pass # No fallback logger, so nothing to do.
elif level == logging.ERROR:
_logger.error(click.unstyle(string))
elif level == logging.WARNING:
_logger.warning(click.unstyle(string))
else:
_logger.info(click.unstyle(string))
def _l_rerender_dynamic_blocks() -> None:
"""Clear and re-print all dynamic text.
The lock must be held. The cursor must be positioned at the start of
the first line after the dynamic text area.
"""
with _l_above_dynamic_text():
# We just want the side-effect of rerendering the dynamic text.
pass
@contextlib.contextmanager
def _l_above_dynamic_text():
"""A context manager for inserting static text above any dynamic text.
The lock must be held. The cursor must be positioned at the start of the
first line after the dynamic text area.
The dynamic text is re-rendered.
"""
_l_clear_dynamic_blocks()
try:
yield
finally:
_l_print_dynamic_blocks()
def _l_clear_dynamic_blocks() -> None:
"""Delete all dynamic text.
The lock must be held, and the cursor must be positioned at the start
of the first line after the dynamic text area. After this, the cursor
is positioned at the start of the first line after all static text.
"""
for block in reversed(_dynamic_blocks):
block._l_clear()
def _l_print_dynamic_blocks() -> None:
"""Output all dynamic text.
The lock must be held. After this, the cursor is positioned at the start
of the first line after the dynamic text area.
"""
for block in _dynamic_blocks:
block._l_print()
|