Skip to main content

Udf

Udf​

The Udf class is the object you get when defining a UDF with the @fused.udf decorator, or when loading a saved UDF with fused.load().

to_fused​

to_fused(overwrite: bool | None = None, **kwargs: dict[str, Any])

Save this UDF on the Fused service.

Parameters:

  • overwrite (bool | None) – If True, overwrite existing remote UDF with the UDF object.

to_directory​

to_directory(where: str | Path | None = None, *, overwrite: bool = False)

Write the UDF to disk as a directory (folder).

Parameters:

  • where (str | Path | None) – A path to a directory. If not provided, uses the UDF function name.

Other Parameters:

  • overwrite (bool) – If true, overwriting is allowed.

to_file​

to_file(where: str | Path | BinaryIO, *, overwrite: bool = False)

Write the UDF to disk or the specified file-like object.

The UDF will be written as a Zip file.

Parameters:

  • where (str | Path | BinaryIO) – A path to a file or a file-like object.

Other Parameters:

  • overwrite (bool) – If true, overwriting is allowed.

create_access_token​

create_access_token(
    *,
    client_id: str | Ellipsis | None = ...,
    public_read: bool | None = None,
    access_scope: str | None = None,
    cache: bool = True,
    metadata_json: dict[str, Any] | None = None,
    enabled: bool = True
) -> UdfAccessToken

get_access_tokens​

get_access_tokens() -> UdfAccessTokenList

delete_saved​

delete_saved(inplace: bool = True)

delete_cache​

delete_cache()

catalog_url​

catalog_url: str | None

Returns the link to open this UDF in the Workbench Catalog, or None if the UDF is not saved.