Description

aiobotocore =========== .. |ci badge| image:: https://github.com/aio-libs/aiobotocore/actions/workflows/ci-cd.yml/badge.svg?branch=main :target: https://github.com/aio-libs/aiobotocore/actions/workflows/ci-cd.yml :alt: CI status of main branch .. |pre-commit badge| image:: https://results.pre-commit.ci/badge/github/aio-libs/aiobotocore/main.svg :target: https://results.pre-commit.ci/latest/github/aio-libs/aiobotocore/main :alt: pre-commit.ci status .. |coverage badge| image:: https://codecov.io/gh/aio-libs/aiobotocore/branch/main/graph/badge.svg :target: https://codecov.io/gh/aio-libs/aiobotocore :alt: Coverage status on main branch .. |docs badge| image:: https://readthedocs.org/projects/aiobotocore/badge/?version=latest :target: https://aiobotocore.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status .. |pypi badge| image:: https://img.shields.io/pypi/v/aiobotocore.svg :target: https://pypi.python.org/pypi/aiobotocore :alt: Latest version on pypi .. |gitter badge| image:: https://badges.gitter.im/Join%20Chat.svg :target: https://gitter.im/aio-libs/aiobotocore :alt: Chat on Gitter .. |pypi downloads badge| image:: https://img.shields.io/pypi/dm/aiobotocore.svg?label=PyPI%20downloads :target: https://pypi.org/project/aiobotocore/ :alt: Downloads Last Month .. |conda badge| image:: https://img.shields.io/conda/dn/conda-forge/aiobotocore.svg?label=Conda%20downloads :target: https://anaconda.org/conda-forge/aiobotocore :alt: Conda downloads .. |stackoverflow badge| image:: https://img.shields.io/badge/stackoverflow-Ask%20questions-blue.svg :target: https://stackoverflow.com/questions/tagged/aiobotocore :alt: Stack Overflow |ci badge| |pre-commit badge| |coverage badge| |docs badge| |pypi badge| |gitter badge| |pypi downloads badge| |conda badge| |stackoverflow badge| Async client for amazon services using botocore_ and aiohttp_/asyncio_. This library is a mostly full featured asynchronous version of botocore. Install ------- :: $ pip install aiobotocore Basic Example ------------- .. code:: python import asyncio from aiobotocore.session import get_session AWS_ACCESS_KEY_ID = "xxx" AWS_SECRET_ACCESS_KEY = "xxx" async def go(): bucket = 'dataintake' filename = 'dummy.bin' folder = 'aiobotocore' key = '{}/{}'.format(folder, filename) session = get_session() async with session.create_client('s3', region_name='us-west-2', aws_secret_access_key=AWS_SECRET_ACCESS_KEY, aws_access_key_id=AWS_ACCESS_KEY_ID) as client: # upload object to amazon s3 data = b'\x01'*1024 resp = await client.put_object(Bucket=bucket, Key=key, Body=data) print(resp) # getting s3 object properties of file we just uploaded resp = await client.get_object_acl(Bucket=bucket, Key=key) print(resp) # get object from s3 response = await client.get_object(Bucket=bucket, Key=key) # this will ensure the connection is correctly re-used/closed async with response['Body'] as stream: assert await stream.read() == data # list s3 objects using paginator paginator = client.get_paginator('list_objects_v2') async for result in paginator.paginate(Bucket=bucket, Prefix=folder): for c in result.get('Contents', []): print(c) # delete object from s3 resp = await client.delete_object(Bucket=bucket, Key=key) print(resp) loop = asyncio.get_event_loop() loop.run_until_complete(go()) Context Manager Examples ------------------------ .. code:: python from contextlib import AsyncExitStack from aiobotocore.session import AioSession # How to use in existing context manager class Manager: def __init__(self): self._exit_stack = AsyncExitStack() self._s3_client = None async def __aenter__(self): session = AioSession() self._s3_client = await self._exit_stack.enter_async_context(session.create_client('s3')) async def __aexit__(self, exc_type, exc_val, exc_tb): await self._exit_stack.__aexit__(exc_type, exc_val, exc_tb) # How to use with an external exit_stack async def create_s3_client(session: AioSession, exit_stack: AsyncExitStack): # Create client and add cleanup client = await exit_stack.enter_async_context(session.create_client('s3')) return client async def non_manager_example(): session = AioSession() async with AsyncExitStack() as exit_stack: s3_client = await create_s3_client(session, exit_stack)