Metadata-Version: 2.1
Name: mypy-boto3-cloudformation
Version: 1.12.16.0
Summary: Type annotations for boto3.CloudFormation 1.12.16 service, generated by mypy-boto3-buider 1.0.4
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-cloudformation
        
        [![PyPI - mypy-boto3-cloudformation](https://img.shields.io/pypi/v/mypy-boto3-cloudformation.svg?color=blue)](https://pypi.org/project/mypy-boto3-cloudformation)
        [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-cloudformation.svg?color=blue)](https://pypi.org/project/mypy-boto3-cloudformation)
        [![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
        
        Type annotations for
        [boto3.CloudFormation 1.12.16](https://boto3.amazonaws.com/v1/documentation/api/1.12.16/reference/services/cloudformation.html#CloudFormation) 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.4](https://github.com/vemel/mypy_boto3_builder).
        
        More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
        
        - [mypy-boto3-cloudformation](#mypy-boto3-cloudformation)
          - [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 `CloudFormation` service.
        
        ```bash
        python -m pip install boto3-stubs[mypy-boto3-cloudformation]
        ```
        
        Use `boto3` with `mypy_boto3` in your project and enjoy type checking and auto-complete.
        
        ```python
        import boto3
        
        from mypy_boto3 import cloudformation
        # alternative import if you do not want to install mypy_boto3 package
        # import mypy_boto3_cloudformation as cloudformation
        
        # 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("cloudformation")
        client: cloudformation.CloudFormationClient = boto3.client("cloudformation")
        
        # works for session as well
        session = boto3.session.Session(region="us-west-1")
        session_client: cloudformation.CloudFormationClient = session.client("cloudformation")
        
        # Do you prefer resource approach? We've got you covered!
        resource: cloudformation.CloudFormationServiceResource = boto3.resource("cloudformation")
        
        # Waiters need type annotation on creation
        change_set_create_complete_waiter: cloudformation.ChangeSetCreateCompleteWaiter = client.get_waiter("change_set_create_complete")
        stack_create_complete_waiter: cloudformation.StackCreateCompleteWaiter = client.get_waiter("stack_create_complete")
        stack_delete_complete_waiter: cloudformation.StackDeleteCompleteWaiter = client.get_waiter("stack_delete_complete")
        stack_exists_waiter: cloudformation.StackExistsWaiter = client.get_waiter("stack_exists")
        stack_import_complete_waiter: cloudformation.StackImportCompleteWaiter = client.get_waiter("stack_import_complete")
        stack_update_complete_waiter: cloudformation.StackUpdateCompleteWaiter = client.get_waiter("stack_update_complete")
        type_registration_complete_waiter: cloudformation.TypeRegistrationCompleteWaiter = client.get_waiter("type_registration_complete")
        
        # Paginators need type annotation on creation
        describe_account_limits_paginator: cloudformation.DescribeAccountLimitsPaginator = client.get_paginator("describe_account_limits")
        describe_change_set_paginator: cloudformation.DescribeChangeSetPaginator = client.get_paginator("describe_change_set")
        describe_stack_events_paginator: cloudformation.DescribeStackEventsPaginator = client.get_paginator("describe_stack_events")
        describe_stacks_paginator: cloudformation.DescribeStacksPaginator = client.get_paginator("describe_stacks")
        list_change_sets_paginator: cloudformation.ListChangeSetsPaginator = client.get_paginator("list_change_sets")
        list_exports_paginator: cloudformation.ListExportsPaginator = client.get_paginator("list_exports")
        list_imports_paginator: cloudformation.ListImportsPaginator = client.get_paginator("list_imports")
        list_stack_instances_paginator: cloudformation.ListStackInstancesPaginator = client.get_paginator("list_stack_instances")
        list_stack_resources_paginator: cloudformation.ListStackResourcesPaginator = client.get_paginator("list_stack_resources")
        list_stack_set_operation_results_paginator: cloudformation.ListStackSetOperationResultsPaginator = client.get_paginator("list_stack_set_operation_results")
        list_stack_set_operations_paginator: cloudformation.ListStackSetOperationsPaginator = client.get_paginator("list_stack_set_operations")
        list_stack_sets_paginator: cloudformation.ListStackSetsPaginator = client.get_paginator("list_stack_sets")
        list_stacks_paginator: cloudformation.ListStacksPaginator = client.get_paginator("list_stacks")
        ```
        
        ## 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 cloudformation 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
