Merge pull request #4 from MPCodeWriter21/V3

V3 Update

Author: MPCodeWriter21

.github/ISSUE_TEMPLATE/bug_report.md

@@ -20,13 +20,15 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. Windows]
- - Version [e.g. 2.0.0]
+
+- OS: [e.g. Windows]
+- Version [e.g. 2.0.0]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. Samsung Galaxy A52s]
- - OS: [e.g. Android 10]
- - Version [e.g. 2.0.0]
+
+- Device: [e.g. Samsung Galaxy A52s]
+- OS: [e.g. Android 10]
+- Version [e.g. 2.0.0]
 
 **Additional context**
 Add any other context about the problem here.

.gitignore

@@ -91,6 +91,10 @@ ipython_config.py
 #   install all needed dependencies.
 #Pipfile.lock
 
+# UV
+uv.lock
+
+
 # PEP 582; used by e.g. github.com/David-OConnor/pyflow
 __pypackages__/
 

.pre-commit-config.yaml

@@ -1,23 +1,44 @@
-default_language_version:
-    python: python3.8
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.2.0
+    rev: v6.0.0
     hooks:
-    -   id: trailing-whitespace
-    -   id: check-yaml
-    -   id: check-added-large-files
-    -   id: double-quote-string-fixer
-
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: debug-statements
+  - repo: https://github.com/google/yapf
+    rev: v0.43.0
+    hooks:
+      - id: yapf
+        args: ['-i', '-m']
   - repo: https://github.com/pycqa/isort
-    rev: 5.13.2
+    rev: 7.0.0
     hooks:
       - id: isort
-        name: isort
-
-  - repo: https://github.com/PyCQA/docformatter
-    rev: v1.7.5
+  # - repo: https://github.com/astral-sh/ruff-pre-commit
+  #   rev: v0.14.10
+  #   hooks:
+  #     - id: ruff
+  - repo: https://github.com/DavidAnson/markdownlint-cli2
+    rev: v0.20.0
     hooks:
-      - id: docformatter
-        additional_dependencies: [tomli]
-        args: [./pyproject.toml]
+      - id: markdownlint-cli2
+        args: [--fix]
+  - repo: https://github.com/netromdk/vermin
+    rev: v1.8.0
+    hooks:
+      - id: vermin
+        args: [
+          '--lint', '--no-make-paths-absolute', '--eval-annotations', '--backport',
+          'argparse', '--backport', 'typing', '--backport', 'asyncio', '--backport',
+          'dataclasses', '--backport', 'enum', '-t=3.9-', '--violations'
+        ]
+
+exclude: |
+  (?x)^(
+      src/log21/_argparse.py|
+      examples/.*.py
+  )$

CHANGELOG.md

@@ -6,6 +6,76 @@ Help this project by [Donation](DONATE.md)
 Changes
 -------
 
