feat!: migrate to v2.0.0 by larkee · Pull Request #147 · googleapis/python-spanner · GitHub

This PR is a preview of the 2.0 release.

TODO list:

Fix docs.
Describe changes in UPGRADING guide.

BREAKING CHANGES

list_instances, list_databases, list_instance_configs, and list_backups will now return protos rather than the handwritten wrapper

Thank you for working on this!

I noticed there doesn't seem to be a samples presubmit. I opened 335755839 to add those kokoro configs internally.

Handwritten files have been moved from google/cloud/spanner_v1 to google/cloud/spanner

I believe the other handwritten/generated mixes keep the generated surface in the versioned directory. What is the
motivation for the change?
https://github.com/googleapis/python-firestore/tree/master/google/cloud/firestore_v1
https://github.com/googleapis/python-pubsub/tree/v2.1.0/google/cloud/pubsub_v1
I'm not familiar with the Spanner client, are there particular files we should direct our attention to?

I noticed there doesn't seem to be a samples presubmit. I opened 335755839 to add those kokoro configs internally.

Thanks! I wasn't sure what was missing.

Handwritten files have been moved from google/cloud/spanner_v1 to google/cloud/spanner

I believe the other handwritten/generated mixes keep the generated surface in the versioned directory. What is the
motivation for the change?
https://github.com/googleapis/python-firestore/tree/master/google/cloud/firestore_v1
https://github.com/googleapis/python-pubsub/tree/v2.1.0/google/cloud/pubsub_v1

The motivation was two fold. It separates the handwritten surfaces which makes it clearer to contributes what is written and what is generated. It also prevents having to customize the generated google/cloud/spanner_v1/__init__.py. However given that this file shouldn't change too much, it's probably reasonable to exclude it from generation and manually update it when required.

I'm happy to revert these files back to their original folder if you think that would be best.

I'm not familiar with the Spanner client, are there particular files we should direct our attention to?

Most of the handwritten surfaces are used directly by users. The major ones are:

