sprawdź, czy klucz istnieje w wiadrze w s3 za pomocą boto3

Chciałbym wiedzieć, czy klucz istnieje w boto3. Mogę zapętlić zawartość wiadra i sprawdzić, czy klucz pasuje.

Ale to wydaje się dłuższe i przesada. Oficjalna dokumentacja Boto3 wyraźnie określa, jak to zrobić.

Może brakuje mi tego, co oczywiste. Czy ktoś może mi wskazać, jak mogę to osiągnąć.

Obiekt Boto 2 miał boto.s3.key.Keykiedyś existsmetodę, która sprawdzała, czy klucz istnieje na S3, wykonując żądanie HEAD i patrząc na wynik, ale wydaje się, że już go nie ma. Musisz to zrobić sam:

import boto3
import botocore

s3 = boto3.resource('s3')

try:
    s3.Object('my-bucket', 'dootdoot.jpg').load()
except botocore.exceptions.ClientError as e:
    if e.response['Error']['Code'] == "404":
        # The object does not exist.
        ...
    else:
        # Something else has gone wrong.
        raise
else:
    # The object does exist.
    ...

load() wykonuje żądanie HEAD dla pojedynczego klucza, co jest szybkie, nawet jeśli dany obiekt jest duży lub masz wiele obiektów w swoim zasobniku.

Oczywiście możesz sprawdzić, czy obiekt istnieje, ponieważ planujesz go użyć. Jeśli tak jest, możesz po prostu zapomnieć o load()i zrobić get()lub download_file()bezpośrednio, a następnie obsłużyć tam przypadek błędu.

Nie jestem wielkim fanem używania wyjątków dla przepływu sterowania. To jest alternatywne podejście, które działa w boto3:

import boto3

s3 = boto3.resource('s3')
bucket = s3.Bucket('my-bucket')
key = 'dootdoot.jpg'
objs = list(bucket.objects.filter(Prefix=key))
if any([w.key == path_s3 for w in objs]):
    print("Exists!")
else:
    print("Doesn't exist")

Najłatwiejszy sposób, jaki znalazłem (i prawdopodobnie najbardziej wydajny), to:

import boto3
from botocore.errorfactory import ClientError

s3 = boto3.client('s3')
try:
    s3.head_object(Bucket='bucket_name', Key='file_path')
except ClientError:
    # Not found
    pass

W Boto3, jeśli sprawdzasz folder (prefiks) lub plik za pomocą list_objects. Możesz użyć istnienia „Contents” w dyktandzie odpowiedzi jako sprawdzenia, czy obiekt istnieje. Jest to inny sposób na uniknięcie prób / wyjątków, jak sugeruje @EvilPuppetMaster

import boto3
client = boto3.client('s3')
results = client.list_objects(Bucket='my-bucket', Prefix='dootdoot.jpg')
return 'Contents' in results

Nie tylko, clientale bucketteż:

import boto3
import botocore
bucket = boto3.resource('s3', region_name='eu-west-1').Bucket('my-bucket')

try:
  bucket.Object('my-file').get()
except botocore.exceptions.ClientError as ex:
  if ex.response['Error']['Code'] == 'NoSuchKey':
    print('NoSuchKey')

Możesz użyć S3F , który jest zasadniczo opakowaniem wokół boto3, które ujawnia typowe operacje w stylu systemu plików:

import s3fs
s3 = s3fs.S3FileSystem()
s3.exists('myfile.txt')

import boto3
client = boto3.client('s3')
s3_key = 'Your file without bucket name e.g. abc/bcd.txt'
bucket = 'your bucket name'
content = client.head_object(Bucket=bucket,Key=s3_key)
    if content.get('ResponseMetadata',None) is not None:
        print "File exists - s3://%s/%s " %(bucket,s3_key) 
    else:
        print "File does not exist - s3://%s/%s " %(bucket,s3_key)

FWIW, oto bardzo proste funkcje, których używam

import boto3

def get_resource(config: dict={}):
    """Loads the s3 resource.

    Expects AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY to be in the environment
    or in a config dictionary.
    Looks in the environment first."""

    s3 = boto3.resource('s3',
                        aws_access_key_id=os.environ.get(
                            "AWS_ACCESS_KEY_ID", config.get("AWS_ACCESS_KEY_ID")),
                        aws_secret_access_key=os.environ.get("AWS_SECRET_ACCESS_KEY", config.get("AWS_SECRET_ACCESS_KEY")))
    return s3


def get_bucket(s3, s3_uri: str):
    """Get the bucket from the resource.
    A thin wrapper, use with caution.

    Example usage:

    >> bucket = get_bucket(get_resource(), s3_uri_prod)"""
    return s3.Bucket(s3_uri)


def isfile_s3(bucket, key: str) -> bool:
    """Returns T/F whether the file exists."""
    objs = list(bucket.objects.filter(Prefix=key))
    return len(objs) == 1 and objs[0].key == key


