Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Async client for aws services using botocore and aiohttp

Project description

https://travis-ci.com/aio-libs/aiobotocore.svg?branch=master https://codecov.io/gh/aio-libs/aiobotocore/branch/master/graph/badge.svg Documentation Status https://img.shields.io/pypi/v/aiobotocore.svg Chat on Gitter

Async client for amazon services using botocore and aiohttp/asyncio.

Main purpose of this library to support amazon s3 api, but other services should work (may be with minor fixes). For now we have tested only upload/download api for s3, other users report that SQS and Dynamo services work also. More tests coming soon.

Install

$ pip install aiobotocore

Basic Example

import asyncio
import aiobotocore

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 = aiobotocore.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')
        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

from contextlib import AsyncExitStack
from typing import

import aiobotocore.session


# 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 = aiobotocore.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: aiobotocore.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 = aiobotocore.session.AioSession()

    async with AsyncExitStack() as exit_stack:
        s3_client = await create_s3_client(session, exit_stack)

        # do work with s3_client

Supported AWS Services

This is a non-exuastive list of what tests aiobotocore runs against AWS services. Not all methods are tested but we aim to test the majority of commonly used methods.

Service Status
S3 Working
DynamoDB Basic methods tested
SNS Basic methods tested
SQS Basic methods tested
CloudFormation Stack creation tested
Kinesis Basic methods tested

Due to the way boto3 is implemented, its highly likely that even if services are not listed above that you can take any boto3.client(‘service’) and stick await infront of methods to make them async, e.g. await client.list_named_queries() would asynchronous list all of the named Athena queries.

If a service is not listed here and you could do with some tests or examples feel free to raise an issue.

Run Tests

Make sure you have development requirements installed and your amazon key and secret accessible via environment variables:

$ cd aiobotocore
$ export AWS_ACCESS_KEY_ID=xxx
$ export AWS_SECRET_ACCESS_KEY=xxx
$ pipenv sync --dev

Execute tests suite:

$ py.test -v tests

Requirements

awscli

awscli depends on a single version of botocore, however aiobotocore only supports a specific range of botocore versions. To ensure you install the latest version of awscli that your specific combination or aiobotocore and botocore can support use:

pip install -U aiobotocore[awscli]

Changes

1.1.2 (2020-10-07)

  • fix AioPageIterator search method #831 (thanks @joseph-jones)

1.1.1 (2020-08-31)

  • fix s3 region redirect bug #825

1.1.0 (2020-08-18)

  • bump botocore to 1.17.44

1.0.7 (2020-06-04)

  • fix generate_db_auth_token via #816

1.0.6 (2020-06-04)

  • revert __getattr__ fix as it breaks ddtrace

1.0.5 (2020-06-03)

  • Fixed AioSession.get_service_data emit call #811 via #812
  • Fixed async __getattr__ #789 via #803

1.0.4 (2020-04-15)

  • Fixed S3 Presigned Post not being async

1.0.3 (2020-04-09)

  • Fixes typo when using credential process

1.0.2 (2020-04-05)

  • Disable Client.__getattr__ emit for now #789

1.0.1 (2020-04-01)

  • Fixed signing requests with explicit credentials

1.0.0 (2020-03-31)

  • API breaking: The result of create_client is now a required async context class
  • Credential refresh should now work
  • generate_presigned_url is now an async call along with other credential methods
  • Credentials.[access_key/secret_key/token] now raise NotImplementedError because they won’t call refresh like botocore. Instead should use get_frozen_credentials async method
  • Bump botocore and extras

0.12.0 (2020-02-23)

  • Bump botocore and extras
  • Drop support for 3.5 given we are unable to test it with moto and it will soon be unsupported
  • Remove loop parameters for Python 3.8 compliance
  • Remove deprecated AioPageIterator.next_page

0.11.1 (2020-01-03)

  • Fixed event streaming API calls like S3 Select.

0.11.0 (2019-11-12)

  • replace CaseInsensitiveDict with urllib3 equivalent #744 (thanks to inspiration from @craigmccarter and @kevchentw)
  • bump botocore to 1.13.14
  • fix for mismatched botocore method replacements

0.10.4 (2019-10-24)

  • Make AioBaseClient.close method async #724 (thanks @bsitruk)
  • Bump awscli, boto3, botocore #735 (thanks @bbrendon)
  • switch paginator to async_generator, add result_key_iters (deprecate next_page method)

0.10.3 (2019-07-17)

  • Bump botocore and extras

0.10.2 (2019-02-11)

  • Fix response-received emitted event #682

