progiter 2.0.0
A single-threaded alternative to tqdm.
License: Apache 2
Requires Python: >=3.6

|GithubActions| |ReadTheDocs| |Pypi| |Downloads| |Codecov|


ProgIter
========

ProgIter lets you measure and print the progress of an iterative process. This
can be done either via an iterable interface or using the manual API. Using the
iterable interface is most common.

.. .. animation generated via: dev/maintain/record_animation_demo.sh

.. .. image:: https://i.imgur.com/HoJJYzd.gif
.. image:: https://i.imgur.com/Jqfg8w0.gif
   :height: 300px
   :align: left

Basic usage is:

.. code:: python

    >>> from progiter import ProgIter
    >>> for n in ProgIter(range(1000)):
    >>>     ...  # do some work


The basic ProgIter is *unthreaded*. This differentiates it from
`tqdm <https://github.com/tqdm/tqdm>`_ and
`rich.progress <https://rich.readthedocs.io/en/stable/progress.html>`_
which use a *threaded* implementation.
The choice of implementation has different tradeoffs and neither is strictly
better than the other.
An unthreaded progress bar provides synchronous uncluttered logging, increased
stability, and --- unintuitively ---- speed (due to Python's GIL).
Meanwhile threaded progress bars are more responsive, able to update multiple
stdout lines at a time, and can look prettier (unless you try to log stdout to
disk).

ProgIter was originally developed independently of ``tqdm``, but the newer
versions of this library have been designed to be compatible with tqdm-API.
``ProgIter`` is now a (mostly) drop-in alternative to ``tqdm``.
The ``tqdm`` library may be more appropriate in some cases.
The main advantage of ``ProgIter`` is that it does not use any python
threading, and therefore can be safer with code that makes heavy use of
multiprocessing.
`The reason <https://pybay.com/site_media/slides/raymond2017-keynote/combo.html>`_
for this is that threading before forking may cause locks to be duplicated
across processes, which may lead to deadlocks (although with tqdm this is very
unlikely).

ProgIter is simpler than tqdm, which may be desirable for some applications.
However, this also means ProgIter is not as extensible as tqdm.
If you want a pretty bar or need something fancy, use tqdm (or rich);
if you want useful information  about your iteration by default, use progiter.

New in Version 2.0, ``progiter.ProgressManager``, which enables near-seemless
toggling between an unthreaded ``ProgIter`` backend and a threaded
``RichProgIter`` backend. Basic usage is:

.. code:: python

    from progiter.manager import ProgressManager
    pman = ProgressManager()
    with pman:
        for item in pman.progiter(range(1000)):
            ...  # do some work


The following gif illustrates this and more complex usage:

.. image:: https://i.imgur.com/GE1h3kr.gif
   :height: 501px
   :align: left

Package level documentation can be found at: https://progiter.readthedocs.io/en/latest/

Example
-------

The basic usage of ProgIter is simple and intuitive: wrap a python iterable.
The following example wraps a ``range`` iterable and reports progress to stdout
as the iterable is consumed. The ``ProgIter`` object accepts various keyword
arguments to modify the details of how progress is measured and reported. See
API documentation of the ``ProgIter`` class here:
https://progiter.readthedocs.io/en/latest/progiter.progiter.html#progiter.progiter.ProgIter


.. code:: python

    >>> from progiter import ProgIter
    >>> def is_prime(n):
    ...     return n >= 2 and not any(n % i == 0 for i in range(2, n))
    >>> for n in ProgIter(range(1000), verbose=2):
    >>>     # do some work
    >>>     is_prime(n)
    0.00%    0/1000... rate=0 Hz, eta=?, total=0:00:00
    0.60%    6/1000... rate=76995.12 Hz, eta=0:00:00, total=0:00:00
    100.00% 1000/1000... rate=266488.22 Hz, eta=0:00:00, total=0:00:00


For more complex applications is may sometimes be desireable to manually use
the ProgIter API. This is done as follows:

.. code:: python

    >>> from progiter import ProgIter
    >>> n = 3
    >>> prog = ProgIter(desc='manual', total=n, verbose=3, time_thresh=0)
    >>> prog.begin() # Manually begin progress iteration
    >>> for _ in range(n):
    ...     prog.step(inc=1)  # specify the number of steps to increment
    >>> prog.end()  # Manually end progress iteration
    manual 0.00% 0/3... rate=0 Hz, eta=?, total=0:00:00
    manual 33.33% 1/3... rate=5422.82 Hz, eta=0:00:00, total=0:00:00
    manual 66.67% 2/3... rate=8907.61 Hz, eta=0:00:00, total=0:00:00
    manual 100.00% 3/3... rate=12248.15 Hz, eta=0:00:00, total=0:00:00


By default ``ProgIter`` aims to write a line to stdout once every two seconds
to minimize its overhead and reduce clutter. Setting this to zero will force
it to print on every iteration.


When working with ProgIter in either iterable or manual mode you can use the
``prog.ensure_newline`` method to guarantee that the next call you make to stdout
will start on a new line. You can also use the ``prog.set_extra`` method to
update a dynamic "extra" message that is shown in the formatted output. The
following example demonstrates this.


.. code:: python

    >>> from progiter import ProgIter
    >>> def is_prime(n):
    ...     return n >= 2 and not any(n % i == 0 for i in range(2, n))
    >>> _iter = range(1000)
    >>> prog = ProgIter(_iter, desc='check primes', verbose=2, time_thresh=1e-3)
    >>> for n in prog:
    >>>     if n == 97:
    >>>         print('!!! Special print at n=97 !!!')
    >>>     if is_prime(n):
    >>>         prog.set_extra('Biggest prime so far: {}'.format(n))
    >>>         prog.ensure_newline()
    check primes 0.00%    0/1000... rate=0 Hz, eta=?, total=0:00:00
    check primes 0.60%    6/1000...Biggest prime so far: 5 rate=79329.39 Hz, eta=0:00:00, total=0:00:00
    !!! Special print at n=97 !!!
    check primes 75.60%  756/1000...Biggest prime so far: 751 rate=272693.23 Hz, eta=0:00:00, total=0:00:00
    check primes 99.30%  993/1000...Biggest prime so far: 991 rate=245852.75 Hz, eta=0:00:00, total=0:00:00
    check primes 100.00% 1000/1000...Biggest prime so far: 997 rate=244317.84 Hz, eta=0:00:00, total=0:00:00


Installation
------------

ProgIter can be easily installed via `pip`.

.. code:: bash

   pip install progiter

Alternatively, the `ubelt`_ library ships with its own version of ProgIter.
Note that the `ubelt` version of progiter is distinct (i.e. ubelt actually
contains a copy of this library), but the two libraries are generally kept in
sync.


.. _ubelt: https://github.com/Erotemic/ubelt


.. |Travis| image:: https://img.shields.io/travis/Erotemic/progiter/master.svg?label=Travis%20CI
   :target: https://travis-ci.org/Erotemic/progiter?branch=master
.. |Codecov| image:: https://codecov.io/github/Erotemic/progiter/badge.svg?branch=master&service=github
   :target: https://codecov.io/github/Erotemic/progiter?branch=master
.. |Appveyor| image:: https://ci.appveyor.com/api/projects/status/github/Erotemic/progiter?branch=master&svg=True
   :target: https://ci.appveyor.com/project/Erotemic/progiter/branch/master
.. |Pypi| image:: https://img.shields.io/pypi/v/progiter.svg
   :target: https://pypi.python.org/pypi/progiter
.. |Downloads| image:: https://img.shields.io/pypi/dm/progiter.svg
   :target: https://pypistats.org/packages/progiter
.. |CircleCI| image:: https://circleci.com/gh/Erotemic/progiter.svg?style=svg
    :target: https://circleci.com/gh/Erotemic/progiter
.. |ReadTheDocs| image:: https://readthedocs.org/projects/progiter/badge/?version=latest
    :target: http://progiter.readthedocs.io/en/latest/
.. |GithubActions| image:: https://github.com/Erotemic/progiter/actions/workflows/tests.yml/badge.svg?branch=main
    :target: https://github.com/Erotemic/progiter/actions?query=branch%3Amain