@@ -67,27 +67,30 @@ for more information.
6767ExtraArgs
6868---------
6969
70- S3 objects have additional properties, beyond a traditional
71- filesystem. These options can be set using the ``upload_args ``
72- and ``download_args `` properties. which are handed to upload
73- and download methods, as appropriate, for the lifetime of the
74- filesystem instance.
70+ S3 objects have additional properties, beyond a traditional filesystem.
71+ These options can be set using the ``upload_args `` and ``download_args ``
72+ properties. which are handed to upload and download methods, as
73+ appropriate, for the lifetime of the filesystem instance.
7574
76- For example, to set the ``cache-control `` header of all objects
77- uploaded to a bucket:
75+ For example, to set the ``cache-control `` header of all objects uploaded
76+ to a bucket:
7877
7978.. code :: python
79+
8080 import fs, fs.mirror
8181 s3fs = S3FS(' example' , upload_args = {" CacheControl" : " max-age=2592000" , " ACL" : " public-read" })
8282 fs.mirror.mirror(' /path/to/mirror' , s3fs)
8383
84- see `the Boto3 docs <https://boto3.readthedocs.io/en/latest/reference/customizations/s3.html#boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS >`__
84+ see `the Boto3
85+ docs <https://boto3.readthedocs.io/en/latest/reference/customizations/s3.html#boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS> `__
8586for more information.
8687
87- ``acl `` and ``cache_control `` are exposed explicitly for convenience, and can be used in URLs.
88- It is important to URL-Escape the ``cache_control `` value in a URL, as it may contain special characters.
88+ ``acl `` and ``cache_control `` are exposed explicitly for convenience,
89+ and can be used in URLs. It is important to URL-Escape the
90+ ``cache_control `` value in a URL, as it may contain special characters.
8991
9092.. code :: python
93+
9194 import fs, fs.mirror
9295 with open fs.open_fs(' s3://example?acl=public-read&cache_control=max-age%3D2592000%2Cpublic' ) as s3fs
9396 fs.mirror.mirror(' /path/to/mirror' , s3fs)
0 commit comments