Skip to content

docs: note that udf is in preview and must be python 3.11 compatible #1629

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Apr 22, 2025
Merged

docs: note that udf is in preview and must be python 3.11 compatible #1629

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3450731
docs: note that `udf` is in preview and must be python 3.11 compatible
shobsi Apr 17, 2025
49bb194
user stacklevel=5 to optimize the warning for bpd.udf entry point
shobsi Apr 17, 2025
4a3492c
Merge remote-tracking branch 'refs/remotes/github/main' into shobs-mf…
shobsi Apr 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions bigframes/functions/_function_session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -740,9 +740,12 @@ def udf(
BigQuery managed function.

.. note::
The udf must be self-contained, i.e. it must not contain any
This feature is in preview. The code in the udf must be
(1) self-contained, i.e. it must not contain any
references to an import or variable defined outside the function
body.
body, and
(2) Python 3.11 compatible, as that is the environment
in which the code is executed in the cloud.

.. note::
Please have following IAM roles enabled for you:
Expand Down Expand Up @@ -801,7 +804,7 @@ def udf(
https://pip.pypa.io/en/stable/reference/requirements-file-format/.
"""

warnings.warn("udf is in preview.", category=bfe.PreviewWarning)
warnings.warn("udf is in preview.", category=bfe.PreviewWarning, stacklevel=5)

# Some defaults may be used from the session if not provided otherwise.
session = self._resolve_session(session)
Expand Down
7 changes: 5 additions & 2 deletions bigframes/session/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1426,9 +1426,12 @@ def udf(
[BigQuery managed user-defined function](https://cloud.google.com/bigquery/docs/user-defined-functions-python).

.. note::
The udf must be self-contained, i.e. it must not contain any
This feature is in preview. The code in the udf must be
(1) self-contained, i.e. it must not contain any
references to an import or variable defined outside the function
body.
body, and
(2) Python 3.11 compatible, as that is the environment
in which the code is executed in the cloud.

.. note::
Please have BigQuery Data Editor (roles/bigquery.dataEditor) IAM
Expand Down