Dev: pull request changes #26
Merged
Conversation
This file contains 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
Added unit tests for utility functions in newly created `utils_test.py` and `iteration_test.py`. This was done to improve overall code reliability and ensure that the functions were behaving as expected. Also, refactored the `utils.py` and `iteration.py` code for better readability. This involved: - Updating the `POINTS` dictionary structure for improved visibility. - Extended the docstring for the `pairwise` function for comprehensive understanding of its use-case and behavior. Furthermore, renamed `itertools.py` to `iteration.py` to avoid confusion with Python's built-in `itertools` module.
Reformatted the code to improve readability and applied "black" style Python formatting. All code modifications were related to formatting—changing the location of line breaks, adding whitespace around operators, and similar tweaks. This refactoring affects no observable behavior and therefore, no changes in the application's functionality would be noted after the commit. The main goal is to make the code more aesthetically pleasing and easier to maintain in the future.
This commit introduces enhancements to the Timer class in the `src/utils/timer.py` module. The Timer class now provides improved functionality for measuring elapsed time intervals using various time units. This can be particularly useful for benchmarking or profiling code execution durations. The changes include: - The addition of the `timedelta` import from the `datetime` module to enable time unit conversions. - Improved documentation for the Timer class, outlining its purpose and attributes. - The `reset_timer` method has been updated to provide more comprehensive documentation and to set the starting time of the timer to the current time. - The introduction of the `_elapsed_time` method, which calculates elapsed time in the specified time unit. This method improves the accuracy of elapsed time calculations and facilitates conversions to different time units. - Refinements to the `elapsed_seconds` and `elapsed_millis` methods, including more detailed docstrings and improved accuracy in time calculations. In addition to these changes, this commit also includes a new unit test suite for the Timer class. The `src/utils/timer_test.py` module contains tests to verify the correct functioning of the enhanced Timer class methods. Mocking of datetime objects has been used in the unit tests to ensure accurate testing of time-related functionality. These enhancements contribute to the overall robustness and usability of the Timer class, making it a valuable tool for measuring elapsed time intervals in a more versatile and accurate manner. The unit tests further validate the correctness of the Timer class improvements.
Enhanced Timer Class and Code Refactoring
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.
No description provided.