Now that all client methods that take aDatasetReference or
TableReference also take a string, theclient.dataset() method is
unnecessary and confusing.

Closes#8989.

googlebot added the cla: yesThis human has signed the Contributor License Agreement. label

Apr 19, 2019

Copy link

ContributorAuthor

tswast commentedApr 19, 2019

@crwilcox I was inspired by our conversation today.

Note: I've created this as a draft pull request because after I made this commit, I realized we still call.dataset() 96 times in our samples atdocs/snippets.py, and that's after@lbristol88 already moved a bunch over to the new "just use a string instead of a reference" way of doing things! I would feel better about adding the deprecation notice after we update the rest of our samples.

yoshi-automation added the 🚨This issue needs some love. label

Apr 26, 2019

Copy link

Contributor

busunkim96 commentedJun 10, 2019

@tswast Gentle ping to see if there are any updates on this PR.

Copy link

ContributorAuthor

tswast commentedJun 10, 2019

@busunkim96 I've worked with@sduskis to allocate some contractor resources for the necessary code sample updates before we unleash this PR.

Is it an issue if we keep this open for now?

Copy link

Contributor

busunkim96 commentedJun 10, 2019

@tswast Nope, I just wanted to check. 😸 Thanks!

yoshi-automation removed the 🚨This issue needs some love. label

Jul 3, 2019

tswast mentioned this pull request

Aug 7, 2019

BigQuery: deprecateclient.dataset()#8989

Closed

tswast closed this

Dec 27, 2019

tswast deleted the bq-dot-dataset-deprecation branch

December 27, 2019 21:21

tswast restored the bq-dot-dataset-deprecation branch

December 29, 2019 00:04

tswast reopened this

Dec 29, 2019

tswast force-pushed thebq-dot-dataset-deprecation branch from074af14 to5a1bab8Compare

January 23, 2020 20:18

deprecate(bigquery): deprecateclient.dataset() in favor of Dataset…

cec97ff

…ReferenceNow that all client methods that take a `DatasetReference` or`TableReference` also take a string, the `client.dataset()` method isunnecessary and confusing.

tswast force-pushed thebq-dot-dataset-deprecation branch from5a1bab8 tocec97ffCompare

January 23, 2020 20:19

tswast changed the title~~Documentclient.dataset() deprecation.~~deprecate(bigquery): deprecateclient.dataset() in favor ofDatasetReference

Jan 23, 2020

tswast marked this pull request as ready for review

January 23, 2020 20:20

tswast requested review froma team,plamut andshollyman

January 23, 2020 20:20

fix: remove unnecessary textwrap

818a81f

plamut reviewed

Jan 24, 2020

View reviewed changes

Copy link

Contributor

plamut left a comment

Choose a reason for hiding this comment

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

There are still a lot ofclient.dataset() calls insnippets.py, but that file is deprecated, IIRC.

The rest looks good, aside from a remark on a possible grammar thingy.

bigquery/google/cloud/bigquery/client.py Outdated

Comment on lines 360 to 363

		This method is deprecated. Construct a
		:class:`~google.cloud.bigquery.dataset.DatasetReference` using its
		constructor or use a string where previously a reference object was
		used.

Copy link

Contributor

plamutJan 24, 2020

Choose a reason for hiding this comment

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

Would it make sense to use the standardSphinx directive for deprecations?
The text itself is already clear, though.

Copy link

ContributorAuthor

tswastJan 24, 2020

Choose a reason for hiding this comment

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

Doesn't appear to change formatting all that much:

Pushed the change in case it makes things a little more machine-readable or something, though.

bigquery/google/cloud/bigquery/client.py OutdatedShow resolvedHide resolved

Copy link

Contributor

plamut commentedJan 24, 2020•
edited
Loading

Thetest_client_load_partitioned_table snippet test failure could be unrelated, happens onanother PR, too.

Might still be worth investigating, though.

Edit: Also happens onmaster, thus indeed unrelated to this PR.

Update:#10195 fixes it.

Update bigquery/google/cloud/bigquery/client.py

50ac8fe

Co-Authored-By: Peter Lamut <plamut@users.noreply.github.com>

Copy link

ContributorAuthor

tswast commentedJan 24, 2020

There are still a lot ofclient.dataset() calls in snippets.py, but that file is deprecated, IIRC.

That's right. We're moving those samples to thesamples/ directory and updating them to avoid the use ofclient.dataset(). I'm hoping that with#10175 and#10176 we'll have enough snippets updated.