[feat] Add new decorator handle_units for unit processing on input and output for a function that does not support unit operations
#72
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
Routhleck
changed the title
handle_units for unit processing on input and output for a function that does not support unit operationshandle_units for unit processing on input and output for a function that does not support unit operations
chaoming0625
reviewed
Dec 3, 2024
|
New pr: #73 |
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.
This pull request introduces a new decorator
handle_unitsto thebrainunitmodule and includes corresponding tests for this new functionality. The most important changes include adding the decorator function, updating the list of functions, and creating comprehensive tests.New functionality:
brainunit/_base.py: Added thehandle_unitsdecorator function to transform units of arguments passed to a function. This decorator ensures that arguments and return values conform to specified units, raising appropriate errors when mismatches occur.Updates to existing components:
brainunit/_base.py: Includedhandle_unitsin the list of functions for checking units and dimensions.Tests:
brainunit/_base_test.py: Added multiple tests for thehandle_unitsdecorator, including cases for correct units, incorrect units, boolean checks, and multiple return values. These tests ensure the decorator works as expected and handles various scenarios.