从boto3检索S3存储桶中的子文件夹名称


85

使用boto3,我可以访问我的AWS S3存储桶:

s3 = boto3.resource('s3')
bucket = s3.Bucket('my-bucket-name')

现在,存储桶包含文件夹first-level,例如,文件夹本身包含几个带有时间戳的子文件夹1456753904534。我需要知道这些子文件夹的名称来执行我的另一项工作,我想知道是否可以让boto3为我检索这些子文件夹。

所以我尝试了:

objs = bucket.meta.client.list_objects(Bucket='my-bucket-name')

它提供了一个字典,其键“目录”为我提供了所有第三级文件,而不是第二级时间戳目录,实际上,我得到了一个包含以下内容的列表:

{u'ETag':'“ etag”',u'Key':一级/ 1456753904534 / part-00014',u'LastModified':datetime.datetime(2016,2,29,13,52,24,tzinfo = tzutc()),
u'所有者':{u'DisplayName':'所有者',u'ID':'id'},
u'Size':大小,u'StorageClass':'storageclass'}

您可以看到在这种情况下part-00014已检索到特定文件,而我想单独获取目录的名称。原则上,我可以从所有路径中删除目录名称,但是在第三级检索所有内容以得到第二级是很丑陋且昂贵的!

我也尝试过这里的报道:

for o in bucket.objects.filter(Delimiter='/'):
    print(o.key)

但是我没有得到所需级别的文件夹。

有办法解决吗?


所以您是说行不通吗?您可以发布运行该命令后会发生什么情况吗?
乔登·菲利普斯

1
@JordonPhillips我尝试了您发送的链接的前几行,并将其粘贴到此处,并且我在存储桶的第一级获得了文本文件,没有文件夹。
tin

@mar tin您是否解决了此问题。我面临着类似的难题,在每个存储分区子文件夹中都需要第一个元素。
泰德·泰勒

1
@TedTaylorofLife是的,除了获取所有对象并拆分/以获取子文件夹外,别无其他方法
Tin

1
@ mar tin我唯一要做的方法是将输出结果输出,将其扔成文本格式,并用“ /”逗号分隔,然后复制并粘贴第一个元素。屁股好痛。
泰德·泰勒

Answers:


56

S3是一个对象存储,它没有真实的目录结构。“ /”相当美观。人们之所以拥有目录结构是因为他们可以维护/修剪/向应用程序添加树。对于S3,您将这种结构视为索引或搜索标签的一种。

要在S3中操作对象,您需要boto3.client或boto3.resource,例如,列出所有对象

import boto3 
s3 = boto3.client("s3")
all_objects = s3.list_objects(Bucket = 'bucket-name') 

http://boto3.readthedocs.org/en/latest/reference/services/s3.html#S3.Client.list_objects

实际上,如果s3对象名称是使用'/'分隔符存储的。最新版本的list_objects(list_objects_v2)允许您将响应限制为以指定前缀开头的键。

要将项目限制为某些子文件夹下的项目:

    import boto3 
    s3 = boto3.client("s3")
    response = s3.list_objects_v2(
            Bucket=BUCKET,
            Prefix ='DIR1/DIR2',
            MaxKeys=100 )

文献资料

另一个选择是使用python os.path函数提取文件夹前缀。问题是这将需要列出不需要目录中的对象。

import os
s3_key = 'first-level/1456753904534/part-00014'
filename = os.path.basename(s3_key) 
foldername = os.path.dirname(s3_key)

# if you are not using conventional delimiter like '#' 
s3_key = 'first-level#1456753904534#part-00014
filename = s3_key.split("#")[-1]

关于boto3的提醒:boto3.resource是一个不错的高级API。使用boto3.client与boto3.resource有优缺点。如果您开发内部共享库,则使用boto3.resource将在使用的资源上为您提供一个黑盒层。


1
这给了我尝试该问题时得到的相同结果。我想我必须通过从返回的对象中获取所有键并拆分字符串以获取文件夹名称来解决这一难题。
mar tin

