Skip to content

Add context manager to Txn and DgraphClientStub.#185

Closed
garylavayou wants to merge 12 commits intodgraph-io:mainfrom
garylavayou:master
Closed

Add context manager to Txn and DgraphClientStub.#185
garylavayou wants to merge 12 commits intodgraph-io:mainfrom
garylavayou:master

Conversation

@garylavayou
Copy link
Copy Markdown
Contributor

@garylavayou garylavayou commented Nov 29, 2022

Using Transaction with Context Manager

The Python context manager will automatically perform the "commit" action after all queries and mutations have been done and perform "discard" action to clean the transaction. When something goes wrong in the scope of context manager, "commit" will not be called, and the "discard" action will be called to drop any potential changes.

with client.begin(read_only=False, best_effort=False) as txn:
  # Do some queries or mutations here

or you can directly create a transaction from the Txn class.

with pydgraph.Txn(client, read_only=False, best_effort=False) as txn:
  # Do some queries or mutations here

client.begin() can only be used with "with-as" blocks, while pydgraph.Txn class can be directly called to instantiate a transaction object.

Use context manager to automatically clean resources

Use function call:

with pydgraph.client_stub(SERVER_ADDR) as stub:
    client = pydgraph.DgraphClient(stub)

Use class constructor:

with pydgraph.DgraphClientStub(SERVER_ADDR) as stub:
    client = pydgraph.DgraphClient(stub)

Note: client should be used inside the "with-as" block. The resources related to client will be automatically released outside the block and client is not usable anymore.

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Nov 29, 2022 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@mangalaman93
Copy link
Copy Markdown
Contributor

mangalaman93 commented May 15, 2023

@garylavayou Thank you for the PR. will you be able to rebase the change on the latest master?

@garylavayou
Copy link
Copy Markdown
Contributor Author

garylavayou commented May 16, 2023

@garylavayou Thank you for the PR. will you be able to rebase the change on the latest master?

I have synced the forked repo with the latest master. Is that enough?

@mangalaman93
Copy link
Copy Markdown
Contributor

mangalaman93 commented May 17, 2023

Could you also sign the CLA please before we review the code?

I have two comments/questions here:

  1. Will this API be useful to the users of pydgraph? I think so and I am getting more opinions here from my colleagues.
  2. We should add more tests trying to stress this code? Do you think you would be able to do that? I can also brainstorm with you or by myself and come up with a set of tests if you like.

@garylavayou
Copy link
Copy Markdown
Contributor Author

garylavayou commented May 18, 2023

@mangalaman93 It would be better if you can add tests to the code, since I currently have no stable test environment. I am also looking forward that you can make the context manager more robust and extend the function with your opinions.

@mangalaman93
Copy link
Copy Markdown
Contributor

mangalaman93 commented May 18, 2023

@garylavayou Thanks for responding back. I am busy with a few other things, I highly doubt if I could spend time writing tests right now. But I will keep this in mind. If you do get more time and opportunity to make changes, please go ahead and keep me posted. Appreciate your time and responding back.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jul 11, 2024

This PR has been stale for 60 days and will be closed automatically in 7 days. Comment to keep it open.

@github-actions github-actions Bot added the Stale label Jul 11, 2024
@garylavayou
Copy link
Copy Markdown
Contributor Author

garylavayou commented Jul 11, 2024

This PR has been stale for 60 days and will be closed automatically in 7 days. Comment to keep it open.

keep it open please!

@github-actions github-actions Bot removed the Stale label Nov 12, 2024
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jan 11, 2025

This PR has been stale for 60 days and will be closed automatically in 7 days. Comment to keep it open.

@github-actions github-actions Bot added the Stale label Jan 11, 2025
@github-actions github-actions Bot closed this Jan 19, 2025
@ryanfoxtyler ryanfoxtyler reopened this Jan 19, 2025
@ryanfoxtyler ryanfoxtyler requested a review from a team January 19, 2025 02:11
@github-actions github-actions Bot removed the Stale label Jan 20, 2025
@ryanfoxtyler ryanfoxtyler marked this pull request as draft January 22, 2025 03:32
@ryanfoxtyler ryanfoxtyler marked this pull request as ready for review January 22, 2025 03:32
@ryanfoxtyler ryanfoxtyler requested a review from a team January 22, 2025 03:32
@ryanfoxtyler ryanfoxtyler removed the request for review from joshua-goldstein February 15, 2025 00:15
@shaunpatterson
Copy link
Copy Markdown
Contributor

