перевірте, чи існує ключ у відрі в s3 за допомогою boto3

Мені хотілося б знати, чи існує ключ у boto3. Я можу зімкнути вміст відра і перевірити ключ, чи він відповідає.

Але це здається довше і надмірним. Офіційні документи Boto3 прямо вказали, як це зробити.

Можливо, я пропускаю очевидне. Хтось може вказати мені, як я можу цього досягти.

boto.s3.key.KeyОб'єкт Boto 2 використовував existsметод, який перевіряв, чи існує ключ на S3, роблячи запит HEAD і дивлячись на результат, але, здається, цього більше немає. Ви повинні зробити це самостійно:

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() робить запит HEAD для одного ключа, який швидко, навіть якщо об'єкт, про який йде мова, великий або у вашому відрі багато об'єктів.

Звичайно, ви можете перевірити, чи існує об'єкт, оскільки ви плануєте його використовувати. Якщо це так, ви можете просто забути про load()і робити get()або download_file()безпосередньо, і потім обробити випадок помилки.

Я не є великим прихильником використання виключень для контролю потоку. Це альтернативний підхід, який працює в 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")

Найпростіший спосіб, який я знайшов (і, мабуть, найбільш ефективний) це:

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

У Boto3, якщо ви перевіряєте чи папку (префікс), чи файл, використовуючи list_objects. Ви можете використовувати існування "Зміст" у відповіді, як перевірку на наявність об'єкта. Це ще один спосіб уникнути спроби / крім вилову, як пропонує @EvilPuppetMaster

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

Не тільки, clientале bucketі:

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')

Ви можете використовувати S3F , які по суті є обгорткою навколо boto3, яка розкриває типові операції в стилі файлової системи:

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, ось дуже прості функції, які я використовую

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

Припустимо, що ви просто хочете перевірити, чи існує ключ (замість того, щоб тихо переписувати його), зробіть цю перевірку спочатку:

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...

Спробуйте це просто

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")

Це може перевірити як префікс, так і ключ, і отримує не більше 1 ключа.

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

Якщо в каталозі чи відрі їх менше 1000, ви можете отримати їх набір і після перевірки, чи є такий ключ у цьому наборі:

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

Такий код працює, навіть якщо my/dirйого немає.

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

Для boto3 ObjectSummary можна використовувати, щоб перевірити, чи існує об'єкт.

Містить підсумок об’єкта, що зберігається у відрі Amazon S3. Цей об'єкт не містить повних метаданих об'єкта або будь-якого його вмісту

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')

В ObjectSummary.load

Викликає s3.Client.head_object для оновлення атрибутів ресурсу ObjectSummary.

Це показує, що ви можете використовувати ObjectSummaryзамість того, Objectякщо ви не плануєте використовувати get(). load()Функція не одержує об'єкт він тільки отримує резюме.

Ось рішення, яке працює для мене. Одне застереження полягає в тому, що я знаю точний формат ключа достроково, тому я перелічу лише один файл

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."

ви можете використовувати 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!")

Тут ключовим є шлях, який ви хочете перевірити, існує чи ні

Це дуже просто з get()методом

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')) 

Є один простий спосіб, за допомогою якого ми можемо перевірити, чи існує файл чи відсутній у відрі S3. Нам не потрібно використовувати для цього виключення

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")

Якщо ви шукаєте ключ, еквівалентний директорії, то, можливо, ви хочете такого підходу

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

Це працює для батьківського ключа або ключа, який прирівнюється до файлу або ключа, який не існує. Я спробував прихильний підхід вище і не вдався до батьківських ключів.

Я помітив, що для того, щоб знайти виняток, використовуючи botocore.exceptions.ClientErrorнам, потрібно встановити botocore. botocore займає 36 млн місця на диску. Це особливо впливає, якщо ми використовуємо функції aws лямбда. Замість цього, якщо ми просто використовуємо виняток, ми можемо пропустити додаткову бібліотеку!

• Я перевіряю, що розширення файлу буде ".csv"
• Це не викине виключення, якщо відро не існує!
• Це не викине виключення, якщо відро існує, але об'єкт не існує!
• Це викидає виняток, якщо відро порожнє!
• Це викидає виняток, якщо відро не має дозволів!

Код виглядає приблизно так. Будь ласка, поділіться своїми думками:

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)

Тільки слідуючи за потоком, чи може хтось зробити висновок, який із найбільш ефективних способів перевірити, чи існує об'єкт у S3?

Я думаю, що head_object може виграти, оскільки він просто перевіряє метадані, які легші, ніж сам фактичний об'єкт

З https://www.peterbe.com/plog/fastest-way-to-find-out-if-a-file-exists-in-s3 це вказано на найшвидший метод:

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

Перевіряти

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

Перевірте, чи існує певний ключ у відрі. Цей метод використовує запит HEAD, щоб перевірити наявність ключа. Повертає: Екземпляр об'єкта Key або None

від Boto S3 Docs

Ви можете просто зателефонувати bucket.get_key (keyname) і перевірити, чи повернутий об'єкт є None.