1
@martina:一个懒惰的python拆分并获取列表中的最后一个数据,例如filename = keyname.split(“ /”)[-1]
mootmoot

1
@martindirectory_name = os.path.dirname(directory/path/and/filename.txt)file_name = os.path.basename(directory/path/and/filename.txt)
jkdev,

105

下面的代码仅返回s3存储桶中“文件夹”中的“子文件夹”。

import boto3
bucket = 'my-bucket'
#Make sure you provide / in the end
prefix = 'prefix-name-with-slash/'  

client = boto3.client('s3')
result = client.list_objects(Bucket=bucket, Prefix=prefix, Delimiter='/')
for o in result.get('CommonPrefixes'):
    print 'sub folder : ', o.get('Prefix')

有关更多详细信息,请参阅https://github.com/boto/boto3/issues/134


12
如果我想列出特定子文件夹的内容怎么办?
azhar22k

1
@ azhar22k,我假设您可以为每个“子文件夹”递归运行该函数。
Serban Cezar

如果有超过1000个不同的前缀怎么办?
Kostrahb

38

我花了很多时间弄清楚,但是最后这是一种使用boto3在S3存储桶中列出子文件夹内容的简单方法。希望能帮助到你

prefix = "folderone/foldertwo/"
s3 = boto3.resource('s3')
bucket = s3.Bucket(name="bucket_name_here")
FilesNotFound = True
for obj in bucket.objects.filter(Prefix=prefix):
     print('{0}:{1}'.format(bucket.name, obj.key))
     FilesNotFound = False
if FilesNotFound:
     print("ALERT", "No file in {0}/{1}".format(bucket, prefix))

3
如果您的文件夹包含大量对象怎么办?
Pierre D

3
我的观点是,这是一个极其低效的解决方案。S3用于处理键中的任意分隔符。例如,'/'。这样一来,您就可以跳过充满对象的“文件夹”,而不必在它们上进行分页。然后,即使您坚持要列出完整的列表(即aws cli中的“递归”等效项),也必须使用分页器,否则您将仅列出前1000个对象。
Pierre D

这是一个很好的答案。对于那些需要它的人,我limit派生答案中将其应用于。
Acumenus

38

简短答案

  • 使用Delimiter='/'。这样可以避免对存储桶进行递归列出。这里的一些答案错误地建议进行完整列表并使用一些字符串操作来检索目录名称。这可能是非常低效的。请记住,S3实际上对存储桶可以包含的对象数量没有限制。因此,想象一下,在bar/和之间foo/,您有一万亿个对象:您将等待很长时间才能获得['bar/', 'foo/']

  • 使用Paginators。出于相同的原因(S3是工程师对无穷大的近似值),必须逐页列出,并避免将所有列表存储在内存中。而是将您的“侦听器”视为迭代器,并处理其产生的流。

  • 使用boto3.client,而不是boto3.resource。该resource版本似乎不能很好地处理该Delimiter选项。如果您有资源,说a bucket = boto3.resource('s3').Bucket(name),则可以通过以下方式获取相应的客户端bucket.meta.client

长答案

以下是我用于简单存储桶的迭代器(无版本处理)。

import boto3
from collections import namedtuple
from operator import attrgetter


S3Obj = namedtuple('S3Obj', ['key', 'mtime', 'size', 'ETag'])


