Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Description

Testing
  • Loading branch information
sfc-gh-zhan committed Sep 17, 2024
1 parent 6a3a77b commit b1f7ae2
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
17 changes: 17 additions & 0 deletions src/snowflake/snowpark/files.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
import sys
from io import RawIOBase

from snowflake.snowpark._internal.utils import private_preview

# Python 3.8 needs to use typing.Iterable because collections.abc.Iterable is not subscriptable
# Python 3.9 can use both
# Python 3.10 needs to use collections.abc.Iterable because typing.Iterable is removed
Expand Down Expand Up @@ -44,6 +46,7 @@ def __init__(
is_owner_file: bool = False,
*,
require_scoped_url: bool = True,
from_result_api: bool = False,
) -> None:
super().__init__()
# The URL/URI of the file to be opened by the SnowflakeFile object
Expand Down Expand Up @@ -122,6 +125,20 @@ def isatty(self) -> None:
"""
raise NotImplementedError(_DEFER_IMPLEMENTATION_ERR_MSG)

@classmethod
@private_preview(version="1.22.1")
def open_new_result(cls, mode: str = "w") -> SnowflakeFile:
"""
Returns a :class:`~snowflake.snowpark.file.SnowflakeFile`.
In UDF and Stored Procedures, the object works like a Python IOBase object and as a wrapper for an IO stream of remote files. The IO Stream is to support the file operations defined in this class.
You can use this particular scoped URL to access files from within Snowflake (through another UDF or the COPY FILES command), but not from outside of Snowflake as a pre-signed URL. The scoped URL is valid for 24 hours.
Args:
mode: A string used to mark the type of an IO stream.
"""
return cls("new results file", mode, require_scoped_url=0, from_result_api=True)

def read(self, size: int = -1) -> None:
"""
See https://docs.python.org/3/library/io.html#io.RawIOBase.read
Expand Down
8 changes: 8 additions & 0 deletions tests/unit/test_files.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

import pytest

from snowflake.snowpark._internal.utils import private_preview
from snowflake.snowpark.files import _DEFER_IMPLEMENTATION_ERR_MSG, SnowflakeFile


Expand All @@ -15,6 +16,13 @@ def test_create_snowflakefile():
assert snowflake_file._mode == "r"


@private_preview(version="1.22.1")
def test_write_snowflakefile():
with SnowflakeFile.open_new_result("w") as snowflake_file:
assert snowflake_file._file_location == "new results file"
assert snowflake_file._mode == "w"


def test_snowflake_file_attribute():
with SnowflakeFile.open("test_file_location") as snowflake_file:
assert snowflake_file.buffer is None
Expand Down

0 comments on commit b1f7ae2

Please sign in to comment.