def isdir_s3(bucket, key: str) -> bool:
    """Returns T/F whether the directory exists."""
    objs = list(bucket.objects.filter(Prefix=key))
    return len(objs) > 1

Zakładając, że chcesz tylko sprawdzić, czy klucz istnieje (zamiast po cichu go nadpisywać), najpierw zrób to sprawdzenie:

import boto3

def key_exists(mykey, mybucket):
  s3_client = boto3.client('s3')
  response = s3_client.list_objects_v2(Bucket=mybucket, Prefix=mykey)
  if response:
      for obj in response['Contents']:
          if mykey == obj['Key']:
              return True
  return False

if key_exists('someprefix/myfile-abc123', 'my-bucket-name'):
    print("key exists")
else:
    print("safe to put new bucket object")
    # try:
    #     resp = s3_client.put_object(Body="Your string or file-like object",
    #                                 Bucket=mybucket,Key=mykey)
    # ...check resp success and ClientError exception for errors...

Wypróbuj to proste

import boto3
s3 = boto3.resource('s3')
bucket = s3.Bucket('mybucket_name') # just Bucket name
file_name = 'A/B/filename.txt'      # full file path
obj = list(bucket.objects.filter(Prefix=file_name))
if len(obj) > 0:
    print("Exists")
else:
    print("Not Exists")

Może to sprawdzić zarówno prefiks, jak i klucz i pobrać maksymalnie 1 klucz.

def prefix_exits(bucket, prefix):
    s3_client = boto3.client('s3')
    res = s3_client.list_objects_v2(Bucket=bucket, Prefix=prefix, MaxKeys=1)
    return 'Contents' in res

Jeśli masz mniej niż 1000 w katalogu lub wiadrze, możesz pobrać ich zestaw i po sprawdzeniu, czy taki klucz jest w tym zestawie:

files_in_dir = {d['Key'].split('/')[-1] for d in s3_client.list_objects_v2(
Bucket='mybucket',
Prefix='my/dir').get('Contents') or []}

Taki kod działa nawet jeśli my/dirnie istnieje.

http://boto3.readthedocs.io/en/latest/reference/services/s3.html#S3.Client.list_objects_v2

S3_REGION="eu-central-1"
bucket="mybucket1"
name="objectname"

import boto3
from botocore.client import Config
client = boto3.client('s3',region_name=S3_REGION,config=Config(signature_version='s3v4'))
list = client.list_objects_v2(Bucket=bucket,Prefix=name)
for obj in list.get('Contents', []):
    if obj['Key'] == name: return True
return False

W przypadku boto3 ObjectSummary może służyć do sprawdzenia, czy obiekt istnieje.

Zawiera podsumowanie obiektu przechowywanego w zasobniku Amazon S3. Ten obiekt nie zawiera pełnych metadanych obiektu ani żadnej jego zawartości

import boto3
from botocore.errorfactory import ClientError
def path_exists(path, bucket_name):
    """Check to see if an object exists on S3"""
    s3 = boto3.resource('s3')
    try:
        s3.ObjectSummary(bucket_name=bucket_name, key=path).load()
    except ClientError as e:
        if e.response['Error']['Code'] == "404":
            return False
        else:
            raise e
    return True

path_exists('path/to/file.html')

W ObjectSummary.load

Wywołuje s3.Client.head_object, aby zaktualizować atrybuty zasobu ObjectSummary.

To pokazuje, że możesz użyć ObjectSummaryzamiast, Objectjeśli planujesz nie używać get(). load()Funkcja nie odebrania obiektu to tylko uzyska podsumowanie.

Oto rozwiązanie, które działa dla mnie. Jedynym zastrzeżeniem jest to, że z wyprzedzeniem znam dokładny format klucza, więc wymieniam tylko jeden plik

import boto3

# The s3 base class to interact with S3
class S3(object):
  def __init__(self):
    self.s3_client = boto3.client('s3')

  def check_if_object_exists(self, s3_bucket, s3_key):
    response = self.s3_client.list_objects(
      Bucket = s3_bucket,
      Prefix = s3_key
      )
    if 'ETag' in str(response):
      return True
    else:
      return False

if __name__ == '__main__':
  s3  = S3()
  if s3.check_if_object_exists(bucket, key):
    print "Found S3 object."
  else:
    print "No object found."

możesz do tego użyć Boto3.

import boto3
s3 = boto3.resource('s3')
bucket = s3.Bucket('my-bucket')
objs = list(bucket.objects.filter(Prefix=key))
if(len(objs)>0):
    print("key exists!!")
else:
    print("key doesn't exist!")

Tutaj kluczem jest ścieżka, którą chcesz sprawdzić, czy istnieje, czy nie

get()Metoda jest naprawdę prosta

