Metadata-Version: 2.1
Name: mypy-boto3-s3
Version: 1.13.13.0
Summary: Type annotations for boto3.S3 1.13.13 service, generated by mypy-boto3-buider 1.0.9
Home-page: https://github.com/vemel/mypy_boto3_builder
Author: Vlad Emelianov
Author-email: vlad.emelianov.nz@gmail.com
License: MIT License
Project-URL: Documentation, https://mypy-boto3-builder.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/vemel/mypy_boto3_builder
Project-URL: Tracker, https://github.com/vemel/mypy_boto3_builder/issues
Description: # mypy-boto3-s3
        
        [![PyPI - mypy-boto3-s3](https://img.shields.io/pypi/v/mypy-boto3-s3.svg?color=blue)](https://pypi.org/project/mypy-boto3-s3)
        [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-s3.svg?color=blue)](https://pypi.org/project/mypy-boto3-s3)
        [![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
        
        Type annotations for
        [boto3.S3 1.13.13](https://boto3.amazonaws.com/v1/documentation/api/1.13.13/reference/services/s3.html#S3) service
        compatible with [mypy](https://github.com/python/mypy), [VSCode](https://code.visualstudio.com/),
        [PyCharm](https://www.jetbrains.com/pycharm/) and other tools.
        
        Generated by [mypy-boto3-buider 1.0.9](https://github.com/vemel/mypy_boto3_builder).
        
        More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
        
        - [mypy-boto3-s3](#mypy-boto3-s3)
          - [How to use](#how-to-use)
            - [Type checking](#type-checking)
          - [How it works](#how-it-works)
        
        ## How to use
        
        ### Type checking
        
        Make sure you have [mypy](https://github.com/python/mypy) installed and activated in your IDE.
        
        Install `boto3-stubs` for `S3` service.
        
        ```bash
        python -m pip install boto3-stubs[s3]
        
        # update installed packages index
        mypy_boto3
        ```
        
        Use `boto3` with `mypy_boto3` in your project and enjoy type checking and auto-complete.
        
        ```python
        import boto3
        
        from mypy_boto3 import s3
        # alternative import if you do not want to install mypy_boto3 package
        # import mypy_boto3_s3 as s3
        
        # Use this client as usual, now mypy can check if your code is valid.
        # Check if your IDE supports function overloads,
        # you probably do not need explicit type annotations
        # client = boto3.client("s3")
        client: s3.S3Client = boto3.client("s3")
        
        # works for session as well
        session = boto3.session.Session(region="us-west-1")
        session_client: s3.S3Client = session.client("s3")
        
        # Do you prefer resource approach? We've got you covered!
        resource: s3.S3ServiceResource = boto3.resource("s3")
        
        # Waiters need type annotation on creation
        bucket_exists_waiter: s3.BucketExistsWaiter = client.get_waiter("bucket_exists")
        bucket_not_exists_waiter: s3.BucketNotExistsWaiter = client.get_waiter("bucket_not_exists")
        object_exists_waiter: s3.ObjectExistsWaiter = client.get_waiter("object_exists")
        object_not_exists_waiter: s3.ObjectNotExistsWaiter = client.get_waiter("object_not_exists")
        
        # Paginators need type annotation on creation
        list_multipart_uploads_paginator: s3.ListMultipartUploadsPaginator = client.get_paginator("list_multipart_uploads")
        list_object_versions_paginator: s3.ListObjectVersionsPaginator = client.get_paginator("list_object_versions")
        list_objects_paginator: s3.ListObjectsPaginator = client.get_paginator("list_objects")
        list_objects_v2_paginator: s3.ListObjectsV2Paginator = client.get_paginator("list_objects_v2")
        list_parts_paginator: s3.ListPartsPaginator = client.get_paginator("list_parts")
        ```
        
        ## How it works
        
        Fully automated [builder](https://github.com/vemel/mypy_boto3_builder) carefully generates
        type annotations for each service, patiently waiting for `boto3` updates. It delivers
        a drop-in type annotations for you and makes sure that:
        
        - All available `boto3` services are covered.
        - Each public class and method of every `boto3` service gets valid type annotations
          extracted from the documentation (blame `botocore` docs if types are incorrect).
        - Type annotations include up-to-date documentation.
        - Link to documentation is provided for every method.
        - Code is processed by [black](https://github.com/psf/black) for readability.
Keywords: boto3 s3 type-annotations boto3-stubs mypy typeshed autocomplete auto-generated
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