def s3list(bucket, path, start=None, end=None, recursive=True, list_dirs=True,
           list_objs=True, limit=None):
    """
    Iterator that lists a bucket's objects under path, (optionally) starting with
    start and ending before end.

    If recursive is False, then list only the "depth=0" items (dirs and objects).

    If recursive is True, then list recursively all objects (no dirs).

    Args:
        bucket:
            a boto3.resource('s3').Bucket().
        path:
            a directory in the bucket.
        start:
            optional: start key, inclusive (may be a relative path under path, or
            absolute in the bucket)
        end:
            optional: stop key, exclusive (may be a relative path under path, or
            absolute in the bucket)
        recursive:
            optional, default True. If True, lists only objects. If False, lists
            only depth 0 "directories" and objects.
        list_dirs:
            optional, default True. Has no effect in recursive listing. On
            non-recursive listing, if False, then directories are omitted.
        list_objs:
            optional, default True. If False, then directories are omitted.
        limit:
            optional. If specified, then lists at most this many items.

    Returns:
        an iterator of S3Obj.

    Examples:
        # set up
        >>> s3 = boto3.resource('s3')
        ... bucket = s3.Bucket(name)

        # iterate through all S3 objects under some dir
        >>> for p in s3ls(bucket, 'some/dir'):
        ...     print(p)

        # iterate through up to 20 S3 objects under some dir, starting with foo_0010
        >>> for p in s3ls(bucket, 'some/dir', limit=20, start='foo_0010'):
        ...     print(p)

        # non-recursive listing under some dir:
        >>> for p in s3ls(bucket, 'some/dir', recursive=False):
        ...     print(p)

        # non-recursive listing under some dir, listing only dirs:
        >>> for p in s3ls(bucket, 'some/dir', recursive=False, list_objs=False):
        ...     print(p)
"""
    kwargs = dict()
    if start is not None:
        if not start.startswith(path):
            start = os.path.join(path, start)
        # note: need to use a string just smaller than start, because
        # the list_object API specifies that start is excluded (the first
        # result is *after* start).
        kwargs.update(Marker=__prev_str(start))
    if end is not None:
        if not end.startswith(path):
            end = os.path.join(path, end)
    if not recursive:
        kwargs.update(Delimiter='/')
        if not path.endswith('/'):
            path += '/'
    kwargs.update(Prefix=path)
    if limit is not None:
        kwargs.update(PaginationConfig={'MaxItems': limit})

    paginator = bucket.meta.client.get_paginator('list_objects')
    for resp in paginator.paginate(Bucket=bucket.name, **kwargs):
        q = []
        if 'CommonPrefixes' in resp and list_dirs:
            q = [S3Obj(f['Prefix'], None, None, None) for f in resp['CommonPrefixes']]
        if 'Contents' in resp and list_objs:
            q += [S3Obj(f['Key'], f['LastModified'], f['Size'], f['ETag']) for f in resp['Contents']]
        # note: even with sorted lists, it is faster to sort(a+b)
        # than heapq.merge(a, b) at least up to 10K elements in each list
        q = sorted(q, key=attrgetter('key'))
        if limit is not None:
            q = q[:limit]
            limit -= len(q)
        for p in q:
            if end is not None and p.key >= end:
                return
            yield p


def __prev_str(s):
    if len(s) == 0:
        return s
    s, c = s[:-1], ord(s[-1])
    if c > 0:
        s += chr(c - 1)
    s += ''.join(['\u7FFF' for _ in range(10)])
    return s

测试

以下是有助于测试的行为paginatorlist_objects。它会创建许多目录和文件。由于页面最多可包含1000个条目,因此对于目录和文件,我们使用其倍数。dirs仅包含目录(每个目录都有一个对象)。mixed包含目录和对象的混合,每个目录的比率为2个对象(当然,目录下还有一个对象; S3仅存储对象)。

import concurrent
def genkeys(top='tmp/test', n=2000):
    for k in range(n):
        if k % 100 == 0:
            print(k)
        for name in [
            os.path.join(top, 'dirs', f'{k:04d}_dir', 'foo'),
            os.path.join(top, 'mixed', f'{k:04d}_dir', 'foo'),
            os.path.join(top, 'mixed', f'{k:04d}_foo_a'),
            os.path.join(top, 'mixed', f'{k:04d}_foo_b'),
        ]:
            yield name


with concurrent.futures.ThreadPoolExecutor(max_workers=32) as executor:
    executor.map(lambda name: bucket.put_object(Key=name, Body='hi\n'.encode()), genkeys())

结果结构为:

