pitrou commented on code in PR #13582:
URL: https://github.com/apache/arrow/pull/13582#discussion_r918990508
##########
python/pyarrow/fs.py:
##########
@@ -227,16 +227,34 @@ def copy_files(source, destination,
Examples
--------
- Copy an S3 bucket's files to a local directory:
+ Inspect an S3 bucket's files:
- >>> copy_files("s3://your-bucket-name",
- ... "local-directory") # doctest: +SKIP
+ >>> s3, path = fs.FileSystem.from_uri(
+ ... "s3://registry.opendata.aws/roda/ndjson/")
+ >>> selector = fs.FileSelector("registry.opendata.aws/roda/ndjson")
+ >>> s3.get_file_info(selector)
+ [<FileInfo for 'registry.opendata.aws/roda/ndjson/index.ndjson':...]
- Using a FileSystem object:
+ Create a LocalFIleSystem object and a new directory:
- >>> copy_files("your-bucket-name", "local-directory",
- ... source_filesystem=S3FileSystem(...)) # doctest: +SKIP
+ >>> local = fs.LocalFileSystem()
+ >>> local.create_dir('/tmp/copy-dir')
Review Comment:
My position would be: if it's difficult to make an example both readable and
executable, then readability should take the upper hand. YMMV, though :-)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
