{"author":"Jon Crall","author_email":"erotemic@gmail.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","License :: OSI Approved :: Apache Software License","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.6","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Software Development :: Libraries :: Python Modules","Topic :: Utilities"],"description":"|GithubActions| |ReadTheDocs| |Pypi| |Downloads| |Codecov|\n\n\nProgIter\n========\n\nProgIter lets you measure and print the progress of an iterative process. This\ncan be done either via an iterable interface or using the manual API. Using the\niterable interface is most common.\n\n.. .. animation generated via: dev/maintain/record_animation_demo.sh\n\n.. .. image:: https://i.imgur.com/HoJJYzd.gif\n.. image:: https://i.imgur.com/Jqfg8w0.gif\n :height: 300px\n :align: left\n\nBasic usage is:\n\n.. code:: python\n\n >>> from progiter import ProgIter\n >>> for n in ProgIter(range(1000)):\n >>> ... # do some work\n\n\nThe basic ProgIter is *unthreaded*. This differentiates it from\n`tqdm `_ and\n`rich.progress `_\nwhich use a *threaded* implementation.\nThe choice of implementation has different tradeoffs and neither is strictly\nbetter than the other.\nAn unthreaded progress bar provides synchronous uncluttered logging, increased\nstability, and --- unintuitively ---- speed (due to Python's GIL).\nMeanwhile threaded progress bars are more responsive, able to update multiple\nstdout lines at a time, and can look prettier (unless you try to log stdout to\ndisk).\n\nProgIter was originally developed independently of ``tqdm``, but the newer\nversions of this library have been designed to be compatible with tqdm-API.\n``ProgIter`` is now a (mostly) drop-in alternative to ``tqdm``.\nThe ``tqdm`` library may be more appropriate in some cases.\nThe main advantage of ``ProgIter`` is that it does not use any python\nthreading, and therefore can be safer with code that makes heavy use of\nmultiprocessing.\n`The reason `_\nfor this is that threading before forking may cause locks to be duplicated\nacross processes, which may lead to deadlocks (although with tqdm this is very\nunlikely).\n\nProgIter is simpler than tqdm, which may be desirable for some applications.\nHowever, this also means ProgIter is not as extensible as tqdm.\nIf you want a pretty bar or need something fancy, use tqdm (or rich);\nif you want useful information about your iteration by default, use progiter.\n\nNew in Version 2.0, ``progiter.ProgressManager``, which enables near-seemless\ntoggling between an unthreaded ``ProgIter`` backend and a threaded\n``RichProgIter`` backend. Basic usage is:\n\n.. code:: python\n\n from progiter.manager import ProgressManager\n pman = ProgressManager()\n with pman:\n for item in pman.progiter(range(1000)):\n ... # do some work\n\n\nThe following gif illustrates this and more complex usage:\n\n.. image:: https://i.imgur.com/GE1h3kr.gif\n :height: 501px\n :align: left\n\nPackage level documentation can be found at: https://progiter.readthedocs.io/en/latest/\n\nExample\n-------\n\nThe basic usage of ProgIter is simple and intuitive: wrap a python iterable.\nThe following example wraps a ``range`` iterable and reports progress to stdout\nas the iterable is consumed. The ``ProgIter`` object accepts various keyword\narguments to modify the details of how progress is measured and reported. See\nAPI documentation of the ``ProgIter`` class here:\nhttps://progiter.readthedocs.io/en/latest/progiter.progiter.html#progiter.progiter.ProgIter\n\n\n.. code:: python\n\n >>> from progiter import ProgIter\n >>> def is_prime(n):\n ... return n >= 2 and not any(n % i == 0 for i in range(2, n))\n >>> for n in ProgIter(range(1000), verbose=2):\n >>> # do some work\n >>> is_prime(n)\n 0.00% 0/1000... rate=0 Hz, eta=?, total=0:00:00\n 0.60% 6/1000... rate=76995.12 Hz, eta=0:00:00, total=0:00:00\n 100.00% 1000/1000... rate=266488.22 Hz, eta=0:00:00, total=0:00:00\n\n\nFor more complex applications is may sometimes be desireable to manually use\nthe ProgIter API. This is done as follows:\n\n.. code:: python\n\n >>> from progiter import ProgIter\n >>> n = 3\n >>> prog = ProgIter(desc='manual', total=n, verbose=3, time_thresh=0)\n >>> prog.begin() # Manually begin progress iteration\n >>> for _ in range(n):\n ... prog.step(inc=1) # specify the number of steps to increment\n >>> prog.end() # Manually end progress iteration\n manual 0.00% 0/3... rate=0 Hz, eta=?, total=0:00:00\n manual 33.33% 1/3... rate=5422.82 Hz, eta=0:00:00, total=0:00:00\n manual 66.67% 2/3... rate=8907.61 Hz, eta=0:00:00, total=0:00:00\n manual 100.00% 3/3... rate=12248.15 Hz, eta=0:00:00, total=0:00:00\n\n\nBy default ``ProgIter`` aims to write a line to stdout once every two seconds\nto minimize its overhead and reduce clutter. Setting this to zero will force\nit to print on every iteration.\n\n\nWhen working with ProgIter in either iterable or manual mode you can use the\n``prog.ensure_newline`` method to guarantee that the next call you make to stdout\nwill start on a new line. You can also use the ``prog.set_extra`` method to\nupdate a dynamic \"extra\" message that is shown in the formatted output. The\nfollowing example demonstrates this.\n\n\n.. code:: python\n\n >>> from progiter import ProgIter\n >>> def is_prime(n):\n ... return n >= 2 and not any(n % i == 0 for i in range(2, n))\n >>> _iter = range(1000)\n >>> prog = ProgIter(_iter, desc='check primes', verbose=2, time_thresh=1e-3)\n >>> for n in prog:\n >>> if n == 97:\n >>> print('!!! Special print at n=97 !!!')\n >>> if is_prime(n):\n >>> prog.set_extra('Biggest prime so far: {}'.format(n))\n >>> prog.ensure_newline()\n check primes 0.00% 0/1000... rate=0 Hz, eta=?, total=0:00:00\n check primes 0.60% 6/1000...Biggest prime so far: 5 rate=79329.39 Hz, eta=0:00:00, total=0:00:00\n !!! Special print at n=97 !!!\n check primes 75.60% 756/1000...Biggest prime so far: 751 rate=272693.23 Hz, eta=0:00:00, total=0:00:00\n check primes 99.30% 993/1000...Biggest prime so far: 991 rate=245852.75 Hz, eta=0:00:00, total=0:00:00\n check primes 100.00% 1000/1000...Biggest prime so far: 997 rate=244317.84 Hz, eta=0:00:00, total=0:00:00\n\n\nInstallation\n------------\n\nProgIter can be easily installed via `pip`.\n\n.. code:: bash\n\n pip install progiter\n\nAlternatively, the `ubelt`_ library ships with its own version of ProgIter.\nNote that the `ubelt` version of progiter is distinct (i.e. ubelt actually\ncontains a copy of this library), but the two libraries are generally kept in\nsync.\n\n\n.. _ubelt: https://github.com/Erotemic/ubelt\n\n\n.. |Travis| image:: https://img.shields.io/travis/Erotemic/progiter/master.svg?label=Travis%20CI\n :target: https://travis-ci.org/Erotemic/progiter?branch=master\n.. |Codecov| image:: https://codecov.io/github/Erotemic/progiter/badge.svg?branch=master&service=github\n :target: https://codecov.io/github/Erotemic/progiter?branch=master\n.. |Appveyor| image:: https://ci.appveyor.com/api/projects/status/github/Erotemic/progiter?branch=master&svg=True\n :target: https://ci.appveyor.com/project/Erotemic/progiter/branch/master\n.. |Pypi| image:: https://img.shields.io/pypi/v/progiter.svg\n :target: https://pypi.python.org/pypi/progiter\n.. |Downloads| image:: https://img.shields.io/pypi/dm/progiter.svg\n :target: https://pypistats.org/packages/progiter\n.. |CircleCI| image:: https://circleci.com/gh/Erotemic/progiter.svg?style=svg\n :target: https://circleci.com/gh/Erotemic/progiter\n.. |ReadTheDocs| image:: https://readthedocs.org/projects/progiter/badge/?version=latest\n :target: http://progiter.readthedocs.io/en/latest/\n.. |GithubActions| image:: https://github.com/Erotemic/progiter/actions/workflows/tests.yml/badge.svg?branch=main\n :target: https://github.com/Erotemic/progiter/actions?query=branch%3Amain\n\n\n","description_content_type":"text/x-rst","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"","keywords":"","license":"Apache 2","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"progiter","package_url":"https://pypi.org/project/progiter/","platform":null,"project_url":"https://pypi.org/project/progiter/","project_urls":null,"provides_extra":null,"release_url":"https://pypi.org/project/progiter/2.0.0/","requires_dist":["rich ; extra == 'all'","xdoctest ; extra == 'all'","rich (==12.3.0) ; extra == 'all-strict'","xdoctest (==1.1.0) ; extra == 'all-strict'","pytest-cov (==2.8.1) ; (python_version < \"2.8.0\" and python_version >= \"2.7.0\") and extra == 'all-strict'","pytest (<=4.6.11,==4.6.0) ; (python_version < \"2.8.0\" and python_version >= \"2.7.0\") and extra == 'all-strict'","pytest (==4.6.0) ; (python_version < \"3.10.0\" and python_version >= \"3.7.0\") and extra == 'all-strict'","pytest-cov (==2.8.1) ; (python_version < \"3.5.0\" and python_version >= \"3.4.0\") and extra == 'all-strict'","pytest (<=4.6.11,==4.6.0) ; (python_version < \"3.5.0\" and python_version >= \"3.4.0\") and extra == 'all-strict'","pytest-cov (==2.9.0) ; (python_version < \"3.6.0\" and python_version >= \"3.5.0\") and extra == 'all-strict'","pytest (<=6.1.2,==4.6.0) ; (python_version < \"3.6.0\" and python_version >= \"3.5.0\") and extra == 'all-strict'","pytest (==4.6.0) ; (python_version < \"3.7.0\" and python_version >= \"3.6.0\") and extra == 'all-strict'","typing (==3.7.4) ; (python_version <= \"3.4\") and extra == 'all-strict'","pytest (==6.2.5) ; (python_version >= \"3.10.0\") and extra == 'all-strict'","pytest-cov (==3.0.0) ; (python_version >= \"3.6.0\") and extra == 'all-strict'","pytest ; (python_version < \"2.8.0\" and python_version >= \"2.7.0\") and extra == 'all'","pytest-cov ; (python_version < \"2.8.0\" and python_version >= \"2.7.0\") and extra == 'all'","pytest ; (python_version < \"3.10.0\" and python_version >= \"3.7.0\") and extra == 'all'","pytest ; (python_version < \"3.5.0\" and python_version >= \"3.4.0\") and extra == 'all'","pytest-cov ; (python_version < \"3.5.0\" and python_version >= \"3.4.0\") and extra == 'all'","pytest ; (python_version < \"3.6.0\" and python_version >= \"3.5.0\") and extra == 'all'","pytest-cov ; (python_version < \"3.6.0\" and python_version >= \"3.5.0\") and extra == 'all'","pytest ; (python_version < \"3.7.0\" and python_version >= \"3.6.0\") and extra == 'all'","typing ; (python_version <= \"3.4\") and extra == 'all'","pytest ; (python_version >= \"3.10.0\") and extra == 'all'","pytest-cov ; (python_version >= \"3.6.0\") and extra == 'all'","rich ; extra == 'optional'","rich (==12.3.0) ; extra == 'optional-strict'","xdoctest ; extra == 'tests'","xdoctest (==1.1.0) ; extra == 'tests-strict'","pytest-cov (==2.8.1) ; (python_version < \"2.8.0\" and python_version >= \"2.7.0\") and extra == 'tests-strict'","pytest (<=4.6.11,==4.6.0) ; (python_version < \"2.8.0\" and python_version >= \"2.7.0\") and extra == 'tests-strict'","pytest (==4.6.0) ; (python_version < \"3.10.0\" and python_version >= \"3.7.0\") and extra == 'tests-strict'","pytest-cov (==2.8.1) ; (python_version < \"3.5.0\" and python_version >= \"3.4.0\") and extra == 'tests-strict'","pytest (<=4.6.11,==4.6.0) ; (python_version < \"3.5.0\" and python_version >= \"3.4.0\") and extra == 'tests-strict'","pytest-cov (==2.9.0) ; (python_version < \"3.6.0\" and python_version >= \"3.5.0\") and extra == 'tests-strict'","pytest (<=6.1.2,==4.6.0) ; (python_version < \"3.6.0\" and python_version >= \"3.5.0\") and extra == 'tests-strict'","pytest (==4.6.0) ; (python_version < \"3.7.0\" and python_version >= \"3.6.0\") and extra == 'tests-strict'","typing (==3.7.4) ; (python_version <= \"3.4\") and extra == 'tests-strict'","pytest (==6.2.5) ; (python_version >= \"3.10.0\") and extra == 'tests-strict'","pytest-cov (==3.0.0) ; (python_version >= \"3.6.0\") and extra == 'tests-strict'","pytest ; (python_version < \"2.8.0\" and python_version >= \"2.7.0\") and extra == 'tests'","pytest-cov ; (python_version < \"2.8.0\" and python_version >= \"2.7.0\") and extra == 'tests'","pytest ; (python_version < \"3.10.0\" and python_version >= \"3.7.0\") and extra == 'tests'","pytest ; (python_version < \"3.5.0\" and python_version >= \"3.4.0\") and extra == 'tests'","pytest-cov ; (python_version < \"3.5.0\" and python_version >= \"3.4.0\") and extra == 'tests'","pytest ; (python_version < \"3.6.0\" and python_version >= \"3.5.0\") and extra == 'tests'","pytest-cov ; (python_version < \"3.6.0\" and python_version >= \"3.5.0\") and extra == 'tests'","pytest ; (python_version < \"3.7.0\" and python_version >= \"3.6.0\") and extra == 'tests'","typing ; (python_version <= \"3.4\") and extra == 'tests'","pytest ; (python_version >= \"3.10.0\") and extra == 'tests'","pytest-cov ; (python_version >= \"3.6.0\") and extra == 'tests'"],"requires_python":">=3.6","summary":"A single-threaded alternative to tqdm.","version":"2.0.0","yanked":false,"yanked_reason":null}

Dependencies of progiter (5).
Dependency	Optional
pytest	true
pytest-cov	true
rich	true
typing	true
xdoctest	true

Package search

progiter

Release table

project_urls

Dependencies

All package metadata

Releases