./dirs/0000_dir/foo
./dirs/0001_dir/foo
./dirs/0002_dir/foo
...
./dirs/1999_dir/foo
./mixed/0000_dir/foo
./mixed/0000_foo_a
./mixed/0000_foo_b
./mixed/0001_dir/foo
./mixed/0001_foo_a
./mixed/0001_foo_b
./mixed/0002_dir/foo
./mixed/0002_foo_a
./mixed/0002_foo_b
...
./mixed/1999_dir/foo
./mixed/1999_foo_a
./mixed/1999_foo_b

通过对上面给出的代码进行一点点s3list检查,以检查来自的响应paginator,您可以观察到一些有趣的事实:

  • Marker是真的排斥。GivenMarker=topdir + 'mixed/0500_foo_a'将使列表从该键之后开始(根据AmazonS3 API),即使用.../mixed/0500_foo_b。这就是的原因__prev_str()

  • Delimiter列出时mixed/,使用,每个响应都paginator包含666个键和334个公共前缀。它很擅长不做出巨大的回应。

  • 相反,在列出时dirs/,来自的每个响应都paginator包含1000个公共前缀(且没有键)。

  • 以限制形式传递PaginationConfig={'MaxItems': limit}限制仅限制键的数量,而不限制公共前缀。我们通过进一步截断迭代器流来解决这个问题。


@Mehdi:对于一个提供如此令人难以置信的规模和可靠性的系统来说,它确实不是很复杂。如果您处理的容量超过数百TB,您将对它们提供的功能有所赞赏。记住,驱动器的MTBF总是> 0 ...考虑一下大规模数据存储的含义。免责声明:我是一个活跃且快乐的AWS用户,没有其他联系,除了自2007年以来我就一直在处理PB级数据外,这曾经很难。
Pierre D

16

S3的最大实现是没有文件夹/目录,只有键。该表观文件夹结构只是前置到文件名,成为“关键”,所以列表的内容myBucketsome/path/to/the/file/,你可以试试:

s3 = boto3.client('s3')
for obj in s3.list_objects_v2(Bucket="myBucket", Prefix="some/path/to/the/file/")['Contents']:
    print(obj['Key'])

这会给你类似的东西:

some/path/to/the/file/yo.jpg
some/path/to/the/file/meAndYou.gif
...

这是一个很好的答案,但是最多只能检索1000个对象。我产生了一个派生的答案,它可以检索更多的对象。
Acumenus

是的,@ Acumenus我想您的答案会更复杂
CpILL

16

我遇到了同样的问题,但是设法使用boto3.clientandlist_objects_v2BucketandStartAfter参数解决了这个问题。

s3client = boto3.client('s3')
bucket = 'my-bucket-name'
startAfter = 'firstlevelFolder/secondLevelFolder'

theobjects = s3client.list_objects_v2(Bucket=bucket, StartAfter=startAfter )
for object in theobjects['Contents']:
    print object['Key']

上面代码的输出结果将显示以下内容:

firstlevelFolder/secondLevelFolder/item1
firstlevelFolder/secondLevelFolder/item2

Boto3 list_objects_v2文档

为了只删除目录名称,secondLevelFolder我只使用了python方法split()

s3client = boto3.client('s3')
bucket = 'my-bucket-name'
startAfter = 'firstlevelFolder/secondLevelFolder'

theobjects = s3client.list_objects_v2(Bucket=bucket, StartAfter=startAfter )
for object in theobjects['Contents']:
    direcoryName = object['Key'].encode("string_escape").split('/')
    print direcoryName[1]

上面代码的输出结果将显示以下内容:

secondLevelFolder
secondLevelFolder

Python split()文档

如果要获取目录名称和内容项名称,请使用以下内容替换打印行:

print "{}/{}".format(fileName[1], fileName[2])

并且将输出以下内容:

secondLevelFolder/item2
secondLevelFolder/item2

希望这可以帮助


8

以下对我有用... S3对象:

