refactor(db): add transaction argument #245

cesarcoatl · 2025-06-10T06:41:29Z

to:

check
get_data
o_get_data

Summary by Sourcery

Introduce transaction support across database utility functions, streamline output parameter handling, and update project metadata and CHANGELOG formatting.

Enhancements:

Add optional transaction parameter to check, get_data, o_get_data, and get_output_params functions for stored procedure execution.
Refactor check to call _execute_sp directly with an embedded flag OutParam and streamline output handling.
Reorganize and consolidate get_output_params logic to accept transactions and simplify output retrieval.

Documentation:

Update project URLs in about.py and module docstring to new GitHub organization.

Chores:

Standardize CHANGELOG headings by removing leading ‘v’ prefixes.

to: - check - get_data - o_get_data

sourcery-ai · 2025-06-10T06:41:34Z

Reviewer's Guide

This PR refactors key database helper functions in db.py to support optional transactions, simplifies the stored‐procedure flag check and output-parameter retrieval logic, and updates project URLs and changelog version formatting.

Sequence diagram for refactored `check` function interaction with transaction support

sequenceDiagram
    actor Caller
    Caller->>db_module: check(sp, db, transaction, params)
    activate db_module
    db_module->>_execute_sp: _execute_sp(sp, db, transaction, params, out_params=["flag"], get_out_params=True)
    activate _execute_sp
    _execute_sp-->>db_module: {"output_params": {"flag": value}}
    deactivate _execute_sp
    db_module-->>Caller: flag_value
    deactivate db_module

Sequence diagram for `get_data` function showing new transaction support pattern

sequenceDiagram
    actor Caller
    Caller->>db_module: get_data(sp, db, transaction, params)
    activate db_module
    db_module->>_execute_sp: _execute_sp(sp, db, transaction, params, get_result_set=True)
    activate _execute_sp
    _execute_sp-->>db_module: {"result_set": dataset}
    deactivate _execute_sp
    db_module-->>Caller: dataset
    deactivate db_module

Class diagram for updated function signatures in the `db` module

classDiagram
  class db_module {
    +check(stored_procedure: AnyStr, database: AnyStr, transaction: Optional~AnyStr~, params: Optional~List~InParam~~) : Optional~bool~
    +get_data(stored_procedure: AnyStr, database: AnyStr, transaction: Optional~AnyStr~, params: Optional~List~InParam~~) : BasicDataset
    +o_get_data(stored_procedure: AnyStr, out_params: List~OutParam~, database: AnyStr, transaction: Optional~AnyStr~, in_params: Optional~List~InParam~~) : Tuple~BasicDataset, DictIntStringAny~
    +get_output_params(stored_procedure: AnyStr, output: List~OutParam~, database: AnyStr, transaction: Optional~AnyStr~, params: Optional~List~InParam~~) : DictIntStringAny
  }

File-Level Changes

Change	Details	Files
Add optional transaction support to stored procedure wrapper functions	Extended function signatures to include transaction parameter Propagated transaction argument into _execute_sp calls	`src/incendium/db.py`
Refactor check and get_output_params implementations	Removed old get_output_params invocation inside check Inlined _execute_sp call in check with fixed OutParam Reintroduced get_output_params as standalone function	`src/incendium/db.py`
Update project metadata and changelog formatting	Standardized version headings in CHANGELOG.md by removing leading 'v' Updated repository URLs in about.py and init.py	`CHANGELOG.md` `src/incendium/__about__.py` `src/incendium/__init__.py`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @cesarcoatl - I've reviewed your changes - here's some feedback:

Replace usage of iterkeys() in check() with standard dict membership (e.g., if 'flag' in result['output_params']) for Python 3 compatibility.
Consider having check() call get_output_params() internally instead of duplicating the _execute_sp invocation to reduce code duplication and keep output-param handling consistent.

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

sourcery-ai · 2025-06-10T06:43:56Z

src/incendium/db.py

-        stored_procedure, output=[output], database=database, params=params
+    return (
+        result["output_params"]["flag"]
+        if "flag" in result["output_params"].iterkeys()


issue: Avoid using iterkeys(), use direct membership or keys()

In Python 3, use '"flag" in result["output_params"]' or 'result["output_params"].keys()' for compatibility and clarity.

refactor(db): add transaction argument

3a7e85f

to: - check - get_data - o_get_data

sourcery-ai bot reviewed Jun 10, 2025

View reviewed changes

cesarcoatl merged commit 950af43 into main Jun 10, 2025
4 checks passed

cesarcoatl deleted the refactor/db/transaction branch June 10, 2025 06:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

refactor(db): add transaction argument #245

refactor(db): add transaction argument #245

Uh oh!

cesarcoatl commented Jun 10, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Jun 10, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

sourcery-ai bot Jun 10, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

refactor(db): add transaction argument #245

refactor(db): add transaction argument #245

Uh oh!

Conversation

cesarcoatl commented Jun 10, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Sequence diagram for refactored check function interaction with transaction support

Sequence diagram for get_data function showing new transaction support pattern

Class diagram for updated function signatures in the db module

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

cesarcoatl commented Jun 10, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Jun 10, 2025 •

edited

Loading

Sequence diagram for refactored `check` function interaction with transaction support

Sequence diagram for `get_data` function showing new transaction support pattern

Class diagram for updated function signatures in the `db` module