dotools_py.settings.set_kernel_logger

dotools_py.settings.set_kernel_logger(filename='./History.log', overwrite=False, session='activate')

Save kernel history in a file.

Parameters:

filename str | Path (default: './History.log')

Absolute path to the log file.

overwrite bool (default: False)

Whether the log file should be overwritten or not.

session Literal['activate', 'deactivate'] (default: 'activate')

Activate or deactivate the history logging.

Return type:

None

Returns:

Returns None.

Examples

>>> import dotools_py as do
>>> do.settings.set_kernel_logger('./History.log')
>>> adata = do.dt.example_10x_processed()
>>> adata
>>> do.settings.toogle_kernel_logger(False)
>>> print(open("History.log").read())
========== KERNEL SESSION START 2025-12-12 13:48:22.118424 ==========
[CODE 2025-12-12 13:48:22.120206]
>>> do.settings.set_kernel_logger('./History.log')
[CODE 2025-12-12 13:48:22.734407]
>>> adata = do.dt.example_10x_processed()
[CODE 2025-12-12 13:48:23.606794]
>>> adata
[OUTPUT 2025-12-12 13:48:23.609162]
AnnData object with n_obs × n_vars = 700 × 1851
    obs: 'batch', 'condition', 'n_genes_by_counts', 'log1p_n_genes_by_counts', 'total_counts', 'log1p_total_counts', 'total_counts_mt', 'log1p_total_counts_mt', 'pct_counts_mt', 'total_counts_ribo', 'log1p_total_counts_ribo', 'pct_counts_ribo', 'n_genes', 'n_counts', 'doublet_class', 'doublet_score', 'leiden', 'cell_type', 'autoAnnot', 'celltypist_conf_score', 'annotation', 'annotation_recluster'
    var: 'mean', 'std', 'highly_variable', 'means', 'dispersions', 'dispersions_norm', 'highly_variable_nbatches', 'highly_variable_intersection'
    uns: 'annotation_colors', 'annotation_recluster_colors', 'batch_colors', 'hvg', 'leiden', 'leiden_colors', 'log1p', 'neighbors', 'pca', 'umap'
    obsm: 'X_CCA', 'X_pca', 'X_umap'
    varm: 'PCs'
    layers: 'counts', 'logcounts'
    obsp: 'connectivities', 'distances'
========== KERNEL SESSION PAUSED 2025-12-12 13:48:25.090038 ==========