Type annotations for boto3.CloudFormation 1.13.24 service, generated by mypy-boto3-buider 2.0.2
Project description
mypy-boto3-cloudformation
Type annotations for boto3.CloudFormation 1.13.24 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.2.
More information can be found on boto3-stubs page.
How to use
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for CloudFormation
service.
python -m pip install boto3-stubs[cloudformation]
# update installed packages index for automated type discovery
python -m mypy_boto3
Use boto3
with mypy_boto3_cloudformation
in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3_cloudformation import CloudFormationClient
# Now mypy can check if your code is valid.
client: CloudFormationClient = boto3.client("cloudformation")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: CloudFormationClient = session.client("cloudformation")
# Do you prefer resource approach? We've got you covered!
from mypy_boto3_cloudformation import CloudFormationServiceResource
resource: cloudformation.CloudFormationServiceResource = boto3.resource("cloudformation")
# Waiters are also supported
import mypy_boto3_cloudformation.waiter as cloudformation_waiters
change_set_create_complete_waiter: cloudformation_waiters.ChangeSetCreateCompleteWaiter = client.get_waiter("change_set_create_complete")
stack_create_complete_waiter: cloudformation_waiters.StackCreateCompleteWaiter = client.get_waiter("stack_create_complete")
stack_delete_complete_waiter: cloudformation_waiters.StackDeleteCompleteWaiter = client.get_waiter("stack_delete_complete")
stack_exists_waiter: cloudformation_waiters.StackExistsWaiter = client.get_waiter("stack_exists")
stack_import_complete_waiter: cloudformation_waiters.StackImportCompleteWaiter = client.get_waiter("stack_import_complete")
stack_rollback_complete_waiter: cloudformation_waiters.StackRollbackCompleteWaiter = client.get_waiter("stack_rollback_complete")
stack_update_complete_waiter: cloudformation_waiters.StackUpdateCompleteWaiter = client.get_waiter("stack_update_complete")
type_registration_complete_waiter: cloudformation_waiters.TypeRegistrationCompleteWaiter = client.get_waiter("type_registration_complete")
# Annotated paginators are included as well
import mypy_boto3_cloudformation.paginator as cloudformation_paginators
describe_account_limits_paginator: cloudformation_paginators.DescribeAccountLimitsPaginator = client.get_paginator("describe_account_limits")
describe_change_set_paginator: cloudformation_paginators.DescribeChangeSetPaginator = client.get_paginator("describe_change_set")
describe_stack_events_paginator: cloudformation_paginators.DescribeStackEventsPaginator = client.get_paginator("describe_stack_events")
describe_stacks_paginator: cloudformation_paginators.DescribeStacksPaginator = client.get_paginator("describe_stacks")
list_change_sets_paginator: cloudformation_paginators.ListChangeSetsPaginator = client.get_paginator("list_change_sets")
list_exports_paginator: cloudformation_paginators.ListExportsPaginator = client.get_paginator("list_exports")
list_imports_paginator: cloudformation_paginators.ListImportsPaginator = client.get_paginator("list_imports")
list_stack_instances_paginator: cloudformation_paginators.ListStackInstancesPaginator = client.get_paginator("list_stack_instances")
list_stack_resources_paginator: cloudformation_paginators.ListStackResourcesPaginator = client.get_paginator("list_stack_resources")
list_stack_set_operation_results_paginator: cloudformation_paginators.ListStackSetOperationResultsPaginator = client.get_paginator("list_stack_set_operation_results")
list_stack_set_operations_paginator: cloudformation_paginators.ListStackSetOperationsPaginator = client.get_paginator("list_stack_set_operations")
list_stack_sets_paginator: cloudformation_paginators.ListStackSetsPaginator = client.get_paginator("list_stack_sets")
list_stacks_paginator: cloudformation_paginators.ListStacksPaginator = client.get_paginator("list_stacks")
Automated type discovery
mypy_boto3
package can generate index for mypy_boto3_cloudformation
and other installed services.
# Run this command when you add or remove service packages
python -m mypy_boto3
Generated index provides overloads for boto3.client
and boto3.service
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefullyVSCode
does not currently support function overloads
Also, generated index allows you to import types from mypy_boto3
:
# you can replace imports
import mypy_boto3_cloudformation as cloudformation
from mypy_boto3_cloudformation import CloudFormationClient
# with these
from mypy_boto3 import cloudformation
from mypy_boto3.cloudformation import CloudFormationClient
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-cloudformation-1.13.24.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a84932c15c5521c4c55b8a325cf5373366ddaa0f2b642f18de24a67cae7928aa |
|
MD5 | 043bfdb2d80e77f4f9d089648e06ef92 |
|
BLAKE2b-256 | d20dceeb56f127854728a56faf0d0027236768b083947bc6fe6b8a4e08a1ad8e |
Hashes for mypy_boto3_cloudformation-1.13.24.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 77423473be8cab81504974b465000c8652f89b9ca4c13a2148674eb04dcd1ea0 |
|
MD5 | 9dead3068e92a61bae6e0e1764b41a0f |
|
BLAKE2b-256 | 106e0c38faa8f25163a5605ffd97f6dc435162d662afa9bb9e2878fbff012d2c |