progress-table 2.0.0__tar.gz → 2.2.0__tar.gz

{progress-table-2.0.0 → progress-table-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: progress-table
-Version: 2.0.0
+Version: 2.2.0
 Summary: Display progress as a pretty table in the command line.
 Home-page: https://github.com/gahaalt/progress-table.git
 Author: Szymon Mikler
@@ -118,8 +118,8 @@ Progress Table works correctly in most consoles, but there are some exceptions:
 * Some consoles like `PyCharm Python Console` or `IDLE` don't support cursor movement.
   You can still use ProgressTable, but with `interactive=1` option. This mode displays only 1 progress bar at once.
 
-> By default `interactive=2`. You can change the default `interactive` by
-> setting `PTABLE_INTERACTIVE` environment variable, e.g. `PTABLE_INTERACTIVE=1`.
+> By default `interactive=2`. You can change the default `interactive` with an argument when creating the table object
+> or by setting `PTABLE_INTERACTIVE` environment variable, e.g. `PTABLE_INTERACTIVE=1`.
 
 ## Installation
 

{progress-table-2.0.0 → progress-table-2.2.0}/README.md

@@ -97,8 +97,8 @@ Progress Table works correctly in most consoles, but there are some exceptions:
 * Some consoles like `PyCharm Python Console` or `IDLE` don't support cursor movement.
   You can still use ProgressTable, but with `interactive=1` option. This mode displays only 1 progress bar at once.
 
-> By default `interactive=2`. You can change the default `interactive` by
-> setting `PTABLE_INTERACTIVE` environment variable, e.g. `PTABLE_INTERACTIVE=1`.
+> By default `interactive=2`. You can change the default `interactive` with an argument when creating the table object
+> or by setting `PTABLE_INTERACTIVE` environment variable, e.g. `PTABLE_INTERACTIVE=1`.
 
 ## Installation
 

{progress-table-2.0.0 → progress-table-2.2.0}/progress_table/__init__.py

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

progress-table-2.2.0/progress_table/v1/common.py

@@ -0,0 +1,47 @@
+#  Copyright (c) 2022-2024 Szymon Mikler
+
+from __future__ import annotations
+
+from typing import Union
+
+from colorama import Back, Fore, Style
+
+ALL_COLOR_NAME = [x for x in dir(Fore) if not x.startswith("__")]
+ALL_STYLE_NAME = [x for x in dir(Style) if not x.startswith("__")]
+ALL_COLOR_STYLE_NAME = ALL_COLOR_NAME + ALL_STYLE_NAME
+ALL_COLOR = [getattr(Fore, x) for x in ALL_COLOR_NAME] + [getattr(Back, x) for x in ALL_COLOR_NAME]
+ALL_STYLE = [getattr(Style, x) for x in ALL_STYLE_NAME]
+ALL_COLOR_STYLE = ALL_COLOR + ALL_STYLE
+
+COLORAMA_TRANSLATE = {
+    "bold": "bright",
+}
+
+NoneType = type(None)
+ColorFormat = Union[str, tuple, list, NoneType]
+ColorFormatTuple = (str, tuple, list, NoneType)
+
+CURSOR_UP = "\033[A"
+
+
+def maybe_convert_to_colorama_str(color: str) -> str:
+    # Translation layer to fix unintuitive colorama names
+    color = COLORAMA_TRANSLATE.get(color.lower(), color)
+
+    if isinstance(color, str):
+        if hasattr(Fore, color.upper()):
+            return getattr(Fore, color.upper())
+        if hasattr(Style, color.upper()):
+            return getattr(Style, color.upper())
+
+    assert color in ALL_COLOR_STYLE, f"Color {color!r} incorrect! Available: {' '.join(ALL_COLOR_STYLE_NAME)}"
+    return color
+
+
+def maybe_convert_to_colorama(color: ColorFormat) -> str:
+    if color is None or color == "":
+        return ""
+    if isinstance(color, str):
+        color = color.split(" ")
+    results = [maybe_convert_to_colorama_str(x) for x in color]
+    return "".join(results)

{progress-table-2.0.0 → progress-table-2.2.0}/progress_table/v1/progress_table.py

@@ -12,30 +12,13 @@ import sys
 import time
 from dataclasses import dataclass
 from threading import Thread
-from typing import Any, Callable, Iterable, Sized, Type, Union
+from typing import Any, Callable, Iterable, Sized, Type
 
-from colorama import Back, Fore, Style
+from colorama import Style
 
-from . import styles
-
-ALL_COLOR_NAME = [x for x in dir(Fore) if not x.startswith("__")]
-ALL_STYLE_NAME = [x for x in dir(Style) if not x.startswith("__")]
-ALL_COLOR_STYLE_NAME = ALL_COLOR_NAME + ALL_STYLE_NAME
-
-ALL_COLOR = [getattr(Fore, x) for x in ALL_COLOR_NAME] + [getattr(Back, x) for x in ALL_COLOR_NAME]
-ALL_STYLE = [getattr(Style, x) for x in ALL_STYLE_NAME]
-ALL_COLOR_STYLE = ALL_COLOR + ALL_STYLE
-
-COLORAMA_TRANSLATE = {
-    "bold": "bright",
-}
-
-NoneType = type(None)
-ColorFormat = Union[str, tuple, list, NoneType]
-ColorFormatTuple = (str, tuple, list, NoneType)
-
-EPS = 1e-9
-CURSOR_UP = "\033[A"
+from progress_table.v1 import styles
+from progress_table.v1.common import CURSOR_UP, ColorFormat, ColorFormatTuple, maybe_convert_to_colorama
+from progress_table.v1.styles import parse_pbar_style
 
 # Flags that indicate if the warning was already triggered
 WARNED_PBAR_HIDDEN = False
@@ -91,29 +74,6 @@ def get_aggregate_fn(aggregate: None | str | Callable):
         raise ValueError(f"Unknown aggregate type: {type(aggregate)}")
 
 
-def maybe_convert_to_colorama_str(color: str) -> str:
-    # Translation layer to fix unintuitive colorama names
-    color = COLORAMA_TRANSLATE.get(color.lower(), color)
-
-    if isinstance(color, str):
-        if hasattr(Fore, color.upper()):
-            return getattr(Fore, color.upper())
-        if hasattr(Style, color.upper()):
-            return getattr(Style, color.upper())
-
-    assert color in ALL_COLOR_STYLE, f"Color {color!r} incorrect! Available: {' '.join(ALL_COLOR_STYLE_NAME)}"
-    return color
-
-
-def maybe_convert_to_colorama(color: ColorFormat) -> str:
-    if color is None or color == "":
-        return ""
-    if isinstance(color, str):
-        color = color.split(" ")
-    results = [maybe_convert_to_colorama_str(x) for x in color]
-    return "".join(results)
-
-
 def get_default_format_func(decimal_places):
     def fmt(x) -> str:
         if isinstance(x, int):
@@ -151,19 +111,19 @@ class ProgressTableV1:
         default_column_color: ColorFormat = None,
         default_column_alignment: str | None = None,
         default_column_aggregate: str | None = None,
+        default_header_color: ColorFormat = None,
         default_row_color: ColorFormat = None,
         pbar_show_throughput: bool = True,
         pbar_show_progress: bool = False,
         pbar_show_percents: bool = False,
         pbar_show_eta: bool = False,
         pbar_embedded: bool = True,
-        pbar_color: ColorFormat = None,
+        pbar_style: str | Type[styles.PbarStyleBase] = "square",
+        pbar_style_embed: str | Type[styles.PbarStyleBase] = "embed",
         print_header_on_top: bool = True,
         print_header_every_n_rows: int = 30,
         custom_cell_format: Callable[[Any], str] | None = None,
         table_style: str | Type[styles.TableStyleBase] = "round",
-        pbar_style: str | Type[styles.PbarStyleBase] = "normal",
-        pbar_style_embed: str | Type[styles.PbarStyleBase] = "embed",
         file=None,
         # Deprecated arguments
         custom_format: None = None,
@@ -234,12 +194,14 @@ class ProgressTableV1:
         if print_row_on_update is not None:
             logging.warning("Argument `print_row_on_update` is deprecated. Specify `interactive` instead!")
 
-        self.table_style = styles.figure_table_style(table_style)
-        self.pbar_style = styles.figure_pbar_style(pbar_style)
-        self.pbar_style_embed = styles.figure_pbar_style(pbar_style_embed)
+        self.table_style = styles.parse_table_style(table_style)
+
+        self.pbar_style = styles.parse_pbar_style(pbar_style)
+        self.pbar_style_embed = styles.parse_pbar_style(pbar_style_embed)
 
         assert isinstance(default_row_color, ColorFormatTuple), "Row color has to be a color format!"  # type: ignore
         assert isinstance(default_column_color, ColorFormatTuple), "Column color has to be a color format!"  # type: ignore
+        assert isinstance(default_header_color, ColorFormatTuple), "Header color has to be a color format!"  # type: ignore
 
         # Default values for column and
         self.column_width = default_column_width
@@ -247,6 +209,7 @@ class ProgressTableV1:
         self.column_alignment = default_column_alignment
         self.column_aggregate = default_column_aggregate
         self.row_color = default_row_color
+        self.header_color = default_header_color
 
         # We are storing column configs
         self.column_widths: dict[str, int] = {}
@@ -282,7 +245,6 @@ class ProgressTableV1:
         self.pbar_show_percents: bool = pbar_show_percents
         self.pbar_show_eta: bool = pbar_show_eta
         self.pbar_embedded: bool = pbar_embedded
-        self.pbar_color = pbar_color
 
         self.refresh_rate: int = refresh_rate
 
@@ -786,8 +748,10 @@ class ProgressTableV1:
 
     def _get_header(self):
         content = []
+        colors = self.column_colors if self.header_color is None else self._resolve_row_color_dict(self.header_color)
+
         for column in self.column_names:
-            value = self._apply_cell_formatting(column, column, color=self.column_colors[column])
+            value = self._apply_cell_formatting(column, column, color=colors[column])
             content.append(value)
         s = "".join(["\r", self.table_style.vertical, self.table_style.vertical.join(content), self.table_style.vertical])
         return s
@@ -802,7 +766,6 @@ class ProgressTableV1:
         *range_args,
         position=None,
         static=False,
-        color="",
         total=None,
         refresh_rate=None,
         description="",
@@ -810,6 +773,10 @@ class ProgressTableV1:
         show_progress=None,
         show_percents=None,
         show_eta=None,
+        style=None,
+        style_embed=None,
+        color=None,
+        color_empty=None,
     ):
         """Create iterable progress bar object.
 
@@ -819,7 +786,6 @@ class ProgressTableV1:
             position: Level of the progress bar. If not provided, it will be set automatically.
             static: If True, the progress bar will stick to the row with index given by position.
                     If False, the position will be interpreted as the offset from the last row.
-            color: Color of the progress bar.
             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.
@@ -827,6 +793,10 @@ class ProgressTableV1:
             show_progress: If True, the progress will be displayed.
             show_percents: If True, the percentage of the progress will be displayed.
             show_eta: If True, the estimated time of finishing will be displayed.
+            style: Style of the progress bar. If None, the default style will be used.
+            style_embed: Style of the embedded progress bar. If None, the default style will be used.
+            color: Color of the progress bar. This overrides the default color.
+            color_empty: Color of the empty progress bar. This overrides the default color.
         """
         if isinstance(iterable, int):
             iterable = range(iterable, *range_args)