+### v3.0.0
+
+This release introduces a cleaned-up internal structure, stricter naming conventions,
+and several quality-of-life improvements. While most users will not notice behavioral
+changes, **v3 contains breaking changes for code that relies on internal imports or
+specific exception names**.
+
+#### Breaking Changes
+
++ **Internal module renaming and normalization**
+  + All internal modules were renamed to lowercase and, in some cases, split or
+    reorganized.
+  + Imports such as `log21.Colors`, `log21.Logger`, `log21.ProgressBar`, etc. are no
+    longer valid.
+  + Users importing from internal modules must update their imports to the new module
+    names.
+  + Public imports from `log21` remain supported.
+
++ **Argumentify exception renames**
+  + Several exceptions were renamed to follow a consistent `*Error` naming convention:
+    + `TooFewArguments` → `TooFewArgumentsError`
+    + `RequiredArgument` → `RequiredArgumentError`
+    + `IncompatibleArguments` → `IncompatibleArgumentsError`
+  + Code that explicitly raises or catches these exceptions must be updated.
+
+#### V3 Changes
+
++ **Crash reporter behavior improvement**
+  + Prevented the default file crash reporter from creating `.crash_report` files when it
+    is not actually used.
+  + Implemented using an internal `FakeModule` helper.
+
++ **Argparse compatibility update**
+  + Bundled and used the Python 3.13 `argparse` implementation to ensure consistent
+    behavior across supported Python versions.
+
++ **Progress bar module rename**
+  + Renamed the internal progress bar module to `progress_bar` for consistency with the
+    new naming scheme.
+  + This will not break the usages of `log21.progress_bar(...)` since the call
+    functionality was added to the module using the `FakeModule` helper.
+
++ **Examples added and updated**
+  + Added new example code files.
+  + Updated existing examples to match the v3 API and conventions.
+
+#### Fixes
+
++ Resolved various linting and static-analysis issues across the codebase.
++ Addressed minor compatibility issues uncovered by running linters and pre-commit hooks.
++ Resolved errors occurring in environments with newer versions of argparse.
+
+#### Internal and Maintenance Changes
+
++ Migrated the build system configuration to `uv`.
++ Updated Python version classifiers and set the supported Python version to 3.9+.
++ Added `vermin` to the pre-commit configuration.
++ Updated `.gitignore`, license metadata, and tool configurations.
++ Silenced and resolved a large number of linter warnings.
++ General internal refactoring with no intended user-visible behavioral changes.
+
+#### Notes
+
++ There are **no intentional behavioral changes** in logging output, argument parsing
+  logic, or UI components.
++ Most projects will require **minimal or no changes** unless they depend on internal
+  modules or renamed exceptions.
++ See [MIGRATION-V2-V3.md](https://github.com/MPCodeWriter21/log21/blob/master/MIGRATION-V2-V3.md)
+for detailed upgrade instructions.
+
 ### 2.10.2
 
 + Update README.md and CHANGELOG.md.
@@ -93,7 +163,7 @@ Change in README.md.
 
 ### 2.6.1
 
-+ Added `encoding` to `log21.CrashReporter.FileReporter`.
++ Added `encoding` to `log21.crash_reporter.FileReporter`.
 + Added configs for `pylint`, `yapf` and `isort` to `pyproject.toml`.
 + Added optional `dev` dependencies to `pyproject.toml`.
 + Improved overall code quality.
@@ -120,10 +190,12 @@ print(GREEN + 'This' + WHITE + ' is' + RED + ' Red')
 ### 2.5.3
 
 Moved some dictionaries to `__init__` methods.
-`colors` in `Argparse.ColorizingHelpFormatter` class.
-`_level_name` in `Formatters._Formatter` class and `level_colors` in `Formatters.ColorizingFormatter` class.
-`sign_colors` in `PPrint.PrettyPrinter` class.
-`colors` in `TreePrint.TreePrint.Node` class.
+
++ `colors` in `Argparse.ColorizingHelpFormatter` class.
++ `_level_name` in `Formatters._Formatter` class and `level_colors` in
+  `Formatters.ColorizingFormatter` class.
++ `sign_colors` in `PPrint.PrettyPrinter` class.
++ `colors` in `TreePrint.TreePrint.Node` class.
 
 ### 2.5.2
 
@@ -135,17 +207,17 @@ Switched from `setup.py` build system to `pyproject.toml`
 
 ### 2.5.0
 
-Added `level_colors` argument to `log21.get_logger` function with will be passed to the formatter and allows
-user to set custom level colors while making a new logger.
-Also changed most `Dict` type hints to be `Mapping` and `list` to `Sequence` to make the functions more general
-and less strict.
+Added `level_colors` argument to `log21.get_logger` function with will be passed to the
+formatter and allows user to set custom level colors while making a new logger.
+Also changed most `Dict` type hints to be `Mapping` and `list` to `Sequence` to make the
+functions more general and less strict.
 
 ### 2.4.7
 
-Added `extra_values` argument to `CrashReporter.Formatter` which will let you pass extra static or dynamic values to the
-report formatter.
-They can be used in the format string. For dynamic values you can pass a function that takes no
-arguments as the value.
+Added `extra_values` argument to `crash_reporter.Formatter` which will let you pass extra
+static or dynamic values to the report formatter.
+They can be used in the format string. For dynamic values you can pass a function that
+takes no arguments as the value.
 
 ### 2.4.6
 
@@ -155,10 +227,10 @@ Shortened the usage syntax for the CrashReporters:
 import log21
 
 # Define a ConsoleReporter object
-console_reporter = log21.CrashReporter.ConsoleReporter()
+console_reporter = log21.crash_reporter.ConsoleReporter()
 
 
-# This works with other `log21.CrashReporter.Reporter` subclasses as well.
+# This works with other `log21.crash_reporter.reporter` subclasses as well.
 
 # Old syntax (still supported)
 @console_reporter.reporter
@@ -214,7 +286,8 @@ Added `catch` and `ignore` methods to `log21.CrashReporter.Reporter`.
 
 ### 2.3.7
 
-Added `exceptions_to_catch` and `exceptions_to_ignore` arguments to `log21.CrashReporter.Reporter` class.
+Added `exceptions_to_catch` and `exceptions_to_ignore` arguments to
+`log21.CrashReporter.Reporter` class.
 
 ### 2.3.6
 
@@ -226,35 +299,39 @@ Minor improvements.
 
 ### 2.3.4
 
-Added a new method to `log21.Logger` class: `log21.Logger.clear_line`. This method clears the current line in the
-console and moves the cursor to the beginning of the line.
+Added a new method to `log21.Logger` class: `log21.Logger.clear_line`. This method
+clears the current line in the console and moves the cursor to the beginning of the line.
 
 ### 2.3.3
 
-Fixed a bug that would cause an error creating a progress bar with no value set for width in systems without support for
-os.get_terminal_size().
+Fixed a bug that would cause an error creating a progress bar with no value set for
+width in systems without support for os.get_terminal_size().
 
 ### 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:
+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})
+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%
+# 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
-you create it. Added `handlers` argument to `Logger`. You can use it to add handlers to the logger when you create it.
+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.
 
 ### 2.3.0
 