shaunpatterson commented Dec 8, 2025

bueller?

shaunpatterson added a commit to shaunpatterson/pydgraph that referenced this pull request Dec 8, 2025
@shaunpatterson @claude
Add comprehensive tests for context manager functionality
cb32f56 
This commit adds extensive test coverage for the context manager
implementation in PR dgraph-io#185, which adds Python context manager support
to the Txn and DgraphClientStub classes.

Tests for Txn context manager:
- Auto-commit for write transactions on successful completion
- Auto-discard for read-only transactions
- Exception handling with automatic discard
- Transaction state validation after context manager exit
- Multiple mutations within a single context manager
- Query and mutate operations combined
- Invalid operation exception handling
- Read-only transaction mutation prevention
- No-mutation transaction handling

Tests for DgraphClientStub context manager:
- Basic context manager usage
- Exception handling
- Proper resource cleanup (stub close) after exit
- Exception-safe resource cleanup
- Multiple operations within context manager
- Integration with DgraphClient and transactions
- Full workflow with nested context managers

These tests ensure robust behavior of the context manager
implementation including proper resource cleanup, exception
handling, and transaction lifecycle management.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This was referenced Dec 8, 2025
Closed
Closed
shaunpatterson added a commit to shaunpatterson/pydgraph that referenced this pull request Dec 8, 2025
@shaunpatterson @claude
Add comprehensive tests for context manager functionality
2c9782b 
This commit adds extensive test coverage for the context manager
implementation in PR dgraph-io#185, which adds Python context manager support
to the Txn and DgraphClientStub classes.

Tests for Txn context manager:
- Auto-commit for write transactions on successful completion
- Auto-discard for read-only transactions
- Exception handling with automatic discard
- Transaction state validation after context manager exit
- Multiple mutations within a single context manager
- Query and mutate operations combined
- Invalid operation exception handling
- Read-only transaction mutation prevention
- No-mutation transaction handling

Tests for DgraphClientStub context manager:
- Basic context manager usage
- Exception handling
- Proper resource cleanup (stub close) after exit
- Exception-safe resource cleanup
- Multiple operations within context manager
- Integration with DgraphClient and transactions
- Full workflow with nested context managers

These tests ensure robust behavior of the context manager
implementation including proper resource cleanup, exception
handling, and transaction lifecycle management.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
shaunpatterson added a commit to shaunpatterson/pydgraph that referenced this pull request Dec 28, 2025
@shaunpatterson @claude
Add comprehensive tests for context manager functionality
b558d36 
This commit adds extensive test coverage for the context manager
implementation in PR dgraph-io#185, which adds Python context manager support
to the Txn and DgraphClientStub classes.

Tests for Txn context manager:
- Auto-commit for write transactions on successful completion
- Auto-discard for read-only transactions
- Exception handling with automatic discard
- Transaction state validation after context manager exit
- Multiple mutations within a single context manager
- Query and mutate operations combined
- Invalid operation exception handling
- Read-only transaction mutation prevention
- No-mutation transaction handling

Tests for DgraphClientStub context manager:
- Basic context manager usage
- Exception handling
- Proper resource cleanup (stub close) after exit
- Exception-safe resource cleanup
- Multiple operations within context manager
- Integration with DgraphClient and transactions
- Full workflow with nested context managers

These tests ensure robust behavior of the context manager
implementation including proper resource cleanup, exception
handling, and transaction lifecycle management.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@mlwelles
Copy link
Copy Markdown
Contributor

mlwelles commented Dec 31, 2025

Closing this PR in favor of #284, which incorporates all the changes from this PR (along with the comprehensive tests from #279) with fixes for CI failures. Thank you @garylavayou for your excellent work on the context manager implementation!

@mlwelles mlwelles closed this Dec 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mangalaman93 mangalaman93 Awaiting requested review from mangalaman93

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@garylavayou @CLAassistant @mangalaman93 @shaunpatterson @mlwelles @ryanfoxtyler