pythonwrench.logging module¶

class pythonwrench.logging.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.

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

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

pythonwrench.logging.get_ipython_name() → 'TerminalInteractiveShell' | 'ZMQInteractiveShell' | None[source]¶

pythonwrench.logging.get_null_logger() → Logger[source]¶

pythonwrench.logging.log_once(msg: str, logger: str | ModuleType | None | Logger | '__parent_file__' | SupportsIterLen[str | ModuleType | None | Logger | '__parent_file__'] = '__parent_file__', *, level: int = 20) → None[source]¶

Log message to loggers at the specified level.

pythonwrench.logging.running_on_interpreter() → bool[source]¶

pythonwrench.logging.running_on_notebook() → bool[source]¶

pythonwrench.logging.running_on_terminal() → bool[source]¶

pythonwrench.logging.setup_logging_level(package_or_logger: str | ModuleType | None | Logger | '__parent_file__' | SupportsIterLen[str | ModuleType | None | Logger | '__parent_file__'] = None, level: int | None = 20, *, fmt: str | None | Formatter = '[%(asctime)s][%(name)s][%(levelname)s] - %(message)s', stream: IO[str] | '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.

pythonwrench.logging.setup_logging_verbose(package_or_logger: str | ModuleType | None | Logger | '__parent_file__' | SupportsIterLen[str | ModuleType | None | Logger | '__parent_file__'] = None, verbose: int | None = 1, *, fmt: str | None | Formatter = '[%(asctime)s][%(name)s][%(levelname)s] - %(message)s', stream: IO[str] | '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.