0.10.1 (2019-02-08)

  • Make tests pass with pytest 4.1 #669 (thanks @yan12125)
  • Support Python 3.7 #671 (thanks to @yan12125)
  • Update RTD build config #672 (thanks @willingc)
  • Bump to botocore 1.12.91 #679

0.10.0 (2018-12-09)

  • Update to botocore 1.12.49 #639 (thanks @terrycain)

0.9.4 (2018-08-08)

  • Add ClientPayloadError as retryable exception

0.9.3 (2018-07-16)

  • Bring botocore up to date

0.9.2 (2018-05-05)

  • bump aiohttp requirement to fix read timeouts

0.9.1 (2018-05-04)

  • fix timeout bug introduced in last release

0.9.0 (2018-06-01)

  • bump aiohttp to 3.3.x
  • remove unneeded set_socket_timeout

0.8.0 (2018-05-07)

  • Fix pagination #573 (thanks @adamrothman)
  • Enabled several s3 tests via moto
  • Bring botocore up to date

0.7.0 (2018-05-01)

  • Just version bump

0.6.1a0 (2018-05-01)

  • bump to aiohttp 3.1.x
  • switch tests to Python 3.5+
  • switch to native coroutines
  • fix non-streaming body timeout retries

0.6.0 (2018-03-04)

  • Upgrade to aiohttp>=3.0.0 #536 (thanks @Gr1N)

0.5.3 (2018-02-23)

  • Fixed waiters #523 (thanks @dalazx)
  • fix conn_timeout #485

0.5.2 (2017-12-06)

  • Updated awscli dependency #461

0.5.1 (2017-11-10)

  • Disabled compressed response #430

0.5.0 (2017-11-10)

  • Fix error botocore error checking #190
  • Update supported botocore requirement to: >=1.7.28, <=1.7.40
  • Bump aiohttp requirement to support compressed responses correctly #298

0.4.5 (2017-09-05)

  • Added SQS examples and tests #336
  • Changed requirements.txt structure #336
  • bump to botocore 1.7.4
  • Added DynamoDB examples and tests #340

0.4.4 (2017-08-16)

  • add the supported versions of boto3 to extras require #324

0.4.3 (2017-07-05)

  • add the supported versions of awscli to extras require #273 (thanks @graingert)

0.4.2 (2017-07-03)

  • update supported aiohttp requirement to: >=2.0.4, <=2.3.0
  • update supported botocore requirement to: >=1.5.71, <=1.5.78

0.4.1 (2017-06-27)

  • fix redirects #268

0.4.0 (2017-06-19)

  • update botocore requirement to: botocore>=1.5.34, <=1.5.70
  • fix read_timeout due to #245
  • implement set_socket_timeout

0.3.3 (2017-05-22)

  • switch to PEP 440 version parser to support ‘dev’ versions

0.3.2 (2017-05-22)

  • Fix botocore integration
  • Provisional fix for aiohttp 2.x stream support
  • update botocore requirement to: botocore>=1.5.34, <=1.5.52

0.3.1 (2017-04-18)

  • Fixed Waiter support

0.3.0 (2017-04-01)

  • Added support for aiohttp>=2.0.4 (thanks @achimnol)
  • update botocore requirement to: botocore>=1.5.0, <=1.5.33

0.2.3 (2017-03-22)

  • update botocore requirement to: botocore>=1.5.0, <1.5.29

0.2.2 (2017-03-07)

  • set aiobotocore.__all__ for * imports #121 (thanks @graingert)
  • fix ETag in head_object response #132

0.2.1 (2017-02-01)

  • Normalize headers and handle redirection by botocore #115 (thanks @Fedorof)

0.2.0 (2017-01-30)

  • add support for proxies (thanks @jjonek)
  • remove AioConfig verify_ssl connector_arg as this is handled by the create_client verify param
  • remove AioConfig limit connector_arg as this is now handled by by the Config max_pool_connections property (note default is 10)

0.1.1 (2017-01-16)

  • botocore updated to version 1.5.0

0.1.0 (2017-01-12)

  • Pass timeout to aiohttp.request to enforce read_timeout #86 (thanks @vharitonsky) (bumped up to next semantic version due to read_timeout enabling change)

0.0.6 (2016-11-19)

  • Added enforcement of plain response #57 (thanks @rymir)
  • botocore updated to version 1.4.73 #74 (thanks @vas3k)

0.0.5 (2016-06-01)

  • Initial alpha release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for aiobotocore, version 1.1.2
Filename, size File type Python version Upload date Hashes
Filename, size aiobotocore-1.1.2-py3-none-any.whl (45.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size aiobotocore-1.1.2.tar.gz (45.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page