AliCloud OSS filesystem for PyFilesystem2
Project description
OSSFS is a PyFilesystem interface to AliCloud OSS cloud storage.
As a PyFilesystem concrete class, OSSFS allows you to work with OSS in the same way as any other supported filesystem.
Installing
You can install OSSFS from pip as follows:
pip install fs-ossfs
Opening a OSSFS
Open an OSSFS by explicitly using the constructor:
from fs_ossfs import OSSFS
ossfs = OSSFS('mybucket')
Or with a FS URL:
from fs import open_fs
ossfs = open_fs('oss://mybucket')
Downloading Files
To download files from an OSS bucket, open a file on the OSS filesystem for reading, then write the data to a file on the local filesystem. Here’s an example that copies a file example.mov from OSS to your HD:
from fs.tools import copy_file_data
with ossfs.open('example.mov', 'rb') as remote_file:
with open('example.mov', 'wb') as local_file:
copy_file_data(remote_file, local_file)
Although it is preferable to use the higher-level functionality in the fs.copy module. Here’s an example:
from fs.copy import copy_file
copy_file(ossfs, 'example.mov', './', 'example.mov')
Uploading Files
You can upload files in the same way. Simply copy a file from a source filesystem to the OSS filesystem. See Moving and Copying for more information.
ExtraArgs
OSS objects have additional properties, beyond a traditional filesystem. These options can be set using the upload_args and download_args properties. which are handed to upload and download methods, as appropriate, for the lifetime of the filesystem instance.
For example, to set the cache-control header of all objects uploaded to a bucket:
import fs, fs.mirror
ossfs = OSSFS('example', upload_args={"CacheControl": "max-age=2592000", "ACL": "public-read"})
fs.mirror.mirror('/path/to/mirror', ossfs)
see the Boto3 docs for more information.
acl and cache_control are exposed explicitly for convenience, and can be used in URLs. It is important to URL-Escape the cache_control value in a URL, as it may contain special characters.
import fs, fs.mirror
with open fs.open_fs('oss://example?acl=public-read&cache_control=max-age%3D2592000%2Cpublic') as ossfs
fs.mirror.mirror('/path/to/mirror', ossfs)
OSS URLs
You can get a public URL to a file on a OSS bucket as follows:
movie_url = ossfs.geturl('example.mov')
Documentation
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fs_ossfs-1.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c26685775e6c59a4f3ca6212b730cde82a49ff3caece1701d1375b766fd68a7 |
|
MD5 | 774dcb58162857996b223c0224147a92 |
|
BLAKE2b-256 | 18c58171f50ea6921ead405b57ead3cabcf95493a1701cb3c8e5de52545ca2c1 |