Come salvare l'oggetto S3 in un file usando boto3

Sto cercando di creare un "mondo di ciao" con il nuovo client boto3 per AWS.

Il caso d'uso che ho è abbastanza semplice: ottenere l'oggetto da S3 e salvarlo nel file.

In boto 2.X lo farei così:

import boto
key = boto.connect_s3().get_bucket('foo').get_key('foo')
key.get_contents_to_filename('/tmp/foo')

In boto 3. Non riesco a trovare un modo pulito per fare la stessa cosa, quindi sto ripetendo manualmente l'oggetto "Streaming":

import boto3
key = boto3.resource('s3').Object('fooo', 'docker/my-image.tar.gz').get()
with open('/tmp/my-image.tar.gz', 'w') as f:
    chunk = key['Body'].read(1024*8)
    while chunk:
        f.write(chunk)
        chunk = key['Body'].read(1024*8)

o

import boto3
key = boto3.resource('s3').Object('fooo', 'docker/my-image.tar.gz').get()
with open('/tmp/my-image.tar.gz', 'w') as f:
    for chunk in iter(lambda: key['Body'].read(4096), b''):
        f.write(chunk)

E funziona benissimo. Mi chiedevo c'è qualche funzione "nativa" di boto3 che farà lo stesso compito?

C'è una personalizzazione recentemente entrata in Boto3 che aiuta in questo (tra le altre cose). È attualmente esposto sul client S3 di basso livello e può essere utilizzato in questo modo:

s3_client = boto3.client('s3')
open('hello.txt').write('Hello, world!')

# Upload the file to S3
s3_client.upload_file('hello.txt', 'MyBucket', 'hello-remote.txt')

# Download the file from S3
s3_client.download_file('MyBucket', 'hello-remote.txt', 'hello2.txt')
print(open('hello2.txt').read())

Queste funzioni gestiranno automaticamente la lettura / scrittura di file, oltre a eseguire upload in più parti in parallelo per file di grandi dimensioni.

Nota che s3_client.download_filenon creerà una directory. Può essere creato come pathlib.Path('/path/to/file.txt').parent.mkdir(parents=True, exist_ok=True).

boto3 ora ha un'interfaccia migliore rispetto al client:

resource = boto3.resource('s3')
my_bucket = resource.Bucket('MyBucket')
my_bucket.download_file(key, local_filename)

Questo di per sé non è tremendamente migliore della clientrisposta accettata (anche se i documenti dicono che fa un lavoro migliore riprovando upload e download in caso di fallimento) ma considerando che le risorse sono generalmente più ergonomiche (ad esempio, il bucket s3 e le risorse dell'oggetto sono più carini dei metodi client), questo ti consente di rimanere a livello di risorse senza dover cadere.

Resources generalmente possono essere creati allo stesso modo dei client e accettano tutti o quasi gli stessi argomenti e li inoltrano ai loro client interni.

Per quelli di voi che vorrebbero simulare i set_contents_from_stringmetodi simili di boto2, potete provare

import boto3
from cStringIO import StringIO

s3c = boto3.client('s3')
contents = 'My string to save to S3 object'
target_bucket = 'hello-world.by.vor'
target_file = 'data/hello.txt'
fake_handle = StringIO(contents)

# notice if you do fake_handle.read() it reads like a file handle
s3c.put_object(Bucket=target_bucket, Key=target_file, Body=fake_handle.read())

Per Python3:

In python3 sia StringIO che cStringIO sono spariti . Usa l' StringIOimportazione come:

from io import StringIO

Per supportare entrambe le versioni:

try:
   from StringIO import StringIO
except ImportError:
   from io import StringIO

# Preface: File is json with contents: {'name': 'Android', 'status': 'ERROR'}

import boto3
import io

s3 = boto3.resource('s3')

obj = s3.Object('my-bucket', 'key-to-file.json')
data = io.BytesIO()
obj.download_fileobj(data)

# object is now a bytes string, Converting it to a dict:
new_dict = json.loads(data.getvalue().decode("utf-8"))

print(new_dict['status']) 
# Should print "Error"

Quando vuoi leggere un file con una configurazione diversa da quella predefinita, sentiti libero di usare mpu.aws.s3_download(s3path, destination)direttamente o il codice incollato:

def s3_download(source, destination,
                exists_strategy='raise',
                profile_name=None):
    """
    Copy a file from an S3 source to a local destination.

    Parameters
    ----------
    source : str
        Path starting with s3://, e.g. 's3://bucket-name/key/foo.bar'
    destination : str
    exists_strategy : {'raise', 'replace', 'abort'}
        What is done when the destination already exists?
    profile_name : str, optional
        AWS profile

    Raises
    ------
    botocore.exceptions.NoCredentialsError
        Botocore is not able to find your credentials. Either specify
        profile_name or add the environment variables AWS_ACCESS_KEY_ID,
        AWS_SECRET_ACCESS_KEY and AWS_SESSION_TOKEN.
        See https://boto3.readthedocs.io/en/latest/guide/configuration.html
    """
    exists_strategies = ['raise', 'replace', 'abort']
    if exists_strategy not in exists_strategies:
        raise ValueError('exists_strategy \'{}\' is not in {}'
                         .format(exists_strategy, exists_strategies))
    session = boto3.Session(profile_name=profile_name)
    s3 = session.resource('s3')
    bucket_name, key = _s3_path_split(source)
    if os.path.isfile(destination):
        if exists_strategy is 'raise':
            raise RuntimeError('File \'{}\' already exists.'
                               .format(destination))
        elif exists_strategy is 'abort':
            return
    s3.Bucket(bucket_name).download_file(key, destination)

from collections import namedtuple

S3Path = namedtuple("S3Path", ["bucket_name", "key"])


def _s3_path_split(s3_path):
    """
    Split an S3 path into bucket and key.

    Parameters
    ----------
    s3_path : str

    Returns
    -------
    splitted : (str, str)
        (bucket, key)

    Examples
    --------
    >>> _s3_path_split('s3://my-bucket/foo/bar.jpg')
    S3Path(bucket_name='my-bucket', key='foo/bar.jpg')
    """
    if not s3_path.startswith("s3://"):
        raise ValueError(
            "s3_path is expected to start with 's3://', " "but was {}"
            .format(s3_path)
        )
    bucket_key = s3_path[len("s3://"):]
    bucket_name, key = bucket_key.split("/", 1)
    return S3Path(bucket_name, key)

Nota: suppongo che tu abbia configurato l'autenticazione separatamente. Sotto il codice è quello di scaricare il singolo oggetto dal bucket S3.

import boto3

#initiate s3 client 
s3 = boto3.resource('s3')

#Download object to the file    
s3.Bucket('mybucket').download_file('hello.txt', '/tmp/hello.txt')