短い答え:
を使用しDelimiter='/'
ます。これにより、バケットの再帰的なリストを作成する必要がなくなります。ここでのいくつかの回答は、完全なリストを作成し、文字列操作を使用してディレクトリ名を取得することを誤って示唆しています。これはひどく非効率的かもしれません。S3には、バケットに含めることができるオブジェクトの数に事実上制限がないことに注意してください。したがって、との間に1兆個のオブジェクトがあるbar/
と想像してください。foo/
取得するには、非常に長い時間がかかります['bar/', 'foo/']
。
を使用しPaginators
ます。同じ理由で(S3はエンジニアによる無限大の近似値です)、ページを介してリストし、すべてのリストをメモリに保存しないようにする必要があります。代わりに、「リスター」をイテレーターと見なし、それが生成するストリームを処理します。
boto3.client
ではなく、を使用してくださいboto3.resource
。resource
バージョンはうまく対処していないようDelimiter
オプションを選択します。リソース、たとえば、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)
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']]
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
テスト:
以下は、paginator
との動作をテストするのに役立ちますlist_objects
。それは多くのdirとファイルを作成します。ページは最大1000エントリであるため、dirとファイルにはその倍数を使用します。dirs
ディレクトリのみが含まれます(それぞれに1つのオブジェクトがあります)。mixed
dirとオブジェクトの組み合わせが含まれ、各dirに2つのオブジェクトの比率があります(もちろん、dirの下に1つのオブジェクトがあります。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
本当に排他的です。与えられたことはMarker=topdir + 'mixed/0500_foo_a'
リストの開始を行います後(につきとしてそのキーAmazonS3のAPIで、すなわち、) .../mixed/0500_foo_b
。それが理由です__prev_str()
。
を使用Delimiter
してリストする場合mixed/
、からの各応答にpaginator
は666個のキーと334個の共通プレフィックスが含まれます。膨大な応答を構築しないのはかなり得意です。
対照的に、リストする場合dirs/
、からの各応答にpaginator
は1000個の共通プレフィックスが含まれます(キーは含まれません)。
制限の形式でPaginationConfig={'MaxItems': limit}
制限を渡すと、共通のプレフィックスではなく、キーの数のみが制限されます。イテレータのストリームをさらに切り捨てることで、これに対処します。