@@ -267,13 +344,15 @@ Let's see an example:
 ```python
 # We import the ProgressBar class from log21
 from log21 import ProgressBar
-# psutil is a module that can be used to get the current memory usage or cpu usage of your system
+# psutil is a module that can be used to get the current memory usage or cpu usage of
+# your system
 # If you want to try this example, you need to install psutil: pip install psutil
 import psutil
 # We use the time module to make a delay between the progressbar updates
 import time
 
-cpu_bar = ProgressBar(format_='CPU Usage: {prefix}{bar}{suffix} {percentage}%', style='{', new_line_when_complete=False)
+cpu_bar = ProgressBar(format_='CPU Usage: {prefix}{bar}{suffix} {percentage}%',
+                      style='{', new_line_when_complete=False)
 
 while True:
     cpu_bar.update(psutil.cpu_percent(), 100)
@@ -284,9 +363,9 @@ while True:
 
 Added CrashReporter!
 
-You can use Reporter classes to monitor your program and send crash reports to the developer. It can help you fix the
-bugs and improve your program before your users get upset about it. See some examples in
-the [log21/CrashReporter/Reporters.py](https://github.com/MPCodeWriter21/log21/blob/master/log21/CrashReporter/Reporters.py)
+You can use Reporter classes to monitor your program and send crash reports to the
+developer. It can help you fix the bugs and improve your program before your users get
+upset about it. See some examples in the [log21/crash\_reporter/reporters.py](https://github.com/MPCodeWriter21/log21/blob/master/log21/CrashReporter/Reporters.py)
 file.
 
 ### 2.1.8
@@ -325,7 +404,8 @@ Added LoggingWindow!
 
 Added `ProgressBar` class!
 
-You can directly print a progress bar to the console using `print_progress` method of `log21.Logger` class.
+You can directly print a progress bar to the console using `print_progress` method of
+`log21.Logger` class.
 
 OR
 
@@ -341,7 +421,8 @@ Minor changes.
 
 ### 1.5.8
 
-Added `log21.log`, `log21.debug`, `log21.info`, `log21.warning`, `log21.error` and some other functions.
+Added `log21.log`, `log21.debug`, `log21.info`, `log21.warning`, `log21.error` and some
+other functions.
 
 ### 1.5.7
 
@@ -354,7 +435,8 @@ Added `log21.pprint()` function. It is similar to `pprint.pprint()` function.
 ### 1.5.5
 
 Added `level_names` argument to Formatter classes.
-`level_names` can be used to change the name of logging level that appears while logging messages.
+`level_names` can be used to change the name of logging level that appears while logging
+messages.
 
 ### 1.5.3-4
 
@@ -374,11 +456,13 @@ More description added.
 
 ### 1.4.12
 
-Setting custom formatting style and custom date-time formatting added to `log21.get_logger` function.
+Setting custom formatting style and custom date-time formatting added to
+`log21.get_logger` function.
 
 ### 1.4.11
 
-`Logger.write` edited. It's same as `Logger.warning` but its default `end` argument value is an empty string.
+`Logger.write` edited. It's same as `Logger.warning` but its default `end` argument
+value is an empty string.
 
 ### 1.4.10
 
@@ -388,7 +472,7 @@ Setting custom formatting style and custom date-time formatting added to `log21.
 
 Bug fixed:
 
-```
+```python
 >>> log21.get_logger()
 Traceback (most recent call last):
   File "<stdin>", line 1, in <module>
@@ -405,7 +489,8 @@ TypeError: A logger name must be a string
 
 `Logger.print` added.
 
-You can use `Logger.print` to print a message using the current level of the logger class.
+You can use `Logger.print` to print a message using the current level of the logger
+class.
 
 *It gets printed with any level.*