torchoutil.pyoutil.logging module

class MkdirFileHandler(
filename: str | Path,
mode: str = 'a',
encoding: str | None = None,
delay: bool = True,
errors: str | None = None,
*,
mkdir_parents: bool = True,
mkdir_exist_ok: bool = True,
)[source]

Bases: FileHandler

FileHandler that build intermediate directories to filename.

Used for export hydra logs to a file contained in a folder that does not exists yet at the start of the program.

get_current_file_logger(
*,
parent_deep: int = 1,
default: ~torchoutil.pyoutil.logging.T = <RootLogger root (WARNING)>,
) → Logger | T[source]

Returns the logger of the caller file. If this cannot be found, returns the root logger.

get_ipython_name() → Literal['TerminalInteractiveShell', 'ZMQInteractiveShell'] | None[source]
get_null_logger() → Logger[source]
log_once(
msg: str,
logger: str | module | None | Logger | Literal['__parent_file__'] | Sequence[str | module | None | Logger | Literal['__parent_file__']] = '__parent_file__',
*,
level: int = 20,
) → None[source]

Log message to loggers at the specified level.

running_on_interpreter() → bool[source]
running_on_notebook() → bool[source]
running_on_terminal() → bool[source]
setup_logging_level(
package_or_logger: str | module | None | Logger | Literal['__parent_file__'] | Sequence[str | module | None | Logger | Literal['__parent_file__']] = None,
level: int | None = 20,
*,
fmt: str | None | Formatter = '[%(asctime)s][%(name)s][%(levelname)s] - %(message)s',
stream: IO[str] | Literal['auto'] = 'auto',
set_fmt: bool = True,
capture_warnings: bool = True,
autoreload: bool = True,
) → None[source]

Helper function to customize logging messages using logging.level.

Note: Lower level values means more debug messages.

setup_logging_verbose(
package_or_logger: str | module | None | Logger | Literal['__parent_file__'] | Sequence[str | module | None | Logger | Literal['__parent_file__']] = None,
verbose: int | None = 1,
*,
fmt: str | None | Formatter = '[%(asctime)s][%(name)s][%(levelname)s] - %(message)s',
stream: IO[str] | Literal['auto'] = 'auto',
set_fmt: bool = True,
capture_warnings: bool = True,
autoreload: bool = True,
) → None[source]

Helper function to customize logging messages using verbose_level.

Note: Higher verbose values means more debug messages.

warn_once(
*args,
**kwargs,
)[source]