Package: types-aiobotocore-s3
types-aiobotocore-s3Type annotations foraiobotocore.S3 2.12.0service compatible withVSCode,PyCharm,Emacs,Sublime Text,mypy,pyrightand other tools.Generated bymypy-boto3-builder 7.23.2.More information can be found ontypes-aiobotocorepage and intypes-aiobotocore-s3 docs.See how it helps to find and fix potential bugs:types-aiobotocore-s3How to installFrom PyPI with pipHow to uninstallUsageVSCodePyCharmEmacsSublime TextOther IDEsmypypyrightExplicit type annotationsClient annotationsPaginators annotationsWaiters annotationsService Resource annotationsOther resources annotationsCollections annotationsLiteralsType definitionsHow it worksWhat's newImplemented featuresLatest changesVersioningThank youDocumentationSupport and contributingHow to installFrom PyPI with pipInstalltypes-aiobotocoreforS3service.# install with aiobotocore type annotationspython-mpipinstall'types-aiobotocore[s3]'# Lite version does not provide session.client/resource overloads# it is more RAM-friendly, but requires explicit type annotationspython-mpipinstall'types-aiobotocore-lite[s3]'# standalone installationpython-mpipinstalltypes-aiobotocore-s3How to uninstallpython-mpipuninstall-ytypes-aiobotocore-s3UsageVSCodeInstallPython extensionInstallPylance extensionSetPylanceas your Python Language ServerInstalltypes-aiobotocore[s3]in your environment:python-mpipinstall'types-aiobotocore[s3]'Both type checking and code completion should now work. No explicit type
annotations required, write youraiobotocorecode as usual.PyCharmInstalltypes-aiobotocore-lite[s3]in your environment:python-mpipinstall'types-aiobotocore-lite[s3]'`Both type checking and code completion should now work. Explicit type
annotationsare required.Usetypes-aiobotocorepackage instead for implicit type discovery.EmacsInstalltypes-aiobotocorewith services you use in your environment:python-mpipinstall'types-aiobotocore[s3]'Installuse-package,lsp,companyandflycheckpackagesInstalllsp-pyrightpackage(use-packagelsp-pyright:ensuret:hook(python-mode.(lambda()(require'lsp-pyright)(lsp))); or lsp-deferred:init(when(executable-find"python3")(setqlsp-pyright-python-executable-cmd"python3")))Make sure emacs uses the environment where you have installedtypes-aiobotocoreType checking should now work. No explicit type annotations required, write
youraiobotocorecode as usual.Sublime TextInstalltypes-aiobotocore[s3]with services you use in your environment:python-mpipinstall'types-aiobotocore[s3]'InstallLSP-pyrightpackageType checking should now work. No explicit type annotations required, write
youraiobotocorecode as usual.Other IDEsNot tested, but as long as your IDE supportsmypyorpyright, everything
should work.mypyInstallmypy:python -m pip install mypyInstalltypes-aiobotocore[s3]in your environment:python-mpipinstall'types-aiobotocore[s3]'`Type checking should now work. No explicit type annotations required, write
youraiobotocorecode as usual.pyrightInstallpyright:npm i -g pyrightInstalltypes-aiobotocore[s3]in your environment:python-mpipinstall'types-aiobotocore[s3]'Optionally, you can installtypes-aiobotocoretotypingsfolder.Type checking should now work. No explicit type annotations required, write
youraiobotocorecode as usual.Explicit type annotationsClient annotationsS3Clientprovides annotations forsession.create_client("s3").fromaiobotocore.sessionimportget_sessionfromtypes_aiobotocore_s3importS3Clientsession=get_session()asyncwithsession.create_client("s3")asclient:client:S3Client# now client usage is checked by mypy and IDE should provide code completionPaginators annotationstypes_aiobotocore_s3.paginatormodule contains type annotations for all
paginators.fromaiobotocore.sessionimportget_sessionfromtypes_aiobotocore_s3importS3Clientfromtypes_aiobotocore_s3.paginatorimport(ListDirectoryBucketsPaginator,ListMultipartUploadsPaginator,ListObjectVersionsPaginator,ListObjectsPaginator,ListObjectsV2Paginator,ListPartsPaginator,)session=get_session()asyncwithsession.create_client("s3")asclient:client:S3Client# Explicit type annotations are optional here# Types should be correctly discovered by mypy and IDEslist_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 annotationstypes_aiobotocore_s3.waitermodule contains type annotations for all waiters.fromaiobotocore.sessionimportget_sessionfromtypes_aiobotocore_s3.clientimportS3Clientfromtypes_aiobotocore_s3.waiterimport(BucketExistsWaiter,BucketNotExistsWaiter,ObjectExistsWaiter,ObjectNotExistsWaiter,)session=get_session()asyncwithsession.create_client("s3")asclient:client:S3Client# Explicit type annotations are optional here# Types should be correctly discovered by mypy and IDEsbucket_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 annotationsS3ServiceResourceprovides annotations foraiobotocore.resource("s3").fromaiobotocore.sessionimportget_sessionfromtypes_aiobotocore_s3importS3ServiceResourcesession=get_session()asyncwithsession.resource("s3")asresource:resource:S3ServiceResource# now resource usage is checked by mypy and IDE should provide code completionOther resources annotationstypes_aiobotocore_s3.service_resourcemodule contains type annotations for
all resources.fromaiobotocore.sessionimportget_sessionfromtypes_aiobotocore_s3importS3ServiceResourcefromtypes_aiobotocore_s3.service_resourceimport(Bucket,BucketAcl,BucketCors,BucketLifecycle,BucketLifecycleConfiguration,BucketLogging,BucketNotification,BucketPolicy,BucketRequestPayment,BucketTagging,BucketVersioning,BucketWebsite,MultipartUpload,MultipartUploadPart,Object,ObjectAcl,ObjectSummary,ObjectVersion,)session=get_session()asyncwithsession.resource("s3")asresource:resource:S3ServiceResource# Explicit type annotations are optional here# Type should be correctly discovered by mypy and IDEsmy_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 annotationstypes_aiobotocore_s3.service_resourcemodule contains type annotations for
allS3ServiceResourcecollections.fromaiobotocore.sessionimportget_sessionfromtypes_aiobotocore_s3importS3ServiceResourcefromtypes_aiobotocore_s3.service_resourceimportServiceResourceBucketsCollectionsession=get_session()asyncwithsession.resource("s3")asresource:resource:S3ServiceResource# Explicit type annotations are optional here# Type should be correctly discovered by mypy and IDEsbuckets:s3_resources.ServiceResourceBucketsCollection=resource.bucketsLiteralstypes_aiobotocore_s3.literalsmodule contains literals extracted from shapes
that can be used in user code for type checking.Full list ofS3Literals can be found indocs.fromtypes_aiobotocore_s3.literalsimportAnalyticsS3ExportFileFormatTypedefcheck_value(value:AnalyticsS3ExportFileFormatType)->bool:...Type definitionstypes_aiobotocore_s3.type_defsmodule contains structures and shapes
assembled to typed dictionaries and unions for additional type checking.Full list ofS3TypeDefs can be found indocs.fromtypes_aiobotocore_s3.type_defsimportAbortIncompleteMultipartUploadTypeDefdefget_value()->AbortIncompleteMultipartUploadTypeDef:return{...}How it worksFully automatedmypy-boto3-buildercarefully
generates type annotations for each service, patiently waiting foraiobotocoreupdates. It delivers drop-in type annotations for you and makes
sure that:All availableaiobotocoreservices are covered.Each public class and method of everyaiobotocoreservice gets valid type
annotations extracted frombotocoreschemas.Type annotations include up-to-date documentation.Link to documentation is provided for every method.Code is processed byblackandisortfor readability.What's newImplemented featuresFully type annotatedboto3,botocore,aiobotocoreandaioboto3librariesmypy,pyright,VSCode,PyCharm,Sublime TextandEmacscompatibilityClient,ServiceResource,Resource,WaiterPaginatortype
annotations for each serviceGeneratedTypeDefsfor each serviceGeneratedLiteralsfor each serviceAuto discovery of types forboto3.clientandboto3.resourcecallsAuto discovery of types forsession.clientandsession.resourcecallsAuto discovery of types forclient.get_waiterandclient.get_paginatorcallsAuto discovery of types forServiceResourceandResourcecollectionsAuto discovery of types foraiobotocore.Session.create_clientcallsLatest changesBuilder changelog can be found inReleases.Versioningtypes-aiobotocore-s3version is the same as relatedaiobotocoreversion and
followsPEP 440format.Thank youAllie Fitterforboto3-type-annotations,
this package is based on top of his workblackdevelopers for an awesome formatting
toolTimothy Edmund Crosleyforisortand how flexible it ismypydevelopers for doing all dirty work
for uspyrightteam for the new era of typed
PythonDocumentationAll services type annotations can be found inaiobotocore docsSupport and contributingThis package is auto-generated. Please reports any bugs or request new features
inmypy-boto3-builderrepository.