Skip to main content

Logging utilities that work well with tqdm

Project description

Features

Cleanly store tqdm progress bar in human readable format.

2026-06-27 16:42:16,279 root INFO      Processing item 0
2026-06-27 16:42:16,310 root INFO      Processing item 1
2026-06-27 16:42:16,310 __main__ INFO      tqdm[Processing] done: 2/2 (100.0%), elapsed 0.1s, 32.77 it/s, ETA 0.0s
2026-06-27 16:42:16,331 root INFO      Nested step outer=0 inner=0
2026-06-27 16:42:16,373 __main__ INFO      tqdm[Inner 0] done: 3/3 (100.0%), elapsed 0.1s, 48.82 it/s, ETA 0.0s
2026-06-27 16:42:16,373 root INFO      Completed outer=0
2026-06-27 16:42:16,393 root INFO      Nested step outer=1 inner=0
2026-06-27 16:42:16,434 __main__ INFO      tqdm[Inner 1] done: 3/3 (100.0%), elapsed 0.1s, 49.61 it/s, ETA 0.0s
2026-06-27 16:42:16,435 root INFO      Completed outer=1
2026-06-27 16:42:16,436 __main__ INFO      tqdm[Outer] progress: 2/2 (100.0%), elapsed 0.1s, 16.04 it/s, ETA 0.0s
2026-06-27 16:42:16,436 __main__ INFO      tqdm[Outer] done: 2/2 (100.0%), elapsed 0.1s, 16.04 it/s, ETA 0.0s

Find out where the logger is called

2026-06-27 16:42:16,470 examples.otherfile INFO      Processing item 0
2026-06-27 16:42:16,501 examples.otherfile INFO      Processing item 1
2026-06-27 16:42:16,501 examples.otherfile INFO      tqdm[Processing items] done: 2/2 (100.0%), elapsed 0.1s, 32.98 it/s, ETA 0.0s

Only print and store log from specific logger (if do setup_logger(name="specific logger"))

2026-06-27 16:42:16,439 test_logger2 INFO      Logger2 info message
2026-06-27 16:42:16,439 test_logger2 INFO      with multiple lines
2026-06-27 16:42:16,439 test_logger2 INFO      and should be logged properly.

Installation

pip install logging-tee

Usage

import logging
from tqdm import tqdm
import time

from logging_tee import setup_logger

if __name__ == "__main__":
    setup_logger(log_file="output.log", level=logging.DEBUG)
    logger = logging.getLogger()
    logger2 = logging.getLogger("test_logger2")

    total = 17
    batch_size = 16
    pbar = tqdm(total=total, desc="Overall Progress")
    for i in range(0, total, batch_size):
        time.sleep(0.1)
        pbar.update(batch_size)
    pbar.close()

    for i in tqdm(
        range(2),
        desc="Processing",
    ):
        time.sleep(0.03)
        logger.info("Processing item %d", i)

    for outer_idx in tqdm(
        range(2),
        desc="Outer",
    ):
        for inner_idx in tqdm(
            range(3),
            desc=f"Inner {outer_idx}",
        ):
            time.sleep(0.02)
            if inner_idx % 5 == 0:
                print(f"Nested step outer={outer_idx} inner={inner_idx}")
        logger.info(f"Completed outer={outer_idx}")

    print("from print statement")
    print("multiple lines\nfrom print statement 2")
    logger.debug("Single line")
    logger.debug("Multiple lines:\nnext line")
    logger.debug("Another single line")
    logger.debug("Multiple lines:\n%s", "next line\nnext line 2")
    logger.warning("Warning message\nwith multiple lines\nand should be logged properly.")
    logger.error("Error message\nwith multiple lines\nand should be logged properly.")
    logger2.info("Logger2 info message\nwith multiple lines\nand should be logged properly.")
    raise ValueError("This is an error message\nwith multiple lines\nand should be logged properly.")

output.log