import botocore
from boto3.session import Session
session = Session(aws_access_key_id='AWS_ACCESS_KEY',
                aws_secret_access_key='AWS_SECRET_ACCESS_KEY')
s3 = session.resource('s3')
bucket_s3 = s3.Bucket('bucket_name')

def not_exist(file_key):
    try:
        file_details = bucket_s3.Object(file_key).get()
        # print(file_details) # This line prints the file details
        return False
    except botocore.exceptions.ClientError as e:
        if e.response['Error']['Code'] == "NoSuchKey": # or you can check with e.reponse['HTTPStatusCode'] == '404'
            return True
        return False # For any other error it's hard to determine whether it exists or not. so based on the requirement feel free to change it to True/ False / raise Exception

print(not_exist('hello_world.txt')) 

Jest jeden prosty sposób, dzięki któremu możemy sprawdzić, czy plik istnieje w zasobniku S3, czy nie. Nie musimy do tego używać wyjątków

sesssion = boto3.Session(aws_access_key_id, aws_secret_access_key)
s3 = session.client('s3')

object_name = 'filename'
bucket = 'bucketname'
obj_status = s3.list_objects(Bucket = bucket, Prefix = object_name)
if obj_status.get('Contents'):
    print("File exists")
else:
    print("File does not exists")

Jeśli szukasz klucza, który jest odpowiednikiem katalogu, możesz chcieć tego podejścia

session = boto3.session.Session()
resource = session.resource("s3")
bucket = resource.Bucket('mybucket')

key = 'dir-like-or-file-like-key'
objects = [o for o in bucket.objects.filter(Prefix=key).limit(1)]    
has_key = len(objects) > 0

Działa to dla klucza nadrzędnego lub klucza równego plikowi lub klucza, który nie istnieje. Wypróbowałem preferowane podejście powyżej i zawiodłem na kluczach nadrzędnych.

Zauważyłem, że aby złapać wyjątek za pomocą botocore.exceptions.ClientError, musimy zainstalować botocore. botocore zajmuje 36M miejsca na dysku. Ma to szczególne znaczenie, jeśli używamy funkcji lambda aws. Zamiast tego, jeśli użyjemy tylko wyjątku, możemy pominąć korzystanie z dodatkowej biblioteki!

• Sprawdzam, czy rozszerzenie pliku to „.csv”
• Nie spowoduje to zgłoszenia wyjątku, jeśli zasobnik nie istnieje!
• Nie spowoduje to zgłoszenia wyjątku, jeśli zasobnik istnieje, ale obiekt nie istnieje!
• Spowoduje to odrzucenie wyjątku, jeśli wiadro jest puste!
• Spowoduje to wyrzucenie wyjątku, jeśli zasobnik nie ma uprawnień!

Kod wygląda następująco. Podziel się swoimi przemyśleniami:

import boto3
import traceback

def download4mS3(s3bucket, s3Path, localPath):
    s3 = boto3.resource('s3')

    print('Looking for the csv data file ending with .csv in bucket: ' + s3bucket + ' path: ' + s3Path)
    if s3Path.endswith('.csv') and s3Path != '':
        try:
            s3.Bucket(s3bucket).download_file(s3Path, localPath)
        except Exception as e:
            print(e)
            print(traceback.format_exc())
            if e.response['Error']['Code'] == "404":
                print("Downloading the file from: [", s3Path, "] failed")
                exit(12)
            else:
                raise
        print("Downloading the file from: [", s3Path, "] succeeded")
    else:
        print("csv file not found in in : [", s3Path, "]")
        exit(12)

Czy po prostu podążając za wątkiem, ktoś może stwierdzić, który z nich jest najbardziej efektywnym sposobem sprawdzenia, czy obiekt istnieje w S3?

Myślę, że head_object może wygrać, ponieważ sprawdza tylko metadane, które są jaśniejsze niż sam obiekt

Z https://www.peterbe.com/plog/fastest-way-to-find-out-if-a-file-exists-in-s3 wskazuje się, że jest to najszybsza metoda:

import boto3

boto3_session = boto3.session.Session()
s3_session_client = boto3_session.client("s3")
response = s3_session_client.list_objects_v2(
    Bucket=bc_df_caches_bucket, Prefix=s3_key
)
for obj in response.get("Contents", []):
    if obj["Key"] == s3_key:
        return True
return False

Sprawdzić

bucket.get_key(
    key_name, 
    headers=None, 
    version_id=None, 
    response_headers=None, 
    validate=True
)

Sprawdź, czy w zasobniku istnieje określony klucz. Ta metoda używa żądania HEAD do sprawdzenia istnienia klucza. Zwraca: wystąpienie obiektu Key lub None

z Boto S3 Docs

Możesz po prostu zadzwonić do bucket.get_key (nazwa klucza) i sprawdzić, czy zwrócony obiekt ma wartość Brak.