Pytooling

**Release created on: 17.11.2024 - 17:04:51**

Changes

* Bumped dependencies.
* Python 3.9+: `getResourceFile(...)` and `readResourceFile(...)` is now unconditional in the package.

Bug Fixes

* Open files using UTF-8 encoding:
* Packaging: Open README files
* Packaging: Open requirement files
* GraphML: Write GraphML files
* YAML: Read YAML configuration files.
* JSON: Read JSON configuration files.

Documentation

* Installation: Fixed duplicate sentence.

Unit Tests

* Open files using UTF-8 encoding

GitHub Actions

* Fixed copy&paste mistake in pipeline.

**Release created on: 12.11.2024 - 06:39:54**

Bug Fixes

* `pyTooling.Versioning`:
* Fixed usage of variable `max`, which was unassigned and fallback to the builtin function `max`.

Documentation

* Added semantic version number examples.

**Release created on: 10.11.2024 - 12:55:20**

Changes

* Bumped dependencies.

Bug Fixes

* Fixed platform name for MSYS2/MinGW32 using new Python 3.12.

**Release created on: 09.11.2024 - 23:13:26**

New Features

* Reworked semantic and calendar version classes:
* Moved common implementations to `Version` base-type.
* Moved major, minor, micro, build, post, dev, release level, release number, hash, prefix, postfix parts to the base-type.
* Moved implementations of comparison operators to the base-type: `__eq__`, `__ne__`, `__lt__`, `__le__`, `__gt__`, `__ge__`.
* Implemented minimum comparison operator using `__rshift__` (`>>`) for PIP's `~=` operator.
* Implemented a formatting helper method `_format`.
* Reworked `SemanticVersion`.
* Additionally allow comparisons with string and integer types.
* Enhanced `SemanticVersion.Parse()` class-method:
* Raise exceptions on invalid inputs.
* Use a regular expression to check and split the input.
* Implemented `CalendarVersion` (previously a dummy).
* Added `CalendarVersion.Parse()` class-method: raise exceptions on invalid inputs.
* Implemented comparison operators.
* Added validator classes `WordSizeValidator` and `MaxValueValidator`.
* Added doc-strings.
* Improved `__str__()` method to return only used version parts.
* Added `__format__()` for user defined formatting specifications.

Changes

* Bumped dependencies.
* Renamed `SemanticVersion.Patch` to `SemanticVersion.Micro`.
`SemanticVersion.Patch` is still available as an alias.
* Moved `pyTooling.Platform.PythonVersion` to `pyTooling.Versioning.PythonVersion`.

Bug Fixes

* Added support for Python 3.12 on MSYS2 environments (MinGW64, UCRT64, Clang64).
* Internally used type `PythonVersion` used a buggy constructor.
The problem only occurred with PyPy, but it proved a general bug in that type.
Creating an instance now needs the class-method `PythonVersion.FromSysVersionInfo()`

Documentation

* Updated versioning and stopwatch examples on the landing page.
* Added doc-strings to all version classes.
* Improved Versioning documentation page.
* Improved Stopwatch documentation page.

Unit Tests

* Added unit tests for `SemanticVersion` and `CalendarVersion`.


Related Issues
* fixes 12
* fixes 107
* fixes 169
* fixes 170
* fixes 174

**Release created on: 27.10.2024 - 17:19:57**

New Features

* Added support for Python 3.13 (and dropped 3.8).
* Changed `DEFAULT_PY_VERSIONS` in `pyTooling.Packaging` to 3.9...3.13.
* Reworked faulty `Timer` class and renamed it to `StopWatch`.
* Support start, pause, resume, split and stop operations.
* Collect active and inactive split times.
* Accept a name at instantiation.
* Take absolute time at start and stop via `datetime.now()`.
* Can be used in a `with`-statement.
* `InheritDocString` can be applied to classes too.

Changes

* Bumped dependencies.
* Moved/renamed `pyTooling.Timer.Timer` → `pyTooling.StopWatch.StopWatch`
* tbd

Bug Fixes

* `Timer` was buggy and got reworked to `Stopwatch`.

Documentation

* Updated Sphinx to 8.1 and Theme to RTD 3.0.
* Restructued decorator page.
* Added StopWatch documentation.
* Improved doc-strings.

Unit Tests

* Reworked and new `StopWatch` tests.
* Reworked and new `InheritDocString` tests

**Release created on: 29.09.2024 - 01:46:54**

New Features

* Added `TerminalApplication.WriteCritical()`.
* Added `TerminalApplication.ExitOnPreviousCriticalWarnings()`.

Changes

* Allow `ValuedFlag`s to be optional.

Bug Fixes

* Distinguish macOS for Intel (x86-64) and macOS for ARM (aarch64).

Documentation

*None*

Unit Tests

* Added platform tests for macOS aarch64 derived from macOS x86-64.

----------
Related Issues and Pull-Requests

*None*