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

Самый простой способ, который я нашел (и, вероятно, самый эффективный), это:

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:

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

В Boto3, если вы проверяете папку (префикс) или файл с помощью list_objects. Вы можете использовать наличие «Contents» в ответе dict как проверку того, существует ли объект. Это еще один способ избежать уловок try / except, как предлагает @EvilPuppetMaster

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

Вы можете использовать S3Fs, который по сути является оболочкой для boto3, которая предоставляет типичные операции в стиле файловой системы. :

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

Предполагая, что вы просто хотите проверить, существует ли ключ (вместо того, чтобы тихо его перезаписывать), сначала выполните эту проверку:

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

Не только 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')

Это может проверить как префикс, так и ключ, и получить не более 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

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

Использование objects.filter и проверка результирующего списка - это, безусловно, самый быстрый способ проверить, существует ли файл в корзине S3. .

Используйте эту лаконичную единственную строку, которая делает ее менее навязчивой, когда вам нужно вставить ее в существующий проект, не изменяя большую часть кода.

s3_file_exists = lambda filename: bool(list(bucket.objects.filter(Prefix=filename)))

Вышеупомянутая функция предполагает, что переменная bucket уже была объявлена.

Вы можете расширить лямбду для поддержки дополнительных параметров, например

s3_file_exists = lambda filename, bucket: bool(list(bucket.objects.filter(Prefix=filename)))

Попробуйте это просто

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

вы можете использовать для этого 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!")

Здесь ключ - это путь, который вы хотите проверить, существует или нет

Есть один простой способ проверить, существует ли файл в корзине 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

Это работает для родительского ключа или ключа, который приравнивается к файлу, или ключу, который не существует. Я попробовал предпочтительный подход, описанный выше, и потерпел неудачу с родительскими ключами.

Если у вас меньше 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

Для 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

Я заметил, что для того, чтобы поймать исключение с помощью botocore.exceptions.ClientError, нам нужно установить ботокор. botocore занимает 36M дискового пространства. Это особенно заметно, если мы используем лямбда-функции 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)

Вот решение, которое мне подходит. Одно предостережение: я заранее знаю точный формат ключа, поэтому перечисляю только один файл.

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

Просто проследив за темой, может ли кто-нибудь сделать вывод, какой из них является наиболее эффективным способом проверить, существует ли объект в S3?

Я думаю, что head_object может выиграть, поскольку он просто проверяет метаданные, которые легче, чем сам объект.

Проверить

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

Проверьте, существует ли в сегменте конкретный ключ. Этот метод использует запрос HEAD для проверки существования ключа. Возвращает: экземпляр объекта Key или None.

из Документов Boto S3

Вы можете просто вызвать bucket.get_key (keyname) и проверить, является ли возвращенный объект None.

Это действительно просто с 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'))