2026-06-27 17:42:40,269 __main__ INFO      tqdm[Overall Progress] progress: 17/17 (100.0%), elapsed 0.2s, 159.40 it/s, ETA 0.0s
2026-06-27 17:42:40,269 __main__ INFO      tqdm[Overall Progress] done: 17/17 (100.0%), elapsed 0.2s, 159.40 it/s, ETA 0.0s
2026-06-27 17:42:40,300 root INFO      Processing item 0
2026-06-27 17:42:40,331 root INFO      Processing item 1
2026-06-27 17:42:40,331 __main__ INFO      tqdm[Processing] done: 2/2 (100.0%), elapsed 0.1s, 32.71 it/s, ETA 0.0s
2026-06-27 17:42:40,351 root INFO      Nested step outer=0 inner=0
2026-06-27 17:42:40,392 __main__ INFO      tqdm[Inner 0] done: 3/3 (100.0%), elapsed 0.1s, 49.43 it/s, ETA 0.0s
2026-06-27 17:42:40,394 root INFO      Completed outer=0
2026-06-27 17:42:40,416 root INFO      Nested step outer=1 inner=0
2026-06-27 17:42:40,457 __main__ INFO      tqdm[Inner 1] done: 3/3 (100.0%), elapsed 0.1s, 49.17 it/s, ETA 0.0s
2026-06-27 17:42:40,457 root INFO      Completed outer=1
2026-06-27 17:42:40,458 __main__ INFO      tqdm[Outer] progress: 2/2 (100.0%), elapsed 0.1s, 15.78 it/s, ETA 0.0s
2026-06-27 17:42:40,459 __main__ INFO      tqdm[Outer] done: 2/2 (100.0%), elapsed 0.1s, 15.78 it/s, ETA 0.0s
2026-06-27 17:42:40,461 root INFO      from print statement
2026-06-27 17:42:40,461 root INFO      multiple lines
2026-06-27 17:42:40,461 root INFO      from print statement 2
2026-06-27 17:42:40,462 root DEBUG     Single line
2026-06-27 17:42:40,462 root DEBUG     Multiple lines:
2026-06-27 17:42:40,462 root DEBUG     next line
2026-06-27 17:42:40,463 root DEBUG     Another single line
2026-06-27 17:42:40,463 root DEBUG     Multiple lines:
2026-06-27 17:42:40,463 root DEBUG     next line
2026-06-27 17:42:40,463 root DEBUG     next line 2
2026-06-27 17:42:40,463 root WARNING   Warning message
2026-06-27 17:42:40,463 root WARNING   with multiple lines
2026-06-27 17:42:40,463 root WARNING   and should be logged properly.
2026-06-27 17:42:40,463 root ERROR     Error message
2026-06-27 17:42:40,463 root ERROR     with multiple lines
2026-06-27 17:42:40,463 root ERROR     and should be logged properly.
2026-06-27 17:42:40,463 test_logger2 INFO      Logger2 info message
2026-06-27 17:42:40,463 test_logger2 INFO      with multiple lines
2026-06-27 17:42:40,463 test_logger2 INFO      and should be logged properly.
2026-06-27 17:42:40,494 examples.otherfile INFO      Processing item 0
2026-06-27 17:42:40,524 examples.otherfile INFO      Processing item 1
2026-06-27 17:42:40,524 examples.otherfile INFO      tqdm[Processing items] done: 2/2 (100.0%), elapsed 0.1s, 32.81 it/s, ETA 0.0s
2026-06-27 17:42:40,525 root ERROR     Uncaught exception
2026-06-27 17:42:40,525 root ERROR     Traceback (most recent call last):
2026-06-27 17:42:40,525 root ERROR       File "/home/npu-tao/micromamba/envs/hipporag/lib/python3.10/runpy.py", line 196, in _run_module_as_main
2026-06-27 17:42:40,525 root ERROR         return _run_code(code, main_globals, None,
2026-06-27 17:42:40,525 root ERROR       File "/home/npu-tao/micromamba/envs/hipporag/lib/python3.10/runpy.py", line 86, in _run_code
2026-06-27 17:42:40,525 root ERROR         exec(code, run_globals)
2026-06-27 17:42:40,525 root ERROR       File "/media/npu-tao/disk4T/jason/logging-tee/examples/demo.py", line 54, in <module>
2026-06-27 17:42:40,525 root ERROR         cause_exception()
2026-06-27 17:42:40,525 root ERROR       File "/media/npu-tao/disk4T/jason/logging-tee/examples/otherfile.py", line 13, in cause_exception
2026-06-27 17:42:40,525 root ERROR         raise ValueError("This is an error message\nwith multiple lines\nand should be logged properly.")
2026-06-27 17:42:40,525 root ERROR     ValueError: This is an error message
2026-06-27 17:42:40,525 root ERROR     with multiple lines
2026-06-27 17:42:40,525 root ERROR     and should be logged properly.

Contributing

Increase version in pyproject.toml file.

Modify the src folder.

If using logging_tee in other repository

export PYTHONPATH=<path-to-folder>/src:$PYTHONPATH
python -c "import logging_tee; print(logging_tee)"

If using logging_tee in this repository

export PYTHONPATH=src/:$PYTHONPATH
python -c "import logging_tee; print(logging_tee)"

Run the test

python -m pytest tests -s

Build the package

python -m pip install build
python -m build
pip install dist/*.whl
python -c "import logging_tee; print(logging_tee)"

Upload to TestPyPI first

python -m pip install twine
python -m twine upload --repository testpypi dist/*
python -m pip install --index-url https://test.pypi.org/simple logging-tee

Upload to PyPi

python -m twine upload dist/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

logging_tee-1.0.8.tar.gz (10.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

logging_tee-1.0.8-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file logging_tee-1.0.8.tar.gz.

File metadata

  • Download URL: logging_tee-1.0.8.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for logging_tee-1.0.8.tar.gz
Algorithm Hash digest
SHA256 f90b989de4f8f4134f30a4ec1cb9495d489be5edf7e669176c2d4c48d4d1de8f
MD5 d350b3e99fe669f2841c53c45c8d6532
BLAKE2b-256 312ab39aea1ef06e71901c64354f0ffc590d13255de4585a60ebce4f47898792

See more details on using hashes here.

Provenance

The following attestation bundles were made for logging_tee-1.0.8.tar.gz:

Publisher: pypi.yml on jasonrichdarmawan/logging-tee

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file logging_tee-1.0.8-py3-none-any.whl.

File metadata

  • Download URL: logging_tee-1.0.8-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for logging_tee-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 86d9a49d6c0a8df5d92bc97071ad1728a59099e04914073bacad151651192536
MD5 c10116a6c3b922cc39a1de9f79ea740c
BLAKE2b-256 360316d3e61aec6f09245a3687beb44107b371002ad7a84f1bb056bdd838505f

See more details on using hashes here.

Provenance

The following attestation bundles were made for logging_tee-1.0.8-py3-none-any.whl:

Publisher: pypi.yml on jasonrichdarmawan/logging-tee

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page