s3://bucket/
    form1/
       section11/
          file111
          file112
       section12/
          file121
    form2/
       section21/
          file211
          file112
       section22/
          file221
          file222
          ...
      ...
   ...

使用:

from boto3.session import Session
s3client = session.client('s3')
resp = s3client.list_objects(Bucket=bucket, Prefix='', Delimiter="/")
forms = [x['Prefix'] for x in resp['CommonPrefixes']] 

我们得到:

form1/
form2/
...

带有:

resp = s3client.list_objects(Bucket=bucket, Prefix='form1/', Delimiter="/")
sections = [x['Prefix'] for x in resp['CommonPrefixes']] 

我们得到:

form1/section11/
form1/section12/

6

运行时,AWS cli会执行此操作(大概无需获取和迭代存储桶中的所有键)aws s3 ls s3://my-bucket/,因此我认为必须有一种使用boto3的方法。

https://github.com/aws/aws-cli/blob/0fedc4c1b6a7aee13e2ed10c3ada778c702c22c3/awscli/customizations/s3/subcommands.py#L499

看起来他们确实使用了Prefix和Delimiter-我能够编写一个函数,通过稍微修改一下代码,就可以在存储桶的根级别获得所有目录:

def list_folders_in_bucket(bucket):
    paginator = boto3.client('s3').get_paginator('list_objects')
    folders = []
    iterator = paginator.paginate(Bucket=bucket, Prefix='', Delimiter='/', PaginationConfig={'PageSize': None})
    for response_data in iterator:
        prefixes = response_data.get('CommonPrefixes', [])
        for prefix in prefixes:
            prefix_name = prefix['Prefix']
            if prefix_name.endswith('/'):
                folders.append(prefix_name.rstrip('/'))
    return folders

2

这是一个可能的解决方案:

def download_list_s3_folder(my_bucket,my_folder):
    import boto3
    s3 = boto3.client('s3')
    response = s3.list_objects_v2(
        Bucket=my_bucket,
        Prefix=my_folder,
        MaxKeys=1000)
    return [item["Key"] for item in response['Contents']]

1

使用 boto3.resource

这是基于itz-azhar回答,以应用可选的limit。它显然比该boto3.client版本使用起来简单得多。

import logging
from typing import List, Optional

import boto3
from boto3_type_annotations.s3 import ObjectSummary  # pip install boto3_type_annotations

log = logging.getLogger(__name__)
_S3_RESOURCE = boto3.resource("s3")

def s3_list(bucket_name: str, prefix: str, *, limit: Optional[int] = None) -> List[ObjectSummary]:
    """Return a list of S3 object summaries."""
    # Ref: https://stackoverflow.com/a/57718002/
    return list(_S3_RESOURCE.Bucket(bucket_name).objects.limit(count=limit).filter(Prefix=prefix))


if __name__ == "__main__":
    s3_list("noaa-gefs-pds", "gefs.20190828/12/pgrb2a", limit=10_000)

使用 boto3.client

这将使用CpILLlist_objects_v2答案并以此为基础,以允许检索1000多个对象。

import logging
from typing import cast, List

import boto3

log = logging.getLogger(__name__)
_S3_CLIENT = boto3.client("s3")

def s3_list(bucket_name: str, prefix: str, *, limit: int = cast(int, float("inf"))) -> List[dict]:
    """Return a list of S3 object summaries."""
    # Ref: https://stackoverflow.com/a/57718002/
    contents: List[dict] = []
    continuation_token = None
    if limit <= 0:
        return contents
    while True:
        max_keys = min(1000, limit - len(contents))
        request_kwargs = {"Bucket": bucket_name, "Prefix": prefix, "MaxKeys": max_keys}
        if continuation_token:
            log.info(  # type: ignore
                "Listing %s objects in s3://%s/%s using continuation token ending with %s with %s objects listed thus far.",
                max_keys, bucket_name, prefix, continuation_token[-6:], len(contents))  # pylint: disable=unsubscriptable-object
            response = _S3_CLIENT.list_objects_v2(**request_kwargs, ContinuationToken=continuation_token)
        else:
            log.info("Listing %s objects in s3://%s/%s with %s objects listed thus far.", max_keys, bucket_name, prefix, len(contents))
            response = _S3_CLIENT.list_objects_v2(**request_kwargs)
        assert response["ResponseMetadata"]["HTTPStatusCode"] == 200
        contents.extend(response["Contents"])
        is_truncated = response["IsTruncated"]
        if (not is_truncated) or (len(contents) >= limit):
            break
        continuation_token = response["NextContinuationToken"]
    assert len(contents) <= limit
    log.info("Returning %s objects from s3://%s/%s.", len(contents), bucket_name, prefix)
    return contents