@@ -844,13 +814,19 @@ class ProgressTableV1:
 
         total = total if total is not None else (len(iterable) if isinstance(iterable, Sized) else 0)
 
+        style = parse_pbar_style(style) if style else self.pbar_style
+        style_embed = parse_pbar_style(style_embed) if style_embed else self.pbar_style_embed
+
         pbar = TableProgressBar(
             iterable=iterable,
             table=self,
             total=total,
+            style=style,
+            style_embed=style_embed,
+            color=color,
+            color_empty=color_empty,
             position=position,
             static=static,
-            color=color or self.pbar_color,
             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,
@@ -872,7 +848,10 @@ class TableProgressBar:
         *,
         table,
         total,
+        style,
+        style_embed,
         color,
+        color_empty,
         position,
         static,
         description,
@@ -888,10 +867,21 @@ class TableProgressBar:
         self._creation_time: float = time.perf_counter()
         self._last_refresh_time: float = -float("inf")
 
+        self.style = style
+        self.style_embed = style_embed
+
+        # Modyfing styles
+        if color:
+            color = maybe_convert_to_colorama(color)
+            self.style.color = color
+            self.style_embed.color = color
+        if color_empty:
+            color_empty = maybe_convert_to_colorama(color_empty)
+            self.style.color_empty = color_empty
+            self.style_embed.color_empty = color_empty
+
         self.position: int = position
         self.static: bool = static
-
-        self.color: str = maybe_convert_to_colorama(color)
         self.table: ProgressTableV1 = table
         self.description: str = description
         self.show_throughput: bool = show_throughput
@@ -977,6 +967,7 @@ class TableProgressBar:
             total = tot_width
 
         num_filled = math.ceil(step / total * tot_width)
+        frac_missing = step / total * tot_width - num_filled
         num_empty = tot_width - num_filled
 
         if embed_str is not None:
@@ -985,23 +976,35 @@ class TableProgressBar:
 
             filled_part = row_str[:num_filled]
             if len(filled_part) > 0 and filled_part[-1] == " ":
-                filled_part = filled_part[:-1] + self.table.pbar_style_embed.head
-            filled_part = filled_part.replace(" ", self.table.pbar_style_embed.filled)
+                head = self.style_embed.head
+                if isinstance(head, (tuple, list)):
+                    head = head[round(frac_missing * len(head))]
+                filled_part = filled_part[:-1] + head
+            filled_part = filled_part.replace(" ", self.style_embed.filled)
             empty_part = row_str[num_filled:-1]
+            color_filled = self.style_embed.color
+            color_empty = self.style_embed.color_empty
         else:
-            filled_part = self.table.pbar_style.filled * num_filled
+            filled_part = self.style.filled * num_filled
             if len(filled_part) > 0:
-                filled_part = filled_part[:-1] + self.table.pbar_style.head
-            empty_part = self.table.pbar_style.empty * num_empty
+                head = self.style.head
+                if isinstance(head, (tuple, list)):
+                    head = head[round(frac_missing * len(head))]
+                filled_part = filled_part[:-1] + head
+            empty_part = self.style.empty * num_empty
+            color_filled = self.style.color
+            color_empty = self.style.color_empty
 
         pbar_body = "".join(
             [
                 self.table.table_style.vertical,
                 infobar,
-                self.color,
+                color_filled,
                 filled_part,
-                Style.RESET_ALL if self.color else "",
+                Style.RESET_ALL if color_filled else "",
+                color_empty,
                 empty_part,
+                Style.RESET_ALL if color_empty else "",
                 self.table.table_style.vertical,
             ]
         )

{progress-table-2.0.0 → progress-table-2.2.0}/progress_table/v1/styles.py

@@ -1,28 +1,59 @@
 #  Copyright (c) 2022-2024 Szymon Mikler
 
+from progress_table.v1.common import ALL_COLOR_NAME, maybe_convert_to_colorama
 
-def figure_pbar_style(pbar_style_name):
-    if isinstance(pbar_style_name, str):
-        pbar_style_name = pbar_style_name.lower()
+
+def contains_word(short, long):
+    return any([short == word.strip(" ") for word in long.split(" ")])
+
+
+def parse_colors_from_description(description):
+    color = ""
+    color_empty = ""
+    for word in description.split():
+        for color_name in ALL_COLOR_NAME:
+            if color_name.lower() == word.lower():
+                if not color:
+                    color = color_name
+                else:
+                    color_empty = color_name
+                description = description.replace(word, "")
+    return color, color_empty, description
+
+
+def parse_pbar_style(description):
+    if isinstance(description, str):
         for obj in available_pbar_styles():
-            if obj.name == pbar_style_name:
-                return obj
+            if contains_word(obj.name, description):
+                description = description.replace(obj.name, "")
+                color, color_empty, description = parse_colors_from_description(description)
+                is_alt = "alt" in description
+                is_clean = "clean" in description
+                description = description.replace("alt", "").replace("clean", "").strip(" ")
+                if description.strip(" "):
+                    raise ValueError(f"Name '{description}' is not recognized as a part of progress bar style")
+
+                return obj(alt=is_alt, clean=is_clean, color=color, color_empty=color_empty)
+
         available_names = ", ".join([obj.name for obj in available_pbar_styles()])
-        raise ValueError(f"Progress bar style '{pbar_style_name}' not found. Available: {available_names}")
+        raise ValueError(f"Progress bar style '{description}' not found. Available: {available_names}")
     else:
-        return pbar_style_name
+        return description
 
 
-def figure_table_style(table_style_name):
-    if isinstance(table_style_name, str):
-        table_style_name = table_style_name.lower()
+def parse_table_style(description):
+    if isinstance(description, str):
         for obj in available_table_styles():
-            if obj.name == table_style_name:
-                return obj
+            if contains_word(obj.name, description):
+                description = description.replace(obj.name, "").strip(" ")
+                if description:
+                    raise ValueError(f"Name '{description}' is not recognized as a part of table style")
+
+                return obj()
         available_names = ", ".join([obj.name for obj in available_table_styles()])
-        raise ValueError(f"Table style '{table_style_name}' not found. Available: {available_names}")
+        raise ValueError(f"Table style '{description}' not found. Available: {available_names}")
     else:
-        return table_style_name
+        return description
 
 
 def available_table_styles():
@@ -42,34 +73,53 @@ class PbarStyleBase:
     name: str
     filled: str
     empty: str
-    head: str
-
-
-class PbarStyleNormal(PbarStyleBase):
-    name = "normal"
+    head: str | tuple[str, ...]
+    color: str = ""
+    color_empty: str = ""
+
+    def __init__(self, alt=False, clean=False, color=None, color_empty=None):
+        if color is not None:
+            self.color = maybe_convert_to_colorama(color)
+        if color_empty is not None:
+            self.color_empty = maybe_convert_to_colorama(color_empty)
+        if alt:
+            self.empty = self.filled
+        if clean:
+            self.empty = " "
+
+
+class PbarStyleSquare(PbarStyleBase):
+    name = "square"
     filled = "■"
     empty = "□"
     head = "◩"
 
 
-class PbarStyleNormalClean(PbarStyleBase):
-    name = "normal clean"
-    filled = "■"
+class PbarStyleFull(PbarStyleBase):
+    name = "full"
+    filled = "█"
     empty = " "
-    head = "◩"
+    head = ("▏", "▎", "▍", "▌", "▋", "▊", "▉")
 
 
-class PbarStyleCircle(PbarStyleBase):
-    name = "cirlce"
-    filled = "●"
-    empty = "○"
-    head = "◉"
+class PbarStyleDots(PbarStyleBase):
+    name = "dots"
+    filled = "⣿"
+    empty = "⣀"
+    head = ("⣄", "⣤", "⣦", "⣶", "⣷")
+
 
+class PbarStyleShort(PbarStyleBase):
+    name = "short"
+    filled = "▬"
+    empty = "▭"
+    head = "▬"
 
-class PbarStyleCircleClean(PbarStyleBase):
-    name = "circle clean"
+
+class PbarStyleCircle(PbarStyleBase):
+    name = "circle"
     filled = "●"
-    empty = " "
+    empty = "○"
     head = "◉"
 
 
@@ -80,13 +130,6 @@ class PbarStyleAngled(PbarStyleBase):
     head = "▰"
 
 
-class PbarStyleAngledClean(PbarStyleBase):
-    name = "angled clean"
-    filled = "▰"
-    empty = " "
-    head = "▰"
-
-
 class PbarStyleEmbed(PbarStyleBase):
     name = "embed"
     filled = "ꞏ"
@@ -94,6 +137,21 @@ class PbarStyleEmbed(PbarStyleBase):
     head = ">"
 
 
+class PbarStyleRich(PbarStyleBase):
+    name = "rich"
+    filled = "━"
+    empty = " "
+    head = "━"
+
+    def __init__(self, *args, **kwds):
+        """Similar to the default progress bar from rich"""
+        super().__init__(*args, **kwds)
+        if not self.color and not self.color_empty:
+            self.color = maybe_convert_to_colorama("red")
+            self.color_empty = maybe_convert_to_colorama("black")
+            self.empty = self.filled
+
+
 class PbarStyleNone(PbarStyleBase):
     name = "hidden"
     filled = " "
@@ -122,8 +180,8 @@ class TableStyleBase:
     no_down: str
 
 
-class TableStyleNormal(TableStyleBase):
-    name = "normal"
+class TableStyleModern(TableStyleBase):
+    name = "modern"
     cell_overflow = "…"
     horizontal = "─"
     vertical = "│"
@@ -219,7 +277,7 @@ class TableStyleAscii(TableStyleBase):
 
 
 class TableStyleAsciiBare(TableStyleBase):
-    name = "ascii bare"
+    name = "asciib"
     cell_overflow = "_"
     horizontal = "-"
     vertical = " "

{progress-table-2.0.0 → progress-table-2.2.0}/progress_table.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: progress-table
-Version: 2.0.0
+Version: 2.2.0
 Summary: Display progress as a pretty table in the command line.
 Home-page: https://github.com/gahaalt/progress-table.git
 Author: Szymon Mikler
@@ -118,8 +118,8 @@ Progress Table works correctly in most consoles, but there are some exceptions:
 * Some consoles like `PyCharm Python Console` or `IDLE` don't support cursor movement.
   You can still use ProgressTable, but with `interactive=1` option. This mode displays only 1 progress bar at once.
 
-> By default `interactive=2`. You can change the default `interactive` by
-> setting `PTABLE_INTERACTIVE` environment variable, e.g. `PTABLE_INTERACTIVE=1`.
+> By default `interactive=2`. You can change the default `interactive` with an argument when creating the table object
+> or by setting `PTABLE_INTERACTIVE` environment variable, e.g. `PTABLE_INTERACTIVE=1`.
 
 ## Installation
 

{progress-table-2.0.0 → progress-table-2.2.0}/progress_table.egg-info/SOURCES.txt

@@ -14,6 +14,7 @@ progress_table/v0/__init__.py
 progress_table/v0/progress_table.py
 progress_table/v0/symbols.py
 progress_table/v1/__init__.py
+progress_table/v1/common.py
 progress_table/v1/progress_table.py
 progress_table/v1/styles.py
 tests/test_docs_automated.py

{progress-table-2.0.0 → progress-table-2.2.0}/tests/test_examples_automated.py

@@ -8,7 +8,7 @@ from io import StringIO
 
 EXPECTED_OUTPUTS = {
     "examples.training": "14af860a37118c16aec4604e5629e5ed",
-    "examples.tictactoe": "056841a6cbf7456cd3daacbff356088a",
+    "examples.tictactoe": "378133fb7804a678282564d751068531",
     "examples.brown2d": "c0f37fdfcfc2db6ef465473c67c05d83",
 }
 
@@ -27,7 +27,7 @@ def capture_example_stdout(main_fn):
     # We will replace stdout with custom StringIO and check whether example stdout is as expected
     out_buffer = StringIO()
     sys.stdout = out_buffer
-    main_fn(random_seed=42, **override_kwds)
+    main_fn(random_seed=42, sleep_duration=0, **override_kwds)
     sys.stdout = sys.__stdout__
     return out_buffer.getvalue()