feat: Improve tests for Timer module #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The existing tests for the Timer module were not robust and lacked assertions. This change rewrites the tests using pytest to properly verify the timer's functionality. The new tests cover: - The Timer class as a context manager and a standalone object. - The @Timer decorator with and without arguments. - Correct formatting of elapsed time in milliseconds, seconds, minutes, and hours. - Custom logger usage. While writing the tests, a bug was found in the hours formatting where the minutes were incorrectly calculated. This has been fixed.
Add dedicated tests for the `init_logger` static method in the Timer module. These tests cover cases where a logger is provided and where one is not. A bug was discovered in `init_logger` where it would not add a handler if a parent logger (like the root logger) had a handler. This was due to using `logger.hasHandlers()` which checks the hierarchy. This is fixed by checking `logger.handlers` instead, which only checks the specific logger instance.
Adds docstrings to the following methods in `timer_module.py`: - `__init__` - `__enter__` - `__exit__` - `_start` - `stop` - `init_logger` - `get_default_timestamp` This improves the documentation and maintainability of the code.
Bumps the version of the module from 0.4.5 to 0.5.0 to reflect the recent bug fixes, test improvements, and documentation additions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The existing tests for the Timer module were not robust and lacked assertions. This change rewrites the tests using pytest to properly verify the timer's functionality.
The new tests cover:
While writing the tests, a bug was found in the hours formatting where the minutes were incorrectly calculated. This has been fixed.