Skip to content

Commit 06c5800

Browse files
committed
Improve comments in storage client
1 parent 6aeffa6 commit 06c5800

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

sdk/python/feast/staging/storage_client.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
class AbstractStagingClient(ABC):
3030
"""
31-
Abstract class for staging client, any new client should implement this class.
31+
Client used to stage files in order to upload or download datasets into a historical store.
3232
"""
3333

3434
__metaclass__ = ABCMeta
@@ -39,14 +39,23 @@ def __init__(self):
3939

4040
@abstractmethod
4141
def download_file(self, uri: ParseResult) -> IO[bytes]:
42+
"""
43+
Downloads a file from an object store and returns a TemporaryFile object
44+
"""
4245
pass
4346

4447
@abstractmethod
4548
def list_files(self, bucket: str, path: str) -> List[str]:
49+
"""
50+
Lists all the files under a directory in an object store.
51+
"""
4652
pass
4753

4854
@abstractmethod
4955
def upload_file(self, local_path: str, bucket: str, remote_path: str):
56+
"""
57+
Uploads a file to an object store.
58+
"""
5059
pass
5160

5261

@@ -67,7 +76,7 @@ def __init__(self):
6776

6877
def download_file(self, uri: ParseResult) -> IO[bytes]:
6978
"""
70-
Downloads a file from google cloud storageF and returns a TemporaryFile object
79+
Downloads a file from google cloud storage and returns a TemporaryFile object
7180
7281
Args:
7382
uri (urllib.parse.ParseResult): Parsed uri of the file ex: urlparse("gs://bucket/file.avro")

0 commit comments

Comments
 (0)