feat(db): add TransactionManager context manager #273
Merged
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
Co-authored-by: lokomoti <40903296+lokomoti@users.noreply.github.com>
Contributor
Reviewer's GuideThis PR introduces a TransactionManager context manager in the core DB module for automatic transaction lifecycle handling, refactors type stubs to centralize parameter behavior in a base class and mirror new functionality, and adds a style test environment in stubs/tox.ini for automated stub formatting checks. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- Wrap commitTransaction and rollbackTransaction calls in a try/finally to ensure closeTransaction is always invoked even if commit or rollback raises.
- Consider using None rather than an empty string as the default for the database parameter to better represent “no override” and align with the Optional[str] type hint.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Wrap commitTransaction and rollbackTransaction calls in a try/finally to ensure closeTransaction is always invoked even if commit or rollback raises.
- Consider using None rather than an empty string as the default for the database parameter to better represent “no override” and align with the Optional[str] type hint.
## Individual Comments
### Comment 1
<location> `incendium/src/incendium/db.py:206` </location>
<code_context>
super(OutParam, self).__init__(name_or_index, type_code)
+class TransactionManager(object):
+ """Database transaction context manager."""
+
</code_context>
<issue_to_address>
Consider handling exceptions during transaction commit/rollback more robustly.
Ensure system.db.closeTransaction is always called, even if commit or rollback raise exceptions, to prevent resource leaks.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| super(OutParam, self).__init__(name_or_index, type_code) | ||
|
|
||
|
|
||
| class TransactionManager(object): |
Contributor
There was a problem hiding this comment.
suggestion (bug_risk): Consider handling exceptions during transaction commit/rollback more robustly.
Ensure system.db.closeTransaction is always called, even if commit or rollback raise exceptions, to prevent resource leaks.
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.
Summary by Sourcery
Introduce a TransactionManager context manager to simplify transaction handling, update the stub files to reflect the new context manager and refactor parameter stubs to use a common base class, and add a style enforcement environment for stubs in tox.ini.
New Features:
Enhancements:
CI: