Type annotations for boto3.CloudFormation 1.14.0 service, generated by mypy-boto3-buider 2.0.4
Project description
mypy-boto3-cloudformation
Type annotations for boto3.CloudFormation 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.4.
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]
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")
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_cloudformation
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
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 carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("cloudformation")
resource = boto3.resource("cloudformation")
session_client = boto3.Session().client("cloudformation")
session_resource = boto3.Session().resource("cloudformation")
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.14.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d640fa2679cc952130861d3a77586783c531ad29622907be7080878ca8e2a7e3 |
|
MD5 | cc61f3b03063b429d68acb8202d10cba |
|
BLAKE2b-256 | 5b876031e4ed9eb50c174a2524de1562f362cc6f07350bc58946bd8614a40d18 |
Hashes for mypy_boto3_cloudformation-1.14.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a791721efe53d96ce2b3775ac9c24887d1db741b7a92913ba17796d7ea713493 |
|
MD5 | 47a85a4427824dc2b93c9b38e0d20712 |
|
BLAKE2b-256 | c7cd707163d54edc37251c7a762f71302f511657bb1ec1b344f5fae8103bd284 |