types-aiobotocore-s3
![PyPI - Downloads](https://static.pepy.tech/badge/types-aiobotocore-s3)
![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
Type annotations for
aiobotocore.S3 2.14.0
service compatible with VSCode,
PyCharm,
Emacs,
Sublime Text,
mypy,
pyright and other tools.
Generated by
mypy-boto3-builder 7.26.1.
More information can be found on
types-aiobotocore page and in
types-aiobotocore-s3 docs.
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
How to install
From PyPI with pip
Install types-aiobotocore
for S3
service.
python -m pip install 'types-aiobotocore[s3]'
python -m pip install 'types-aiobotocore-lite[s3]'
python -m pip install types-aiobotocore-s3
How to uninstall
python -m pip uninstall -y types-aiobotocore-s3
Usage
VSCode
python -m pip install 'types-aiobotocore[s3]'
Both type checking and code completion should now work. No explicit type
annotations required, write your aiobotocore
code as usual.
PyCharm
Install types-aiobotocore-lite[s3]
in your environment:
python -m pip install 'types-aiobotocore-lite[s3]'`
Both type checking and code completion should now work. Explicit type
annotations are required.
Use types-aiobotocore
package instead for implicit type discovery.
Emacs
- Install
types-aiobotocore
with services you use in your environment:
python -m pip install 'types-aiobotocore[s3]'
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
- Make sure emacs uses the environment where you have installed
types-aiobotocore
Type checking should now work. No explicit type annotations required, write
your aiobotocore
code as usual.
Sublime Text
- Install
types-aiobotocore[s3]
with services you use in your environment:
python -m pip install 'types-aiobotocore[s3]'
Type checking should now work. No explicit type annotations required, write
your aiobotocore
code as usual.
Other IDEs
Not tested, but as long as your IDE supports mypy
or pyright
, everything
should work.
mypy
- Install
mypy
: python -m pip install mypy
- Install
types-aiobotocore[s3]
in your environment:
python -m pip install 'types-aiobotocore[s3]'`
Type checking should now work. No explicit type annotations required, write
your aiobotocore
code as usual.
pyright
- Install
pyright
: npm i -g pyright
- Install
types-aiobotocore[s3]
in your environment:
python -m pip install 'types-aiobotocore[s3]'
Optionally, you can install types-aiobotocore
to typings
folder.
Type checking should now work. No explicit type annotations required, write
your aiobotocore
code as usual.
Explicit type annotations
Client annotations
S3Client
provides annotations for session.create_client("s3")
.
from aiobotocore.session import get_session
from types_aiobotocore_s3 import S3Client
session = get_session()
async with session.create_client("s3") as client:
client: S3Client
Paginators annotations
types_aiobotocore_s3.paginator
module contains type annotations for all
paginators.
from aiobotocore.session import get_session
from types_aiobotocore_s3 import S3Client
from types_aiobotocore_s3.paginator import (
ListBucketsPaginator,
ListDirectoryBucketsPaginator,
ListMultipartUploadsPaginator,
ListObjectVersionsPaginator,
ListObjectsPaginator,
ListObjectsV2Paginator,
ListPartsPaginator,
)
session = get_session()
async with session.create_client("s3") as client:
client: S3Client
list_buckets_paginator: ListBucketsPaginator = client.get_paginator("list_buckets")
list_directory_buckets_paginator: ListDirectoryBucketsPaginator = client.get_paginator(
"list_directory_buckets"
)
list_multipart_uploads_paginator: ListMultipartUploadsPaginator = client.get_paginator(
"list_multipart_uploads"
)
list_object_versions_paginator: ListObjectVersionsPaginator = client.get_paginator(
"list_object_versions"
)
list_objects_paginator: ListObjectsPaginator = client.get_paginator("list_objects")
list_objects_v2_paginator: ListObjectsV2Paginator = client.get_paginator("list_objects_v2")
list_parts_paginator: ListPartsPaginator = client.get_paginator("list_parts")
Waiters annotations
types_aiobotocore_s3.waiter
module contains type annotations for all waiters.
from aiobotocore.session import get_session
from types_aiobotocore_s3.client import S3Client
from types_aiobotocore_s3.waiter import (
BucketExistsWaiter,
BucketNotExistsWaiter,
ObjectExistsWaiter,
ObjectNotExistsWaiter,
)
session = get_session()
async with session.create_client("s3") as client:
client: S3Client
bucket_exists_waiter: BucketExistsWaiter = client.get_waiter("bucket_exists")
bucket_not_exists_waiter: BucketNotExistsWaiter = client.get_waiter("bucket_not_exists")
object_exists_waiter: ObjectExistsWaiter = client.get_waiter("object_exists")
object_not_exists_waiter: ObjectNotExistsWaiter = client.get_waiter("object_not_exists")
Service Resource annotations
S3ServiceResource
provides annotations for aiobotocore.resource("s3")
.
from aiobotocore.session import get_session
from types_aiobotocore_s3 import S3ServiceResource
session = get_session()
async with session.resource("s3") as resource:
resource: S3ServiceResource
Other resources annotations
types_aiobotocore_s3.service_resource
module contains type annotations for
all resources.
from aiobotocore.session import get_session
from types_aiobotocore_s3 import S3ServiceResource
from types_aiobotocore_s3.service_resource import (
Bucket,
BucketAcl,
BucketCors,
BucketLifecycle,
BucketLifecycleConfiguration,
BucketLogging,
BucketNotification,
BucketPolicy,
BucketRequestPayment,
BucketTagging,
BucketVersioning,
BucketWebsite,
MultipartUpload,
MultipartUploadPart,
Object,
ObjectAcl,
ObjectSummary,
ObjectVersion,
)
session = get_session()
async with session.resource("s3") as resource:
resource: S3ServiceResource
my_bucket: Bucket = resource.Bucket(...)
my_bucket_acl: BucketAcl = resource.BucketAcl(...)
my_bucket_cors: BucketCors = resource.BucketCors(...)
my_bucket_lifecycle: BucketLifecycle = resource.BucketLifecycle(...)
my_bucket_lifecycle_configuration: BucketLifecycleConfiguration = (
resource.BucketLifecycleConfiguration(...)
)
my_bucket_logging: BucketLogging = resource.BucketLogging(...)
my_bucket_notification: BucketNotification = resource.BucketNotification(...)
my_bucket_policy: BucketPolicy = resource.BucketPolicy(...)
my_bucket_request_payment: BucketRequestPayment = resource.BucketRequestPayment(...)
my_bucket_tagging: BucketTagging = resource.BucketTagging(...)
my_bucket_versioning: BucketVersioning = resource.BucketVersioning(...)
my_bucket_website: BucketWebsite = resource.BucketWebsite(...)
my_multipart_upload: MultipartUpload = resource.MultipartUpload(...)
my_multipart_upload_part: MultipartUploadPart = resource.MultipartUploadPart(...)
my_object: Object = resource.Object(...)
my_object_acl: ObjectAcl = resource.ObjectAcl(...)
my_object_summary: ObjectSummary = resource.ObjectSummary(...)
my_object_version: ObjectVersion = resource.ObjectVersion(...)
Collections annotations
types_aiobotocore_s3.service_resource
module contains type annotations for
all S3ServiceResource
collections.
from aiobotocore.session import get_session
from types_aiobotocore_s3 import S3ServiceResource
from types_aiobotocore_s3.service_resource import ServiceResourceBucketsCollection
session = get_session()
async with session.resource("s3") as resource:
resource: S3ServiceResource
buckets: s3_resources.ServiceResourceBucketsCollection = resource.buckets
Literals
types_aiobotocore_s3.literals
module contains literals extracted from shapes
that can be used in user code for type checking.
Full list of S3
Literals can be found in
docs.
from types_aiobotocore_s3.literals import AnalyticsS3ExportFileFormatType
def check_value(value: AnalyticsS3ExportFileFormatType) -> bool: ...
Type definitions
types_aiobotocore_s3.type_defs
module contains structures and shapes
assembled to typed dictionaries and unions for additional type checking.
Full list of S3
TypeDefs can be found in
docs.
from types_aiobotocore_s3.type_defs import AbortIncompleteMultipartUploadTypeDef
def get_value() -> AbortIncompleteMultipartUploadTypeDef:
return {...}
How it works
Fully automated
mypy-boto3-builder carefully
generates type annotations for each service, patiently waiting for
aiobotocore
updates. It delivers drop-in type annotations for you and makes
sure that:
- All available
aiobotocore
services are covered. - Each public class and method of every
aiobotocore
service gets valid type
annotations extracted from botocore
schemas. - Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by black and
isort for readability.
What's new
Implemented features
- Fully type annotated
boto3
, botocore
, aiobotocore
and aioboto3
libraries mypy
, pyright
, VSCode
, PyCharm
, Sublime Text
and Emacs
compatibilityClient
, ServiceResource
, Resource
, Waiter
Paginator
type
annotations for each service- Generated
TypeDefs
for each service - Generated
Literals
for each service - Auto discovery of types for
boto3.client
and boto3.resource
calls - Auto discovery of types for
session.client
and session.resource
calls - Auto discovery of types for
client.get_waiter
and client.get_paginator
calls - Auto discovery of types for
ServiceResource
and Resource
collections - Auto discovery of types for
aiobotocore.Session.create_client
calls
Latest changes
Builder changelog can be found in
Releases.
Versioning
types-aiobotocore-s3
version is the same as related aiobotocore
version and
follows PEP 440 format.
Thank you
Documentation
All services type annotations can be found in
aiobotocore docs
Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in mypy-boto3-builder
repository.