436 lines
16 KiB
Plaintext
436 lines
16 KiB
Plaintext
Metadata-Version: 2.1
|
|
Name: progressbar2
|
|
Version: 4.5.0
|
|
Summary: A Python Progressbar library to provide visual (yet text based) progress to long running operations.
|
|
Author-email: "Rick van Hattem (Wolph)" <wolph@wol.ph>
|
|
License: BSD-3-Clause
|
|
Project-URL: bugs, https://github.com/wolph/python-progressbar/issues
|
|
Project-URL: documentation, https://progressbar-2.readthedocs.io/en/latest/
|
|
Project-URL: repository, https://github.com/wolph/python-progressbar/
|
|
Keywords: REPL,animated,bar,color,console,duration,efficient,elapsed,eta,feedback,live,meter,monitor,monitoring,multi-threaded,progress,progress-bar,progressbar,progressmeter,python,rate,simple,speed,spinner,stats,terminal,throughput,time,visual
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Development Status :: 6 - Mature
|
|
Classifier: Environment :: Console
|
|
Classifier: Environment :: MacOS X
|
|
Classifier: Environment :: Other Environment
|
|
Classifier: Environment :: Win32 (MS Windows)
|
|
Classifier: Environment :: X11 Applications
|
|
Classifier: Framework :: IPython
|
|
Classifier: Framework :: Jupyter
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Intended Audience :: Education
|
|
Classifier: Intended Audience :: End Users/Desktop
|
|
Classifier: Intended Audience :: Other Audience
|
|
Classifier: Intended Audience :: System Administrators
|
|
Classifier: License :: OSI Approved :: BSD License
|
|
Classifier: Natural Language :: English
|
|
Classifier: Operating System :: MacOS :: MacOS X
|
|
Classifier: Operating System :: MacOS
|
|
Classifier: Operating System :: Microsoft :: MS-DOS
|
|
Classifier: Operating System :: Microsoft :: Windows
|
|
Classifier: Operating System :: Microsoft
|
|
Classifier: Operating System :: POSIX :: BSD :: FreeBSD
|
|
Classifier: Operating System :: POSIX :: BSD
|
|
Classifier: Operating System :: POSIX :: Linux
|
|
Classifier: Operating System :: POSIX :: SunOS/Solaris
|
|
Classifier: Operating System :: POSIX
|
|
Classifier: Operating System :: Unix
|
|
Classifier: Programming Language :: Python :: 3 :: Only
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Classifier: Programming Language :: Python :: 3.12
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: Implementation :: IronPython
|
|
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
|
Classifier: Programming Language :: Python :: Implementation
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Programming Language :: Unix Shell
|
|
Classifier: Topic :: Desktop Environment
|
|
Classifier: Topic :: Education :: Computer Aided Instruction (CAI)
|
|
Classifier: Topic :: Education :: Testing
|
|
Classifier: Topic :: Office/Business
|
|
Classifier: Topic :: Other/Nonlisted Topic
|
|
Classifier: Topic :: Software Development :: Build Tools
|
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
Classifier: Topic :: Software Development :: Libraries
|
|
Classifier: Topic :: Software Development :: Pre-processors
|
|
Classifier: Topic :: Software Development :: User Interfaces
|
|
Classifier: Topic :: System :: Installation/Setup
|
|
Classifier: Topic :: System :: Logging
|
|
Classifier: Topic :: System :: Monitoring
|
|
Classifier: Topic :: System :: Shells
|
|
Classifier: Topic :: Terminals
|
|
Classifier: Topic :: Utilities
|
|
Requires-Python: >=3.8
|
|
Description-Content-Type: text/x-rst
|
|
License-File: LICENSE
|
|
Requires-Dist: python-utils >=3.8.1
|
|
Provides-Extra: docs
|
|
Requires-Dist: sphinx >=1.8.5 ; extra == 'docs'
|
|
Requires-Dist: sphinx-autodoc-typehints >=1.6.0 ; extra == 'docs'
|
|
Provides-Extra: tests
|
|
Requires-Dist: dill >=0.3.6 ; extra == 'tests'
|
|
Requires-Dist: flake8 >=3.7.7 ; extra == 'tests'
|
|
Requires-Dist: freezegun >=0.3.11 ; extra == 'tests'
|
|
Requires-Dist: pytest-cov >=2.6.1 ; extra == 'tests'
|
|
Requires-Dist: pytest-mypy ; extra == 'tests'
|
|
Requires-Dist: pytest >=4.6.9 ; extra == 'tests'
|
|
Requires-Dist: sphinx >=1.8.5 ; extra == 'tests'
|
|
Requires-Dist: pywin32 ; (sys_platform == "win32") and extra == 'tests'
|
|
|
|
##############################################################################
|
|
Text progress bar library for Python.
|
|
##############################################################################
|
|
|
|
Build status:
|
|
|
|
.. image:: https://github.com/WoLpH/python-progressbar/actions/workflows/main.yml/badge.svg
|
|
:alt: python-progressbar test status
|
|
:target: https://github.com/WoLpH/python-progressbar/actions
|
|
|
|
Coverage:
|
|
|
|
.. image:: https://coveralls.io/repos/WoLpH/python-progressbar/badge.svg?branch=master
|
|
:target: https://coveralls.io/r/WoLpH/python-progressbar?branch=master
|
|
|
|
******************************************************************************
|
|
Install
|
|
******************************************************************************
|
|
|
|
The package can be installed through `pip` (this is the recommended method):
|
|
|
|
pip install progressbar2
|
|
|
|
Or if `pip` is not available, `easy_install` should work as well:
|
|
|
|
easy_install progressbar2
|
|
|
|
Or download the latest release from Pypi (https://pypi.python.org/pypi/progressbar2) or Github.
|
|
|
|
Note that the releases on Pypi are signed with my GPG key (https://pgp.mit.edu/pks/lookup?op=vindex&search=0xE81444E9CE1F695D) and can be checked using GPG:
|
|
|
|
gpg --verify progressbar2-<version>.tar.gz.asc progressbar2-<version>.tar.gz
|
|
|
|
******************************************************************************
|
|
Introduction
|
|
******************************************************************************
|
|
|
|
A text progress bar is typically used to display the progress of a long
|
|
running operation, providing a visual cue that processing is underway.
|
|
|
|
The progressbar is based on the old Python progressbar package that was published on the now defunct Google Code. Since that project was completely abandoned by its developer and the developer did not respond to email, I decided to fork the package. This package is still backwards compatible with the original progressbar package so you can safely use it as a drop-in replacement for existing project.
|
|
|
|
The ProgressBar class manages the current progress, and the format of the line
|
|
is given by a number of widgets. A widget is an object that may display
|
|
differently depending on the state of the progress bar. There are many types
|
|
of widgets:
|
|
|
|
- `AbsoluteETA <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#AbsoluteETA>`_
|
|
- `AdaptiveETA <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#AdaptiveETA>`_
|
|
- `AdaptiveTransferSpeed <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#AdaptiveTransferSpeed>`_
|
|
- `AnimatedMarker <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#AnimatedMarker>`_
|
|
- `Bar <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#Bar>`_
|
|
- `BouncingBar <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#BouncingBar>`_
|
|
- `Counter <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#Counter>`_
|
|
- `CurrentTime <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#CurrentTime>`_
|
|
- `DataSize <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#DataSize>`_
|
|
- `DynamicMessage <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#DynamicMessage>`_
|
|
- `ETA <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#ETA>`_
|
|
- `FileTransferSpeed <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#FileTransferSpeed>`_
|
|
- `FormatCustomText <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#FormatCustomText>`_
|
|
- `FormatLabel <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#FormatLabel>`_
|
|
- `FormatLabelBar <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#FormatLabel>`_
|
|
- `GranularBar <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#GranularBar>`_
|
|
- `Percentage <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#Percentage>`_
|
|
- `PercentageLabelBar <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#PercentageLabelBar>`_
|
|
- `ReverseBar <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#ReverseBar>`_
|
|
- `RotatingMarker <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#RotatingMarker>`_
|
|
- `SimpleProgress <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#SimpleProgress>`_
|
|
- `Timer <http://progressbar-2.readthedocs.io/en/latest/_modules/progressbar/widgets.html#Timer>`_
|
|
|
|
The progressbar module is very easy to use, yet very powerful. It will also
|
|
automatically enable features like auto-resizing when the system supports it.
|
|
|
|
******************************************************************************
|
|
Known issues
|
|
******************************************************************************
|
|
|
|
- The Jetbrains (PyCharm, etc) editors work out of the box, but for more advanced features such as the `MultiBar` support you will need to enable the "Enable terminal in output console" checkbox in the Run dialog.
|
|
- The IDLE editor doesn't support these types of progress bars at all: https://bugs.python.org/issue23220
|
|
- Jupyter notebooks buffer `sys.stdout` which can cause mixed output. This issue can be resolved easily using: `import sys; sys.stdout.flush()`. Linked issue: https://github.com/WoLpH/python-progressbar/issues/173
|
|
|
|
******************************************************************************
|
|
Links
|
|
******************************************************************************
|
|
|
|
* Documentation
|
|
- https://progressbar-2.readthedocs.org/en/latest/
|
|
* Source
|
|
- https://github.com/WoLpH/python-progressbar
|
|
* Bug reports
|
|
- https://github.com/WoLpH/python-progressbar/issues
|
|
* Package homepage
|
|
- https://pypi.python.org/pypi/progressbar2
|
|
* My blog
|
|
- https://w.wol.ph/
|
|
|
|
******************************************************************************
|
|
Usage
|
|
******************************************************************************
|
|
|
|
There are many ways to use Python Progressbar, you can see a few basic examples
|
|
here but there are many more in the examples file.
|
|
|
|
Wrapping an iterable
|
|
==============================================================================
|
|
.. code:: python
|
|
|
|
import time
|
|
import progressbar
|
|
|
|
for i in progressbar.progressbar(range(100)):
|
|
time.sleep(0.02)
|
|
|
|
Progressbars with logging
|
|
==============================================================================
|
|
|
|
Progressbars with logging require `stderr` redirection _before_ the
|
|
`StreamHandler` is initialized. To make sure the `stderr` stream has been
|
|
redirected on time make sure to call `progressbar.streams.wrap_stderr()` before
|
|
you initialize the `logger`.
|
|
|
|
One option to force early initialization is by using the `WRAP_STDERR`
|
|
environment variable, on Linux/Unix systems this can be done through:
|
|
|
|
.. code:: sh
|
|
|
|
# WRAP_STDERR=true python your_script.py
|
|
|
|
If you need to flush manually while wrapping, you can do so using:
|
|
|
|
.. code:: python
|
|
|
|
import progressbar
|
|
|
|
progressbar.streams.flush()
|
|
|
|
In most cases the following will work as well, as long as you initialize the
|
|
`StreamHandler` after the wrapping has taken place.
|
|
|
|
.. code:: python
|
|
|
|
import time
|
|
import logging
|
|
import progressbar
|
|
|
|
progressbar.streams.wrap_stderr()
|
|
logging.basicConfig()
|
|
|
|
for i in progressbar.progressbar(range(10)):
|
|
logging.error('Got %d', i)
|
|
time.sleep(0.2)
|
|
|
|
Multiple (threaded) progressbars
|
|
==============================================================================
|
|
|
|
.. code:: python
|
|
|
|
import random
|
|
import threading
|
|
import time
|
|
|
|
import progressbar
|
|
|
|
BARS = 5
|
|
N = 50
|
|
|
|
|
|
def do_something(bar):
|
|
for i in bar(range(N)):
|
|
# Sleep up to 0.1 seconds
|
|
time.sleep(random.random() * 0.1)
|
|
|
|
# print messages at random intervals to show how extra output works
|
|
if random.random() > 0.9:
|
|
bar.print('random message for bar', bar, i)
|
|
|
|
|
|
with progressbar.MultiBar() as multibar:
|
|
for i in range(BARS):
|
|
# Get a progressbar
|
|
bar = multibar[f'Thread label here {i}']
|
|
# Create a thread and pass the progressbar
|
|
threading.Thread(target=do_something, args=(bar,)).start()
|
|
|
|
Context wrapper
|
|
==============================================================================
|
|
.. code:: python
|
|
|
|
import time
|
|
import progressbar
|
|
|
|
with progressbar.ProgressBar(max_value=10) as bar:
|
|
for i in range(10):
|
|
time.sleep(0.1)
|
|
bar.update(i)
|
|
|
|
Combining progressbars with print output
|
|
==============================================================================
|
|
.. code:: python
|
|
|
|
import time
|
|
import progressbar
|
|
|
|
for i in progressbar.progressbar(range(100), redirect_stdout=True):
|
|
print('Some text', i)
|
|
time.sleep(0.1)
|
|
|
|
Progressbar with unknown length
|
|
==============================================================================
|
|
.. code:: python
|
|
|
|
import time
|
|
import progressbar
|
|
|
|
bar = progressbar.ProgressBar(max_value=progressbar.UnknownLength)
|
|
for i in range(20):
|
|
time.sleep(0.1)
|
|
bar.update(i)
|
|
|
|
Bar with custom widgets
|
|
==============================================================================
|
|
.. code:: python
|
|
|
|
import time
|
|
import progressbar
|
|
|
|
widgets=[
|
|
' [', progressbar.Timer(), '] ',
|
|
progressbar.Bar(),
|
|
' (', progressbar.ETA(), ') ',
|
|
]
|
|
for i in progressbar.progressbar(range(20), widgets=widgets):
|
|
time.sleep(0.1)
|
|
|
|
Bar with wide Chinese (or other multibyte) characters
|
|
==============================================================================
|
|
|
|
.. code:: python
|
|
|
|
# vim: fileencoding=utf-8
|
|
import time
|
|
import progressbar
|
|
|
|
|
|
def custom_len(value):
|
|
# These characters take up more space
|
|
characters = {
|
|
'进': 2,
|
|
'度': 2,
|
|
}
|
|
|
|
total = 0
|
|
for c in value:
|
|
total += characters.get(c, 1)
|
|
|
|
return total
|
|
|
|
|
|
bar = progressbar.ProgressBar(
|
|
widgets=[
|
|
'进度: ',
|
|
progressbar.Bar(),
|
|
' ',
|
|
progressbar.Counter(format='%(value)02d/%(max_value)d'),
|
|
],
|
|
len_func=custom_len,
|
|
)
|
|
for i in bar(range(10)):
|
|
time.sleep(0.1)
|
|
|
|
Showing multiple independent progress bars in parallel
|
|
==============================================================================
|
|
|
|
.. code:: python
|
|
|
|
import random
|
|
import sys
|
|
import time
|
|
|
|
import progressbar
|
|
|
|
BARS = 5
|
|
N = 100
|
|
|
|
# Construct the list of progress bars with the `line_offset` so they draw
|
|
# below each other
|
|
bars = []
|
|
for i in range(BARS):
|
|
bars.append(
|
|
progressbar.ProgressBar(
|
|
max_value=N,
|
|
# We add 1 to the line offset to account for the `print_fd`
|
|
line_offset=i + 1,
|
|
max_error=False,
|
|
)
|
|
)
|
|
|
|
# Create a file descriptor for regular printing as well
|
|
print_fd = progressbar.LineOffsetStreamWrapper(lines=0, stream=sys.stdout)
|
|
|
|
# The progress bar updates, normally you would do something useful here
|
|
for i in range(N * BARS):
|
|
time.sleep(0.005)
|
|
|
|
# Increment one of the progress bars at random
|
|
bars[random.randrange(0, BARS)].increment()
|
|
|
|
# Print a status message to the `print_fd` below the progress bars
|
|
print(f'Hi, we are at update {i+1} of {N * BARS}', file=print_fd)
|
|
|
|
# Cleanup the bars
|
|
for bar in bars:
|
|
bar.finish()
|
|
|
|
# Add a newline to make sure the next print starts on a new line
|
|
print()
|
|
|
|
******************************************************************************
|
|
|
|
Naturally we can do this from separate threads as well:
|
|
|
|
.. code:: python
|
|
|
|
import random
|
|
import threading
|
|
import time
|
|
|
|
import progressbar
|
|
|
|
BARS = 5
|
|
N = 100
|
|
|
|
# Create the bars with the given line offset
|
|
bars = []
|
|
for line_offset in range(BARS):
|
|
bars.append(progressbar.ProgressBar(line_offset=line_offset, max_value=N))
|
|
|
|
|
|
class Worker(threading.Thread):
|
|
def __init__(self, bar):
|
|
super().__init__()
|
|
self.bar = bar
|
|
|
|
def run(self):
|
|
for i in range(N):
|
|
time.sleep(random.random() / 25)
|
|
self.bar.update(i)
|
|
|
|
|
|
for bar in bars:
|
|
Worker(bar).start()
|
|
|
|
print()
|