progress-table 1.2.5__tar.gz → 1.3.1__tar.gz

{progress-table-1.2.5 → progress-table-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: progress-table
-Version: 1.2.5
+Version: 1.3.1
 Summary: Display progress as a pretty table in the command line.
 Home-page: https://github.com/gahaalt/progress-table.git
 Author: Szymon Mikler

{progress-table-1.2.5 → progress-table-1.3.1}/progress_table/__init__.py

@@ -1,6 +1,6 @@
-#  Copyright (c) 2022 Szymon Mikler
+#  Copyright (c) 2022-2024 Szymon Mikler
 
-__version__ = "1.2.5"
+__version__ = "1.3.1"
 
 from progress_table.v0.progress_table import ProgressTableV0
 from progress_table.v1.progress_table import ProgressTableV1

progress-table-1.3.1/progress_table/v0/__init__.py

@@ -0,0 +1 @@
+#  Copyright (c) 2022-2024 Szymon Mikler

{progress-table-1.2.5 → progress-table-1.3.1}/progress_table/v0/progress_table.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2022 Szymon Mikler
+#  Copyright (c) 2022-2024 Szymon Mikler
 
 from __future__ import annotations
 
@@ -27,6 +27,8 @@ ALL_COLORS_STYLES = ALL_COLORS + ALL_STYLES
 ITERATOR_LENGTH_UNKNOWN_WARNED_ONCE = False
 ITERATOR_LENGTH_CACHE: Dict[int, int] = {}
 
+DEPRECATION_PRINTED = False
+
 
 class ProgressTableV0:
     def __init__(
@@ -82,6 +84,12 @@ class ProgressTableV0:
             file: Redirect the output to another stream. There can be multiple streams at once passed as
                   a list or a tuple. Defaults to sys.stdout.
         """
+        global DEPRECATION_PRINTED
+
+        if not DEPRECATION_PRINTED:
+            logging.warning("ProgressTableV0 is deprecated, use ProgressTableV1 instead")
+            DEPRECATION_PRINTED = True
+
         self.refresh_rate = refresh_rate
         self.default_width = default_column_width
         self.default_alignment = default_column_alignment

{progress-table-1.2.5 → progress-table-1.3.1}/progress_table/v0/symbols.py

@@ -1,3 +1,5 @@
+#  Copyright (c) 2022-2024 Szymon Mikler
+
 from dataclasses import dataclass
 
 

progress-table-1.3.1/progress_table/v1/__init__.py

@@ -0,0 +1 @@
+#  Copyright (c) 2022-2024 Szymon Mikler

{progress-table-1.2.5 → progress-table-1.3.1}/progress_table/v1/progress_table.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2022 Szymon Mikler
+#  Copyright (c) 2022-2024 Szymon Mikler
 
 from __future__ import annotations
 
@@ -219,7 +219,7 @@ class ProgressTableV1:
         self.finished_rows: list[dict[str, Any]] = []
 
         self._new_row: dict[str, Any] = {}
-        self.new_row_cumulated_weight: dict[str, int] = {}
+        self._new_row_cumulated_weight: dict[str, int] = {}
         self.files = (file,) if not isinstance(file, (list, tuple)) else file
 
         self.previous_header_counter = 0
@@ -288,27 +288,35 @@ class ProgressTableV1:
         # Initialize color for the column in the new row
         self._prepare_row_color_dict()
 
-    def add_columns(self, iterable, **kwds):
+    def add_columns(self, *columns, **kwds):
         """Add multiple columns to the table."""
-        for column in iterable:
+        for column in columns:
             self.add_column(column, **kwds)
 
-    def update(self, key, value, *, weight=1):
-        """Update value in the current row."""
+    def update(self, key, value, *, weight=1, **column_kwds):
+        """Update value in the current row. This is extends capabilities of __setitem__.
+
+        Args:
+            key: Name of the column.
+            value: Value to be set.
+            weight: Weight of the value. This is used for aggregation.
+            column_kwds: Additional arguments for the column. They will be only used for column creation.
+                         If column already exists, they will have no effect.
+        """
         if key not in self.column_names:
             if self._is_table_opened:
                 logging.info("Closing table (new column added to opened table)")
-                self.close(close_pbars=False)
+                self.close(close_pbars=False, close_row=False)
 
-            self.add_column(key)
+            self.add_column(key, **column_kwds)
 
         # Set default values for new rows
         self._new_row.setdefault(key, 0)
-        self.new_row_cumulated_weight.setdefault(key, 0)
+        self._new_row_cumulated_weight.setdefault(key, 0)
 
         fn = self.column_aggregates[key]
-        self._new_row[key] = fn(value, self._new_row[key], self.new_row_cumulated_weight[key])
-        self.new_row_cumulated_weight[key] += weight
+        self._new_row[key] = fn(value, self._new_row[key], self._new_row_cumulated_weight[key])
+        self._new_row_cumulated_weight[key] += weight
 
         t0 = time.time()
         td = t0 - self._last_time_row_printed
@@ -335,7 +343,7 @@ class ProgressTableV1:
             return
 
         logging.info("Closing table (reordering columns)")
-        self.close(close_pbars=False)
+        self.close(close_pbars=False, close_row=False)
 
         assert isinstance(column_names, (List, Tuple))
         assert all([x in self.column_names for x in column_names]), f"Columns {column_names} not in {self.column_names}"
@@ -444,7 +452,8 @@ class ProgressTableV1:
 
     def _display_new_row_or_pbar(self):
         if self._active_pbars.get(0, None) is not None:
-            self._active_pbars[0].display()  # Level 0 pbar is embedded into the row, if it exists we want to display it instead of a row
+            # Level 0 pbar is embedded into the row, if it exists we want to display it instead of a row
+            self._active_pbars[0].display()
         else:
             self._display_new_row()
 
@@ -466,6 +475,9 @@ class ProgressTableV1:
         if split or self._request_splitter:
             self._print_splitter()
 
+        # Reset aggregated values!
+        self._new_row_cumulated_weight = {}
+
         self._prepare_row_color_dict(color)
         self._display_new_row()
         self._print()  # Insert a newline
@@ -548,6 +560,7 @@ class ProgressTableV1:
         level=None,
         total=None,
         refresh_rate=None,
+        description="",
         show_throughput=None,
         show_progress=None,
     ):
@@ -559,6 +572,7 @@ class ProgressTableV1:
             level: Level of the progress bar. If not provided, it will be set automatically.
             total: Total number of iterations. If not provided, it will be calculated from the length of the iterable.
             refresh_rate: The maximal number of times per second the progress bar will be refreshed.
+            description: Custom description of the progress bar that will be shown as prefix.
             show_throughput: If True, the throughput will be displayed.
             show_progress: If True, the progress will be displayed.
         """
@@ -574,6 +588,7 @@ class ProgressTableV1:
             total=total,
             level=level,
             refresh_rate=refresh_rate if refresh_rate is not None else self.refresh_rate,
+            description=description,
             show_throughput=show_throughput if show_throughput is not None else self.pbar_show_throughput,
             show_progress=show_progress if show_progress is not None else self.pbar_show_progress,
         )
@@ -589,7 +604,7 @@ class ProgressTableV1:
 
 
 class TableProgressBar:
-    def __init__(self, iterable, *, table, total, level, refresh_rate, show_throughput, show_progress):
+    def __init__(self, iterable, *, table, total, level, refresh_rate, description, show_throughput, show_progress):
         self.iterable: Iterable | None = iterable
 
         self._step: int = 0
@@ -600,6 +615,7 @@ class TableProgressBar:
         self.level: int = level
         self.table: ProgressTableV1 = table
         self.refresh_rate: int = refresh_rate
+        self.description: str = description
         self.show_progress: bool = show_progress
         self.show_throughput: bool = show_throughput
         self._is_active: bool = True
@@ -618,13 +634,15 @@ class TableProgressBar:
         throughput = self._step / time_passed if time_passed > 0 else 0.0
 
         inside_infobar = []
-        if self.show_throughput:
-            inside_infobar.append(f"{throughput: <.2f} it/s")
+        if self.description:
+            inside_infobar.append(self.description)
         if self.show_progress:
             if self._total:
                 inside_infobar.append(f"{self._step}/{self._total}")
             else:
                 inside_infobar.append(f"{self._step}")
+        if self.show_throughput:
+            inside_infobar.append(f"{throughput: <.2f} it/s")
         infobar = "[" + ", ".join(inside_infobar) + "] " if inside_infobar else ""
 
         pbar = ["\n" * self.level]
@@ -659,13 +677,17 @@ class TableProgressBar:
                 total = len(row)
                 step = self._step % total
 
-            new_row = []
+            new_row = [Style.BRIGHT]
             for letter_idx, letter in enumerate(row):
-                if letter == " ":
-                    if letter_idx / len(row) <= (step / total) % (1 + EPS):
-                        letter = self.table.table_style.embedded_pbar_filled
-                    elif (letter_idx - 1) / len(row) <= (step / total) % (1 + EPS):
-                        letter = self.table.table_style.embedded_pbar_head
+                is_bar = letter_idx / len(row) <= (step / total) % (1 + EPS)
+                is_head = (letter_idx - 1) / len(row) <= (step / total) % (1 + EPS)
+                if letter == " " and is_bar:
+                    letter = self.table.table_style.embedded_pbar_filled
+                if letter == " " and is_head:
+                    letter = self.table.table_style.embedded_pbar_head
+
+                if not is_bar and not is_head:
+                    new_row.append(Style.RESET_ALL)
                 new_row.append(letter)
             pbar.extend(new_row)
         pbar.append(CURSOR_UP * self.level)

{progress-table-1.2.5 → progress-table-1.3.1}/progress_table/v1/styles.py

@@ -1,3 +1,6 @@
+#  Copyright (c) 2022-2024 Szymon Mikler
+
+
 class StyleNormal:
     name = "normal"
     pbar_filled = "■"

{progress-table-1.2.5 → progress-table-1.3.1}/progress_table.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: progress-table
-Version: 1.2.5
+Version: 1.3.1
 Summary: Display progress as a pretty table in the command line.
 Home-page: https://github.com/gahaalt/progress-table.git
 Author: Szymon Mikler

progress-table-1.3.1/progress_table.egg-info/PKG-INFO.sync-conflict-20240314-015933-NXTV2IO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.1
+Name: progress-table
+Version: 1.2.3
+Summary: Display progress as a pretty table in the command line.
+Home-page: https://github.com/gahaalt/progress-table.git
+Author: Szymon Mikler
+Author-email: sjmikler@gmail.com
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
+> Note: versions 1.X introduced new features and changes of default behaviour.
+>
+> The old version is still available as `progress_table.ProgressTableV0`.
+>
+> New features include:
+> * Nested progress bar support
+> * Custom table styles support
+> * Color customization on row level support
+> * Adding columns automatically, without calling `add_column`
+> * Continuous progress bar when iterator length is unknown
+> * Pandas and numpy being only optional dependencies
+> * Other minor changes
+
+# Progress Table
+
+[![PyPi version](https://img.shields.io/badge/dynamic/json?label=latest&query=info.version&url=https%3A%2F%2Fpypi.org%2Fpypi%2Fprogress-table%2Fjson)](https://pypi.org/project/progress-table)
+[![PyPI license](https://img.shields.io/badge/dynamic/json?label=license&query=info.license&url=https%3A%2F%2Fpypi.org%2Fpypi%2Fprogress-table%2Fjson)](https://pypi.org/project/progress-table)
+
+Lightweight utility to display the progress of your process as a pretty table in the command line.
+Alternative to TQDM whenever you want to track metrics produced by your process.
+
+![example](https://github.com/gahaalt/progress-table/blob/main/images/progress-table-example.png?raw=true)
+
+Designed to monitor machine learning experiments, but can be used for any metrics-producing process.
+Allows you to quickly see what's going on with your process.
+Increases readability and simplifies your command line logging.
+
+## Purpose
+
+Change this:
+
+![example](https://github.com/gahaalt/progress-table/blob/main/images/progress-before3.gif?raw=true)
+
+Into this:
+
+![example](https://github.com/gahaalt/progress-table/blob/main/images/progress-after4.gif?raw=true)
+
+## Example
+
+> Click here for examples of integration with deep learning libraries:
+> [integrations.md](https://github.com/gahaalt/progress-table/blob/main/integrations.md).
+
+```python
+import random
+import sys
+import time
+
+from progress_table import ProgressTable
+
+# Create table object:
+table = ProgressTable()
+
+# Or customize its settings:
+table = ProgressTable(
+    columns=["step"],
+    refresh_rate=20,
+    num_decimal_places=4,
+    default_column_width=None,
+    default_column_color=None,
+    default_column_alignment=None,
+    default_column_aggregate=None,
+    default_row_color=None,
+    embedded_progress_bar=True,
+    pbar_show_throughput=True,
+    pbar_show_progress=False,
+    print_row_on_update=True,
+    reprint_header_every_n_rows=30,
+    custom_format=None,
+    table_style="round",
+    file=sys.stdout,
+)
+
+# You (optionally) define the columns at the beginning
+table.add_column("x", width=3)
+table.add_column("x root", color="red")
+table.add_column("random average", color=["bright", "red"], aggregate="mean")
+
+for step in range(10):
+    x = random.randint(0, 200)
+
+    # There are two ways to add new values:
+    table["x"] = x
+    table["step"] = step
+    # Second:
+    table.update("x root", x ** 0.5)
+    table.update("x squared", x ** 2)
+
+    # Display the progress bar by wrapping the iterator
+    for _ in table(10):  # -> Equivalent to `table(range(10))`
+        # You can use weights for aggregated values
+        table.update("random average", random.random(), weight=1)
+        time.sleep(0.1)
+
+    # Go to the next row when you're ready
+    table.next_row()
+
+# Close the table when it's ready
+table.close()
+
+# Export your data
+data = table.to_list()
+pandas_df = table.to_df()  # Requires pandas to be installed
+np_array = table.to_numpy()  # Requires numpy to be installed
+```
+
+![example](https://github.com/gahaalt/progress-table/blob/main/images/example-output4.gif?raw=true)
+
+## Installation
+
+Install Progress Table easily with pip:
+
+```
+pip install progress-table
+```
+
+## Links
+
+* [See on GitHub](https://github.com/gahaalt/progress-table)
+* [See on PyPI](https://pypi.org/project/progress-table)
+
+## Alternatives
+
+* Progress bars: great for tracking progress, but they don't provide ways to display data in clear and compact way
+    * `tqdm`
+    * `rich.progress`
+    * `keras.utils.Progbar`
+
+* Libraries displaying data: great for presenting tabular data, but they lack the progress tracking aspect
+    * `rich.table`
+    * `tabulate`
+    * `texttable`

{progress-table-1.2.5 → progress-table-1.3.1}/progress_table.egg-info/SOURCES.txt

@@ -4,8 +4,8 @@ pyproject.toml
 setup.cfg
 setup.py
 progress_table/__init__.py
-progress_table/test_docs_automated.py
 progress_table.egg-info/PKG-INFO
+progress_table.egg-info/PKG-INFO.sync-conflict-20240314-015933-NXTV2IO
 progress_table.egg-info/SOURCES.txt
 progress_table.egg-info/dependency_links.txt
 progress_table.egg-info/requires.txt

{progress-table-1.2.5 → progress-table-1.3.1}/setup.py

@@ -1,8 +1,8 @@
-#  Copyright (c) 2022 Szymon Mikler
+#  Copyright (c) 2022-2024 Szymon Mikler
 
 from pathlib import Path
 
-from setuptools import setup, find_packages
+from setuptools import find_packages, setup
 
 
 def package_relative_path(path):

progress-table-1.2.5/progress_table/test_docs_automated.py

@@ -1,60 +0,0 @@
-#  Copyright (c) 2022 Szymon Mikler
-
-import logging
-import os
-import pathlib
-import re
-
-
-def get_header(msg):
-    msg_len = len(msg)
-    header = [
-        "#" * (msg_len + 6),
-        "## " + msg + " ##",
-        "#" * (msg_len + 6),
-    ]
-    return "\n".join(header) + "\n"
-
-
-def scan_for_code_blobs(text):
-    # Capture code blocks starting with py or python
-    blobs = re.findall(r"```(py|python)\n([\s\S]+?)\n```", text)
-
-    new_blobs = []
-    for mode, blob in blobs:
-        if "..." in blob:
-            continue
-        header = get_header(f"Generated ({mode})")
-        blob = header + blob
-
-        # For `py` code blocks, we append them to previous existing block
-        # But `python` block starts a new scope and finishes the previous block
-        # They usually need to include imports
-        if mode == "py" and new_blobs:
-            new_blobs[-1] = new_blobs[-1] + "\n" + blob
-        else:
-            new_blobs.append(blob)
-    return new_blobs
-
-
-def test_all_code_blobs():
-    all_code_blobs = []
-
-    for root, dirs, files in os.walk("."):
-        for file in files:
-            path = pathlib.Path(os.path.join(root, file))
-            if path.suffix == ".md":
-                code_blobs = scan_for_code_blobs(path.open("r").read())
-                for blob in code_blobs:
-                    all_code_blobs.append(blob)
-
-    logging.warning(f"Detected {len(all_code_blobs)} code examples!")
-
-    for idx, blob in enumerate(all_code_blobs):
-        try:
-            globals_temp = {}
-            exec(blob, globals_temp)
-        except Exception as e:
-            print(f"Exception during automated documentation testing {idx}/{len(all_code_blobs)}:")
-            print(blob)
-            raise e