if __name__ == "__main__":
    s3_list("noaa-gefs-pds", "gefs.20190828/12/pgrb2a", limit=10_000)

0

首先,S3中没有真正的文件夹概念。您绝对可以拥有一个文件@'/folder/subfolder/myfile.txt',没有文件夹或子文件夹。

要在S3中“模拟”文件夹,您必须创建一个空文件,文件名末尾带有'/'(请参阅Amazon S3 boto-如何创建文件夹?

对于您的问题,您可能应该使用get_all_keys带有2个参数的方法:prefixdelimiter

https://github.com/boto/boto/blob/develop/boto/s3/bucket.py#L427

for key in bucket.get_all_keys(prefix='first-level/', delimiter='/'):
    print(key.name)

1
恐怕我在bucket对象上没有get_all_keys方法。我正在使用boto3版本1.2.3。
2016年

刚刚检查了boto 1.2a:此处,bucket有一个list使用prefix和方法delimiter。我想它应该起作用。
Pirheas

1
我在问题中发布时检索到的Bucket对象没有那些方法。我在boto3 1.2.6上,您的链接引用的是哪个版本?
三月锡


0

我知道boto3是这里讨论的主题,但是我发现简单地使用awscli通常更快,更直观用于这样的事情-awscli保留了boto3的更多功能,而不是有价值的功能。

例如,如果我将对象保存在与给定存储桶关联的“子文件夹”中,则可以使用以下内容将它们全部列出:

1)'mydata'=存储桶名称

2)'f1 / f2 / f3'=导致“文件”或对象的“路径”

3)'foo2.csv,barfar.segy,gar.tar'=所有“在” f3内部的对象

因此,我们可以想到导致这些对象的“绝对路径”是:'mydata / f1 / f2 / f3 / foo2.csv'...

使用awscli命令,我们可以通过以下方式轻松列出给定“子文件夹”内的所有对象:

aws s3 ls s3:// mydata / f1 / f2 / f3 /-递归


0

如果您尝试获取大量的S3存储桶对象,则以下是可以处理分页的代码:

def get_matching_s3_objects(bucket, prefix="", suffix=""):

    s3 = boto3.client("s3")
    paginator = s3.get_paginator("list_objects_v2")

    kwargs = {'Bucket': bucket}

    # We can pass the prefix directly to the S3 API.  If the user has passed
    # a tuple or list of prefixes, we go through them one by one.
    if isinstance(prefix, str):
        prefixes = (prefix, )
    else:
        prefixes = prefix

    for key_prefix in prefixes:
        kwargs["Prefix"] = key_prefix

        for page in paginator.paginate(**kwargs):
            try:
                contents = page["Contents"]
            except KeyError:
                return

            for obj in contents:
                key = obj["Key"]
                if key.endswith(suffix):
                    yield obj

0

至于Boto 1.13.3,它就变得如此简单(如果您跳过所有分页注意事项,其他答案都涵盖了该问题):

def get_sub_paths(bucket, prefix):
s3 = boto3.client('s3')
response = s3.list_objects_v2(
    Bucket=bucket,
    Prefix=prefix,
    MaxKeys=1000)
return [item["Prefix"] for item in response['CommonPrefixes']]
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.