FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

feat: allow cell magic body to be a $variable by plamut · Pull Request #1053 · googleapis/python-bigquery · GitHub

This repository was archived by the owner on Mar 6, 2026. It is now read-only.
/ python-bigquery Public archive

feat: allow cell magic body to be a $variable - #1053

Merged
plamut merged 8 commits into
googleapis:mainfrom
plamut:iss-1040
Nov 16, 2021
ConversationCommits (8)ChecksFiles changed
Merged

feat: allow cell magic body to be a $variable#1053
plamut merged 8 commits into
googleapis:mainfrom
plamut:iss-1040

Conversation

plamut commented Nov 8, 2021

Copy link
Copy Markdown
Contributor

Closes #1040.

Thought - we probably want to follow up with a sample demonstrating this new use case.

Also, the length of the _cell_magic() function should be ignored for now, it's been waiting to be split into smaller units since forever. 🙂

PR checklist:

  • 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 requested review from a team and loferris November 8, 2021 19:45
google-cla Bot added the cla: yes This human has signed the Contributor License Agreement. label Nov 8, 2021
product-auto-label Bot added the api: bigquery Issues related to the googleapis/python-bigquery API. label Nov 8, 2021
tseaver reviewed Nov 8, 2021
View reviewed changes
Comment thread google/cloud/bigquery/magics/magics.py Outdated
Comment thread google/cloud/bigquery/magics/magics.py Outdated

google-cla Bot commented Nov 8, 2021

Copy link
Copy Markdown

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

google-cla Bot added cla: no This human has *not* signed the Contributor License Agreement. and removed cla: yes This human has signed the Contributor License Agreement. labels Nov 8, 2021

tseaver commented Nov 8, 2021

Copy link
Copy Markdown
Contributor

@googlebot I consent.

google-cla Bot commented Nov 8, 2021

Copy link
Copy Markdown

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

tseaver commented Nov 8, 2021

Copy link
Copy Markdown
Contributor

@plamut Sorry, I tried. :-<

plamut commented Nov 8, 2021

Copy link
Copy Markdown
Contributor Author

OK, I'll edit the commit message then to silence the bot.

google-cla Bot added cla: yes This human has signed the Contributor License Agreement. and removed cla: no This human has *not* signed the Contributor License Agreement. labels Nov 8, 2021
loferris reviewed Nov 10, 2021
View reviewed changes
Comment thread tests/unit/test_magics.py
cell_body = "$custom_query"

with pytest.raises(
NameError, match=r".*custom_query does not exist.*"

loferris Nov 10, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Maybe comment to indicate we're testing the first kind of error, as I got the regex string match from context of the other file.

plamut Nov 10, 2021 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

The name of the test explains which case it covers ("non-existing query variable"), do you think that's not sufficient by itself?

I always look at the name of the test first, although it might be just how my brain is wired...

Update: Added a comment next to the assignment to cell_body to explain which use case it targets.

loferris Nov 16, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM - I really like how you added the "non-existing query variable" condition.

loferris approved these changes Nov 10, 2021
View reviewed changes

loferris left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM - could do with more comments on test cases, perhaps.

Comment thread tests/unit/test_magics.py
cell_body = "$custom_query"

with pytest.raises(
TypeError, match=r".*must be a string or a bytes-like.*"

loferris Nov 10, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Might be good to have another comment here to match it to the other else condition in run_query_magic

Comment thread tests/unit/test_magics.py Outdated
plamut added the automerge Merge the pull request once unit tests and other checks pass. label Nov 11, 2021
plamut removed the automerge Merge the pull request once unit tests and other checks pass. label Nov 11, 2021
plamut requested a review from loferris November 11, 2021 10:17

loferris commented Nov 16, 2021

Copy link
Copy Markdown
Contributor

LGTM - appreciate the changes!!

plamut merged commit 3a681e0 into googleapis:main Nov 16, 2021
plamut deleted the iss-1040 branch November 16, 2021 21:57
release-please Bot mentioned this pull request Jan 4, 2022
Closed
abdelmegahedgoogle pushed a commit to abdelmegahedgoogle/python-bigquery that referenced this pull request Apr 17, 2023
feat: allow cell magic body to be a $variable (googleapis#1053)
05df4c2 
* feat: allow cell magic body to be a $variable

* Fix missing indefinitive article in error msg

* Adjust test assertion to error message change

* Refactor logic for extracting query variable

* Explicitly warn about missing query variable name

* Thest the query "variable" is not identifier case
This file contains hidden or 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
Show hidden characters
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

2 more reviewers
tseaver tseaver approved these changes
loferris loferris approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

loferris

Labels

api: bigquery Issues related to the googleapis/python-bigquery API. cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

allow the body of %%bigquery cell magic to be a $variable

3 participants

Back | FazBrowse Home | New Git URL