client.py
instance.py
database.py
backup.py
`batch.py
snapshot.py
transaction.py

However, the files that changed the most during migration are:

_helpers.py
snapshot.py
streamed.py
transaction.py

I would prefer the handwritten code live in the versioned directory for consistency with the other libraries. It looks like firestore excludes __init__.py in synth.py https://github.com/googleapis/python-firestore/blob/c3acd4a04745c93edb2f61bf9be6fa33f439f4b0/synth.py#L41

Fully generated libraries use the unversioned path google/cloud/{api}/ for the default alias (equivalent of google/cloud/spanner.py) https://github.com/googleapis/python-speech/blob/master/google/cloud/speech/__init__.py so there's also a small chance for confusion there.

I only reviewed UPGRADING.md so my LGTM is for that file.

Co-authored-by: skuruppu <skuruppu@google.com>

🤖 I have created a release \*beep\* \*boop\* --- ## [2.0.0](https://www.github.com/googleapis/python-spanner/compare/v1.19.1...v2.0.0) (2020-11-11) ### ⚠ BREAKING CHANGES * migrate to v2.0.0 (#147) ### Features * DB-API driver + unit tests ([#160](https://www.github.com/googleapis/python-spanner/issues/160)) ([2493fa1](https://www.github.com/googleapis/python-spanner/commit/2493fa1725d2d613f6c064637a4e215ee66255e3)) * migrate to v2.0.0 ([#147](https://www.github.com/googleapis/python-spanner/issues/147)) ([bf4b278](https://www.github.com/googleapis/python-spanner/commit/bf4b27827494e3dc33b1e4333dfe147a36a486b3)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please).

@larkee: In the end, the "breaking change" that shows up in the changelog was
migrate to v2.0.0 (#147) vs

list_instances, list_databases, list_instance_configs, and list_backups will now return protos rather than the handwritten wrapper

which would have been much more useful

@wyardley My apologies! I'll do my best to label changes better in future 👍 I'll update the changelog directly to show the more useful message

google-cla Bot added the cla: yes This human has signed the Contributor License Agreement. label Oct 2, 2020

larkee requested a review from busunkim96 October 6, 2020 02:31

busunkim96 requested a review from software-dov October 7, 2020 00:23

busunkim96 reviewed Oct 9, 2020

View reviewed changes

Comment thread google/cloud/spanner/snapshot.py

larkee requested a review from busunkim96 October 26, 2020 04:53

busunkim96 approved these changes Oct 30, 2020

View reviewed changes

Comment thread google/cloud/spanner.py Outdated

Comment thread google/cloud/spanner.py

Comment thread google/cloud/spanner_v1/streamed.py Outdated

larkee added 22 commits November 3, 2020 16:06

chore: remove old generated files

abb2281

chore: remove type files

b660ddb

refactor: move handwritten files to google/cloud/spanner

5114db3

chore: update synth.py

cdf9795

chore: regen library via microgenerator

ef6835b

fix: update imports to use new files

848d576

fix: update _helper.py

936efd3

update backup.py

2969885

fix: update batch.py

419ab72

fix: update param_types.py

cc32144

fix: update pool.py

9109bb0

test: update test_keyset.py

47df3d7

test: update test__opentelemetry_tracing.py

f1db0cc

fix: update client.py

2ab6b3b

test: update test_client.py

2f77e43

fix: update database.py

eea1b8f

test: update test_database.py

3a08a9a

fix: update commmit call missing kwarg

e111612

test: update test_session.py

241d71a

fix: update streamed.py

8cdbe3d

test: update TestStreamedResultSet tests in streamed.py

8335288

fix: update instance.py

979a6d8

larkee added 8 commits November 3, 2020 16:15

ci: update python version for emulator tests

2c3eed0

fix: update backup pagination example

6518f62

test: revert test_keyset for coverage

8471be9

test: fix expected ranges

50168d2

fix: ignore google/cloud/spanner_v1/__init__.py for regen

b220311

chore: regen (via synth)

0c5fa5a

docs: revert import changes

1482435

refactor: address comments

bf06add

larkee force-pushed the generator-migration branch from d1c3dab to bf06add Compare November 3, 2020 06:30

larkee added 2 commits November 5, 2020 16:49

docs: add UPDATING guide

3e14363

refactor: revert imports

82f83f2

larkee marked this pull request as ready for review November 5, 2020 07:16

larkee requested a review from a team November 5, 2020 07:16

larkee requested a review from a team as a code owner November 5, 2020 07:16

skuruppu approved these changes Nov 5, 2020

View reviewed changes

Comment thread UPGRADING.md Outdated

larkee and others added 6 commits November 6, 2020 15:42

feat: remove deprecated arguments

f7d859a

docs: update guide to mention deprecated arguments

eb44c0a

test: lower required coverage to 99%

0874d1e

test: remove deprecated options

21a2fa9

style: fix lint error

856f17a

Update UPGRADING.md

2676c39

Co-authored-by: skuruppu <skuruppu@google.com>

c24t mentioned this pull request Nov 10, 2020

DBAPI merge sanity check #162

Closed

larkee merged commit bf4b278 into googleapis:master Nov 11, 2020

release-please Bot mentioned this pull request Nov 11, 2020

chore: release 2.0.0 #163

Merged

larkee mentioned this pull request Dec 2, 2020

docs: update CHANGELOG breaking change comment #180

Merged

c24t mentioned this pull request Dec 21, 2020

System test failures cleaning up backups #198

Closed

rajatbhatta mentioned this pull request Jan 20, 2022

chore: update supported python versions in README to >= 3.6 #668

Merged

feat!: migrate to v2.0.0 by larkee · Pull Request #147 · googleapis/python-spanner · GitHub

feat!: migrate to v2.0.0 - #147

feat!: migrate to v2.0.0#147
larkee merged 99 commits into
googleapis:masterfrom
larkee:generator-migration

larkee commented Oct 2, 2020 •
edited
Loading

Uh oh!

Uh oh!

busunkim96 commented Oct 7, 2020

Uh oh!

larkee commented Oct 7, 2020

Uh oh!

busunkim96 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

skuruppu left a comment

Uh oh!

Uh oh!

wyardley commented Dec 1, 2020

Uh oh!

larkee commented Dec 2, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat!: migrate to v2.0.0 by larkee · Pull Request #147 · googleapis/python-spanner · GitHub

feat!: migrate to v2.0.0 - #147

feat!: migrate to v2.0.0#147larkee merged 99 commits intogoogleapis:mastergoogleapis/python-spanner:masterfrom larkee:generator-migrationlarkee/python-spanner:generator-migrationCopy head branch name to clipboard

Conversation

larkee commented Oct 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

busunkim96 commented Oct 7, 2020

Uh oh!

larkee commented Oct 7, 2020

Uh oh!

busunkim96 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

skuruppu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wyardley commented Dec 1, 2020

Uh oh!

larkee commented Dec 2, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat!: migrate to v2.0.0#147
larkee merged 99 commits into
googleapis:masterfrom
larkee:generator-migration

larkee commented Oct 2, 2020 •
edited
Loading