Added additional_variables argument to log21.ProgressBar class. You can use it in order to add additional variables to the progress bar.

Author: MPCodeWriter21

.github/workflows/automatic-release.yml

@@ -23,10 +23,12 @@ jobs:
       - name: Build
         run: |
           python setup.py sdist bdist_wheel
+          pip install dist/*.whl
+          export PACKAGE_VERSION=$(python -c "import log21; print(log21.__version__)")
       - uses: "marvinpinto/action-automatic-releases@latest"
         with:
           repo_token: "${{ secrets.GITHUB_TOKEN }}"
-          automatic_release_tag: "latest"
+          automatic_release_tag: PACKAGE_VERSION
           title: "Auto Build"
           files: |
             dist/*

CHANGES-LOG.md

@@ -6,6 +6,23 @@ Help this project by [Donation](DONATE.md)
 Changes log
 -----------
 
+### 2.3.2
+
+Added `additional_variables` argument to `log21.ProgressBar` class. You can use it in order to add additional variables
+to the progress bar:
+
+```python3
+import log21, time
+
+progress_bar = log21.ProgressBar(format_='Iteration: {i} {prefix}{bar}{suffix} {percentage}%', style='{',
+                                 additional_variables={"i": 0})
+
+for i in range(100):
+    progress_bar(i + 1, 100, i=i)
+    time.sleep(0.1)
+# Iteration: 99 |██████████████████████████████████████████████████████████████████████████████| 100%
+```
+
 ### 2.3.1
 
 Added `formatter` argument to `StreamHandler` and `FileHandler`. You can use it to set the formatter of the handler when

README.md

@@ -53,10 +53,22 @@ python setup.py install
 Changes
 -------
 
-### 2.3.1
+### 2.3.2
 
-Added `formatter` argument to `StreamHandler` and `FileHandler`. You can use it to set the formatter of the handler when
-you create it. Added `handlers` argument to `Logger`. You can use it to add handlers to the logger when you create it.
+Added `additional_variables` argument to `log21.ProgressBar` class. You can use it in order to add additional variables
+to the progress bar:
+
+```python3
+import log21, time
+
+progress_bar = log21.ProgressBar(format_='Iteration: {i} {prefix}{bar}{suffix} {percentage}%', style='{',
+                                 additional_variables={"i": 0})
+
+for i in range(100):
+    progress_bar(i + 1, 100, i=i)
+    time.sleep(0.1)
+# Iteration: 99 |██████████████████████████████████████████████████████████████████████████████| 100%
+```
 
 [Full Changes Log](https://github.com/MPCodeWriter21/log21/blob/master/CHANGES-LOG.md)
 

log21/Logger.py

@@ -175,11 +175,11 @@ def getpass(self, *msg, args: tuple = (), end='', **kwargs):
         self._log(self.level if self.level >= NOTSET else NOTSET, msg, args, **kwargs)
         return _getpass('')
 
-    def print_progress(self, progress: float, total: float):
+    def print_progress(self, progress: float, total: float, **kwargs):
         """
         Log progress.
         """
-        self.progress_bar(progress, total)
+        self.progress_bar(progress, total, **kwargs)
 
     @property
     def progress_bar(self):

log21/ProgressBar.py

@@ -3,6 +3,8 @@
 
 import os as _os
 
+from typing import Dict as _Dict, Any as _Any
+
 import log21 as _log21
 from log21.Logger import Logger as _Logger
 from log21.StreamHandler import ColorizingStreamHandler as _ColorizingStreamHandler
@@ -39,7 +41,8 @@ class ProgressBar:
 
     def __init__(self, *args, width: int = None, show_percentage: bool = True, prefix: str = '|', suffix: str = '|',
                  fill: str = '█', empty: str = ' ', format_: str = None, style: str = '%',
-                 new_line_when_complete: bool = True, colors: dict = None, logger: '_log21.Logger' = _logger):
+                 new_line_when_complete: bool = True, colors: dict = None, logger: '_log21.Logger' = _logger,
+                 additional_variables: _Dict[str, _Any] = None):
         """
         :param args: Prevents the use of positional arguments
         :param width: The width of the progress bar
@@ -53,6 +56,7 @@ def __init__(self, *args, width: int = None, show_percentage: bool = True, prefi
         :param new_line_when_complete: Whether to print a new line when the progress is complete or failed
         :param colors: The colors of the progress bar
         :param logger: The logger to use
+        :param additional_variables: Additional variables to use in the format and their default values
         """
         self.width = width if width else _os.get_terminal_size().columns - 1
         if self.width < 3:
@@ -71,6 +75,16 @@ def __init__(self, *args, width: int = None, show_percentage: bool = True, prefi
             raise ValueError('`empty` must be a single character')
         if style not in ['%', '{']:
             raise ValueError('`style` must be either `%` or `{`')
+        if additional_variables:
+            if not isinstance(additional_variables, dict):
+                raise TypeError('`additional_variables` must be a dictionary')
+            for key, value in additional_variables.items():
+                if not isinstance(key, str):
+                    raise TypeError('`additional_variables` keys must be strings')
+                if not isinstance(value, str):
+                    additional_variables[key] = str(value)
+        else:
+            additional_variables = dict()
 
         self.colors = {
             'progress in-progress': _gc('LightYellow'),
@@ -105,24 +119,30 @@ def __init__(self, *args, width: int = None, show_percentage: bool = True, prefi
             for key, value in colors.items():
                 self.colors[key] = value
         self.logger = logger
+        self.additional_variables = additional_variables
         self.i = 0
 
-    def get_bar(self, progress: float, total: float):
+    def get_bar(self, progress: float, total: float, **kwargs) -> str:
         if progress == total:
-            return self.progress_complete()
+            return self.progress_complete(**kwargs)
         elif progress > total or progress < 0:
-            return self.progress_failed(progress, total)
+            return self.progress_failed(progress, total, **kwargs)
         else:
-            return self.progress_in_progress(progress, total)
+            return self.progress_in_progress(progress, total, **kwargs)
 
-    def progress_in_progress(self, progress: float, total: float):
+    def progress_in_progress(self, progress: float, total: float, **kwargs):
         percentage = str(round(progress / total * 100, 2))
         progress_dict = {
             'prefix': self.prefix,
             'bar': '',
             'suffix': self.suffix,
-            'percentage': percentage
+            'percentage': percentage,
+            **self.additional_variables
         }
+        for key, value in kwargs.items():
+            if key in ['prefix', 'bar', 'suffix', 'percentage']:
+                raise ValueError(f'`{key}` is a reserved keyword')
+            progress_dict[key] = value
 
         if self.style == '%':
             used_characters = len(self.format % progress_dict)
@@ -142,28 +162,34 @@ def progress_in_progress(self, progress: float, total: float):
 
         progress_dict = {
             'prefix': self.colors['prefix-color in-progress'] + self.prefix + self.colors['reset-color'],
-            'bar': self.colors['progress in-progress'] +
-                   (self.fill * fill_length + spinner_char + self.empty * empty_length) + self.colors['reset-color'],
+            'bar': self.colors['progress in-progress'] + (self.fill * fill_length + spinner_char +
+                                                          self.empty * empty_length) + self.colors['reset-color'],
             'suffix': self.colors['suffix-color in-progress'] + self.suffix + self.colors['reset-color'],
-            'percentage': self.colors["percentage in-progress"] + str(percentage) + self.colors['reset-color']
+            'percentage': self.colors["percentage in-progress"] + str(percentage) + self.colors['reset-color'],
+            **self.additional_variables
         }
+        for key, value in kwargs.items():
+            progress_dict[key] = value
 
         if self.style == '%':
-            bar = self.format % progress_dict
+            return '\r' + self.format % progress_dict + self.colors['reset-color']
         elif self.style == '{':
-            bar = self.format.format(**progress_dict)
+            return '\r' + self.format.format(**progress_dict) + self.colors['reset-color']
         else:
             raise ValueError('`style` must be either `%` or `{`')
 
-        return '\r' + bar + self.colors['reset-color']
-
-    def progress_complete(self):
+    def progress_complete(self, **kwargs):
         progress_dict = {
             'prefix': self.prefix,
             'bar': '',
             'suffix': self.suffix,
-            'percentage': '100'
+            'percentage': '100',
+            **self.additional_variables
         }
+        for key, value in kwargs.items():
+            if key in ['prefix', 'bar', 'suffix', 'percentage']:
+                raise ValueError(f'`{key}` is a reserved keyword')
+            progress_dict[key] = value
 
         if self.style == '%':
             bar_length = self.width - len(self.format % progress_dict)
@@ -176,25 +202,33 @@ def progress_complete(self):
             'prefix': self.colors['prefix-color complete'] + self.prefix + self.colors['reset-color'],
             'bar': self.colors['progress complete'] + (self.fill * bar_length) + self.colors['reset-color'],
             'suffix': self.colors['suffix-color complete'] + self.suffix + self.colors['reset-color'],
-            'percentage': self.colors["percentage complete"] + '100' + self.colors['reset-color']
+            'percentage': self.colors["percentage complete"] + '100' + self.colors['reset-color'],
+            **self.additional_variables
         }
+        for key, value in kwargs.items():
+            progress_dict[key] = value
 
         if self.style == '%':
-            bar = self.format % progress_dict
+            return '\r' + self.format % progress_dict + self.colors['reset-color'] + \
+                   ('\n' if self.new_line_when_complete else '')
         elif self.style == '{':
-            bar = self.format.format(**progress_dict)
+            return '\r' + self.format.format(**progress_dict) + self.colors['reset-color'] + \
+                   ('\n' if self.new_line_when_complete else '')
         else:
             raise ValueError('`style` must be either `%` or `{`')
 
-        return '\r' + bar + self.colors['reset-color'] + ('\n' if self.new_line_when_complete else '')
-
-    def progress_failed(self, progress: float, total: float):
+    def progress_failed(self, progress: float, total: float, **kwargs):
         progress_dict = {
             'prefix': self.prefix,
             'bar': '',
             'suffix': self.suffix,
-            'percentage': str(round(progress / total * 100, 2))
+            'percentage': str(round(progress / total * 100, 2)),
+            **self.additional_variables
         }
+        for key, value in kwargs.items():
+            if key in ['prefix', 'bar', 'suffix', 'percentage']:
+                raise ValueError(f'`{key}` is a reserved keyword')
+            progress_dict[key] = value
 
         if self.style == '%':
             bar_length = self.width - len(self.format % progress_dict)
@@ -212,8 +246,11 @@ def progress_failed(self, progress: float, total: float):
             'prefix': self.colors['prefix-color failed'] + self.prefix + self.colors['reset-color'],
             'bar': self.colors['progress failed'] + (bar_char * bar_length) + self.colors['reset-color'],
             'suffix': self.colors['suffix-color failed'] + self.suffix + self.colors['reset-color'],
-            'percentage': self.colors["percentage failed"] + progress_dict['percentage'] + self.colors['reset-color']
+            'percentage': self.colors["percentage failed"] + progress_dict['percentage'] + self.colors['reset-color'],
+            **self.additional_variables
         }
+        for key, value in kwargs.items():
+            progress_dict[key] = value
 
         if self.style == '%':
             bar = self.format % progress_dict
@@ -224,11 +261,11 @@ def progress_failed(self, progress: float, total: float):
 
         return '\r' + bar + self.colors['reset-color'] + ('\n' if self.new_line_when_complete else '')
 
-    def __call__(self, progress: float, total: float, logger: '_log21.Logger' = None):
+    def __call__(self, progress: float, total: float, logger: '_log21.Logger' = None, **kwargs):
         if not logger:
             logger = self.logger
 
-        logger.print(self.get_bar(progress, total), end='')
+        logger.print(self.get_bar(progress, total, **kwargs), end='')
 
-    def update(self, progress: float, total: float, logger: '_log21.Logger' = None):
-        self(progress, total, logger)
+    def update(self, progress: float, total: float, logger: '_log21.Logger' = None, **kwargs):
+        self(progress, total, logger, **kwargs)

log21/__init__.py

@@ -21,7 +21,7 @@
 from log21.Formatters import ColorizingFormatter, DecolorizingFormatter
 from log21.Colors import Colors, get_color, get_colors, ansi_escape, get_color_name, closest_color
 
-__version__ = "2.3.1"
+__version__ = "2.3.2"
 __author__ = "CodeWriter21 (Mehrad Pooryoussof)"
 __github__ = "Https://GitHub.com/MPCodeWriter21/log21"
 __all__ = ['ColorizingStreamHandler', 'DecolorizingFileHandler', 'ColorizingFormatter', 'DecolorizingFormatter',

setup.py

@@ -7,7 +7,7 @@
     long_description = file.read()
 
 DESCRIPTION = 'A simple logging package that helps you log colorized messages in Windows console.'
-VERSION = '2.3.1'
+VERSION = '2.3.2'
 
 setup(
     name='log21',