Spanner: Fix run_in_transaction return value docs
#9264
Merged
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
Summary: These docs used to be correct, but `Session.run_in_transaction` was changed from returning the commit timestamp to returning the function value in googleapis#3753, and the upstream docs were not updated. The docs for `run_in_transaction` are now identical across `Database` and `Session`. The tests for `run_in_transaction` (in `test_database.py`) are wrong, as they mock out the session object instead of using a real session, and they also were not updated in googleapis#3753. This change does not fix them. Test Plan: ``` $ virtualenv -q -p python3.6 ./ve $ . ./ve/bin/activate (ve) $ pip install -q google-cloud-spanner==1.10.0 (ve) $ pip freeze | grep google-cloud-spanner google-cloud-spanner==1.10.0 (ve) $ cat test.py; echo from google.cloud import spanner_v1 client = spanner_v1.Client() instance = client.instance("my-instance-name") database = instance.database("my-database-name") result = database.run_in_transaction(lambda txn: "ahoy") print(result) (ve) $ python test.py ahoy ``` wchargin-branch: run-in-transaction-rval
wchargin
requested review from
crwilcox,
frankyn and
tseaver
as code owners
googlebot
added
the
cla: yes
plamut
added
api: spanner
plamut
changed the title
run_in_transaction return value docsrun_in_transaction return value docs
tseaver
added
the
kokoro:force-run
yoshi-kokoro
removed
the
kokoro:force-run
tseaver
approved these changes
Sep 23, 2019
|
@wchargin Thanks for the patch! |
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:
These docs used to be correct, but
Session.run_in_transactionwaschanged from returning the commit timestamp to returning the function
value in #3753, and the upstream docs were not updated.
The docs for
run_in_transactionare now identical acrossDatabaseand
Session.The tests for
run_in_transaction(intest_database.py) are wrong, asthey mock out the session object instead of using a real session, and
they also were not updated in #3753. This change does not fix them.
Test Plan:
wchargin-branch: run-in-transaction-rval