Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add a static copy of legacy proto-based types #1000

Merged
merged 7 commits into from
Oct 6, 2021

Conversation

plamut
Copy link
Contributor

@plamut plamut commented Oct 1, 2021

Closes #999.

Adding unmaintained legacy types definitions.

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

@plamut plamut requested review from tswast and a team October 1, 2021 15:08
@plamut plamut requested a review from a team as a code owner October 1, 2021 15:08
@product-auto-label product-auto-label bot added the api: bigquery Issues related to the googleapis/python-bigquery API. label Oct 1, 2021
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Oct 1, 2021
"use types defined in google.cloud.bigquery instead."
)

warnings.warn(_LEGACY_MSG, category=DeprecationWarning)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice -- I had been thinking to add a request for import-time warnings.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@plamut plamut added the owlbot:run Add this label to trigger the Owlbot post processor. label Oct 1, 2021
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Oct 1, 2021
@plamut
Copy link
Contributor Author

plamut commented Oct 1, 2021

Oh, wait... didn't we say we want to add back the proto* dependencies, so that those imports will not result in an error? Maybe as a "legacy_types" extra?

And what about the intersphinx links? Should we perhaps expose these models in the docs with a big fat "OBSOLETE!" warning at the top?

@tswast

@plamut plamut added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Oct 1, 2021
@tswast
Copy link
Contributor

tswast commented Oct 2, 2021

Oh, wait... didn't we say we want to add back the proto* dependencies, so that those imports will not result in an error? Maybe as a "legacy_types" extra?

Yes, please. I think we've added the BQ Storage API as a required dependency now, right? That should mean we pull those in transitively anyway, but it wouldn't hurt to be explicit.

And what about the intersphinx links? Should we perhaps expose these models in the docs with a big fat "OBSOLETE!" warning at the top?

Yeah, let's make sure we generate docs for it, but with a warning & link to our migration guide.

@plamut plamut removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Oct 5, 2021
@plamut plamut requested review from tswast and removed request for tswast October 5, 2021 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: bigquery Issues related to the googleapis/python-bigquery API. cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants