我想知道boto3中是否存在密钥。我可以循环存储桶内容并检查密钥是否匹配。
但这似乎更长,而且有点矫枉过正。 Boto3官方文档明确说明了如何做到这一点。
可能是我错过了显而易见的事实。任何人都可以指出我如何实现这一目标。
答案 0 :(得分:128)
Boto 2的boto.s3.key.Key
对象曾经有一个exists
方法,通过执行HEAD请求并查看结果来检查S3上是否存在密钥,但似乎不再存在。你必须自己做:
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()
,然后在那里处理错误案例。
答案 1 :(得分:84)
我不是使用控制流异常的忠实粉丝。这是另一种适用于boto3的方法:
import boto3
s3 = boto3.resource('s3')
bucket = s3.Bucket('my-bucket')
key = 'dootdoot.jpg'
objs = list(bucket.objects.filter(Prefix=key))
if len(objs) > 0 and objs[0].key == key:
print("Exists!")
else:
print("Doesn't exist")
答案 2 :(得分:66)
我找到的最简单的方法(可能是效率最高的)是:
import boto3
from botocore.errorfactory import ClientError
s3 = boto3.client('s3', aws_access_key_id='aws_key', aws_secret_access_key='aws_secret')
try:
s3.head_object(Bucket='bucket_name', Key='file_path')
except ClientError:
# Not found
pass
答案 3 :(得分:18)
在Boto3中,如果您正在使用list_objects检查文件夹(前缀)或文件。您可以使用响应dict中“Contents”的存在来检查对象是否存在。这是避免尝试/除外捕获的另一种方法,如@EvilPuppetMaster建议
import boto3
client = boto3.client('s3')
results = client.list_objects(Bucket='my-bucket', Prefix='dootdoot.jpg')
return 'Contents' in results
答案 4 :(得分:10)
不仅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')
答案 5 :(得分:7)
假设您只想检查密钥是否存在(而不是悄悄地覆盖它),请首先执行以下检查:
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...
答案 6 :(得分:6)
这可以同时检查前缀和密钥,并最多获取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
答案 7 :(得分:2)
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)
答案 8 :(得分:2)
尝试这个简单
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")
答案 9 :(得分:1)
使用此简洁的oneliner,在不必将其扔到现有项目中而无需修改大量代码的情况下,可以减少干扰。
s3_file_exists = lambda filename: bool(list(bucket.objects.filter(Prefix=filename)))
上面的函数假定bucket
变量已经声明。
您可以扩展lambda以支持其他参数,例如
s3_file_exists = lambda filename, bucket: bool(list(bucket.objects.filter(Prefix=filename)))
答案 10 :(得分:1)
从https://www.peterbe.com/plog/fastest-way-to-find-out-if-a-file-exists-in-s3中指出,这是最快的方法:
Invocation of init method failed; nested exception is org.hibernate.MappingException: property-ref [id1] not found on entity [example.Author]
答案 11 :(得分:1)
仅在线程之后,有人可以得出结论,哪一种是检查S3中是否存在对象的最有效方法?
我认为head_object可能会获胜,因为它只会检查比实际对象本身更浅的元数据
答案 12 :(得分:1)
您可以为此使用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!")
这里的密钥是您要检查的路径是否存在
答案 13 :(得分:1)
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
答案 14 :(得分:0)
我注意到,仅为了使用botocore.exceptions.ClientError
捕获异常,我们需要安装botocore。 botocore占用36M的磁盘空间。如果我们使用aws lambda函数,这尤其会产生影响。代替的是,如果我们只使用异常,那么我们可以跳过使用额外的库!
代码如下所示。请分享您的想法:
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)
答案 15 :(得分:0)
如果您寻找与目录等效的键,则可能需要这种方法
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
这适用于父密钥或等同于file的密钥或不存在的密钥。我尝试了上面喜欢的方法,但在父键上失败了。
答案 16 :(得分:0)
这是对我有用的解决方案。一个警告是我提前知道密钥的确切格式,所以我只列出单个文件
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."
答案 17 :(得分:0)
您可以使用S3Fs,它实际上是boto3的包装,它公开了典型的文件系统样式操作:
import s3fs
s3 = s3fs.S3FileSystem()
s3.exists('myfile.txt')
答案 18 :(得分:0)
对于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')
调用s3.Client.head_object更新ObjectSummary资源的属性。
这表明如果计划不使用ObjectSummary
,则可以使用Object
代替get()
。 load()
函数不会检索对象,而只会获取摘要。
答案 19 :(得分:0)
使用get()
方法非常简单
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 check_exists(file_key):
try:
file_details = bucket_s3.Object(file_key).get()
# print(file_details) # This line prints the file details
return True
except:
return False
print(check_exists('hello_world.txt'))
答案 20 :(得分:0)
有一种简单的方法可以检查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")
答案 21 :(得分:0)
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
答案 22 :(得分: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
答案 23 :(得分:-1)
结帐
bucket.get_key(
key_name,
headers=None,
version_id=None,
response_headers=None,
validate=True
)
检查存储桶中是否存在特定密钥。这种方法 使用HEAD请求来检查密钥的存在。返回:An Key对象的实例或None
您只需调用bucket.get_key(keyname)并检查返回的对象是否为None。