spateo.external.lack

Module Contents

Classes

Logger	Aristotle ecosystem-specific logger setting up logging for the package.
LoggerManager

Functions

silence_logger(name)	Given a logger name, silence it completely.
set_logger_level(name, level)	Given a logger name, silence it completely.
format_logging_message(msg, logging_level[, ...])

spateo.external.lack.silence_logger(name)

Given a logger name, silence it completely.

Parameters:

name str

name of the logger

spateo.external.lack.set_logger_level(name, level)

Given a logger name, silence it completely.

Parameters:

name str

name of the logger

spateo.external.lack.format_logging_message(msg, logging_level, indent_level=1, indent_space_num=6)

class spateo.external.lack.Logger(namespace='main', level=None)

Aristotle ecosystem-specific logger setting up logging for the package.

FORMAT = '%(message)s'

namespaced(namespace)

Function decorator to set the logging namespace for the duration of the function.

Parameters:

namespace str

the namespace

namespaced_context(namespace)

Context manager to set the logging namespace.

Parameters:

namespace str

the namespace

namespace_message(message)

Add namespace information at the beginning of the logging message.

Parameters:

message str

the logging message

Returns:

namespaced message

Return type:

string

setLevel(*args, **kwargs)

debug(message, indent_level=1, *args, **kwargs)

info(message, indent_level=1, *args, **kwargs)

warning(message, indent_level=1, *args, **kwargs)

exception(message, indent_level=1, *args, **kwargs)

critical(message, indent_level=1, *args, **kwargs)

error(message, indent_level=1, *args, **kwargs)

info_insert_adata(key, adata_attr='obsm', indent_level=1, *args, **kwargs)

info_insert_adata_var(key, indent_level=1, *args, **kwargs)

info_insert_adata_obsm(key, indent_level=1, *args, **kwargs)

info_insert_adata_uns(key, indent_level=1, *args, **kwargs)

log_time()

report_progress(percent=None, count=None, total=None, progress_name='', indent_level=1)

finish_progress(progress_name='', time_unit='s', indent_level=1)

request_report_hook(bn: int, rs: int, ts: int) → None

A callback required by the request lib: The reporthook argument should be a callable that accepts a block number, a read size, and the total file size of the URL target. The data argument should be valid URL encoded data.

Parameters:

bs

block number

rs

read size

ts

total size

class spateo.external.lack.LoggerManager(namespace: str = 'lack', temp_timer_logger: str = 'lack-temp-timer-logger')

DEBUG

INFO

CRITICAL

EXCEPTION

static gen_logger(namespace: str)

set_main_logger_namespace(namespace: str)

get_main_logger()

get_temp_timer_logger()

progress_logger(generator, logger=None, progress_name='', indent_level=1)

main_set_level(level)

main_info(message, indent_level=1)

main_debug(message, indent_level=1)

main_warning(message, indent_level=1)

main_exception(message, indent_level=1)

main_critical(message, indent_level=1)

main_tqdm(generator, desc='', indent_level=1, logger=None)

a TQDM style wrapper for logging something like a loop. e.g. for item in main_tqdm(alist, desc=””):

do something

Parameters:

generator [type]

same as what you put in tqdm

desc str, optional

description of your progress

main_log_time()

main_silence()

main_finish_progress(progress_name='')

main_info_insert_adata(key, adata_attr='obsm', indent_level=1, *args, **kwargs)

main_info_insert_adata_var(key, indent_level=1, *args, **kwargs)

main_info_insert_adata_uns(key, indent_level=1, *args, **kwargs)

main_info_insert_adata_obsm(key, indent_level=1, *args, **kwargs)

main_info_insert_adata_obs(key, indent_level=1, *args, **kwargs)

main_info_insert_adata_layer(key, indent_level=1, *args, **kwargs)

main_info_verbose_timeit(msg)