[feat] Add convert_in_si Function
#96
Open
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
Reviewer's Guide by SourceryThis pull request introduces the Sequence diagram for convert_in_si() functionsequenceDiagram
participant User
participant convert_in_si
participant Frame
participant TreeMap
participant Quantity
User->>convert_in_si: call convert_in_si()
activate convert_in_si
convert_in_si->>Frame: get caller frame
Frame-->>convert_in_si: return caller globals
loop For each global variable
convert_in_si->>TreeMap: map _convert_in_si
activate TreeMap
TreeMap->>Quantity: factorless()
Quantity-->>TreeMap: SI unit quantity
TreeMap-->>convert_in_si: converted value
end
convert_in_si->>Frame: update globals
convert_in_si-->>User: return
Class diagram showing Quantity class with factorless methodclassDiagram
class Quantity {
+mantissa
+unit
+factorless()
+__mul__(other)
+__add__(other)
+__sub__(other)
+to_decimal()
}
class Unit {
+factor
+dimension
+name
+factorless()
}
Quantity --> Unit: has
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Routhleck
changed the title
convert_in_si Function
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @Routhleck - I've reviewed your changes - here's some feedback:
Overall Comments:
- The
convert_in_si()function modifies global state by changing variables in the caller's scope. Consider adding a warning in the docstring about potential side effects and thread-safety concerns when using this function.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟡 Complexity: 1 issue found
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| return x | ||
|
|
||
|
|
||
| def convert_in_si(): |
There was a problem hiding this comment.
issue (complexity): Consider using a context manager to explicitly define the scope of SI unit conversion and automatically restore original units afterwards.
The frame inspection and global variable manipulation in convert_in_si() makes program flow difficult to reason about. Consider using a context manager pattern instead, which provides clearer scope boundaries while maintaining the same functionality:
@contextmanager
def si_units():
"""Context manager for converting quantities to SI units"""
# Store original values
frame = inspect.currentframe().f_back
original = {k: v for k, v in frame.f_locals.items()
if isinstance(v, (Quantity, Unit))}
try:
# Convert to SI
for k, v in original.items():
frame.f_locals[k] = v.factorless()
yield
finally:
# Restore original values
for k, v in original.items():
frame.f_locals[k] = v
# Usage:
with si_units():
# All quantities in this block use SI units
result = time1 * length1 This approach:
- Makes the scope of SI unit conversion explicit
- Automatically restores original units after the block
- Eliminates global state modification
- Provides clearer error boundaries
The context manager pattern is more idiomatic Python and makes the code's behavior more predictable.
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
convert_in_si()function has been added to convert allQuantityvariables in the current scope (including those nested in lists, tuples, or dictionaries) to their SI unit equivalents. This function achieves this by calling thefactorless()method on eachQuantityinstance, which convert the unit and returns the quantities in SI units.Usage Examples
Below are some examples demonstrating the use of convert_in_si():
Summary by Sourcery
New Features:
convert_in_si()that converts allQuantityvariables in the current scope to their SI unit equivalents.