Skip to content

Commit

Permalink
community[patch]: Update doc-string in CloudBlobLoader (#22069)
Browse files Browse the repository at this point in the history
Update doc-string
  • Loading branch information
eyurtsev committed May 23, 2024
1 parent 8ba4f77 commit e5541d1
Showing 1 changed file with 7 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ class CloudBlobLoader(BlobLoader):
.. code-block:: python
loader = CloudBlobLoader("s3://mybucket/id")
for blob in loader.yield_blobs():
print(blob)
""" # noqa: E501
Expand All @@ -145,11 +146,14 @@ def __init__(
show_progress: bool = False,
) -> None:
"""Initialize with a url and how to glob over it.
Use [CloudPathLib](https://cloudpathlib.drivendata.org/).
Args:
url: Cloud URL to load from.
If a path to a file is provided, glob/exclude/suffixes are ignored.
Supports s3://, az://, gs://, file:// schemes.
If no scheme is provided, it is assumed to be a local file.
If a path to a file is provided, glob/exclude/suffixes are ignored.
glob: Glob pattern relative to the specified path
by default set to pick up all non-hidden files
exclude: patterns to exclude from results, use glob syntax
Expand Down Expand Up @@ -252,6 +256,8 @@ def from_path(
Args:
path: path like object to file to be read
Supports s3://, az://, gs://, file:// schemes.
If no scheme is provided, it is assumed to be a local file.
encoding: Encoding to use if decoding the bytes into a string
mime_type: if provided, will be set as the mime-type of the data
guess_type: If True, the mimetype will be guessed from the file extension,
Expand Down

0 comments on commit e5541d1

Please sign in to comment.