Type annotations for aiobotocore.CloudFormation 2.15.2 service generated with mypy-boto3-builder 8.1.2
Project description
types-aiobotocore-cloudformation
Type annotations for aiobotocore.CloudFormation 2.15.2 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.
Generated by mypy-boto3-builder 8.1.2.
More information can be found on types-aiobotocore page and in types-aiobotocore-cloudformation docs.
See how it helps to find and fix potential bugs:
- types-aiobotocore-cloudformation
How to install
From PyPI with pip
Install types-aiobotocore
for CloudFormation
service.
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[cloudformation]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[cloudformation]'
# standalone installation
python -m pip install types-aiobotocore-cloudformation
How to uninstall
python -m pip uninstall -y types-aiobotocore-cloudformation
Usage
VSCode
- Install Python extension
- Install Pylance extension
- Set
Pylance
as your Python Language Server - Install
types-aiobotocore[cloudformation]
in your environment:
python -m pip install 'types-aiobotocore[cloudformation]'
Both type checking and code completion should now work. No explicit type
annotations required, write your aiobotocore
code as usual.
PyCharm
Install types-aiobotocore-lite[cloudformation]
in your environment:
python -m pip install 'types-aiobotocore-lite[cloudformation]'`
Both type checking and code completion should now work. Explicit type annotations are required.
Use types-aiobotocore
package instead for implicit type discovery.
Emacs
- Install
types-aiobotocore
with services you use in your environment:
python -m pip install 'types-aiobotocore[cloudformation]'
- Install use-package, lsp, company and flycheck packages
- Install lsp-pyright package
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
- Make sure emacs uses the environment where you have installed
types-aiobotocore
Type checking should now work. No explicit type annotations required, write
your aiobotocore
code as usual.
Sublime Text
- Install
types-aiobotocore[cloudformation]
with services you use in your environment:
python -m pip install 'types-aiobotocore[cloudformation]'
- Install LSP-pyright package
Type checking should now work. No explicit type annotations required, write
your aiobotocore
code as usual.
Other IDEs
Not tested, but as long as your IDE supports mypy
or pyright
, everything
should work.
mypy
- Install
mypy
:python -m pip install mypy
- Install
types-aiobotocore[cloudformation]
in your environment:
python -m pip install 'types-aiobotocore[cloudformation]'
Type checking should now work. No explicit type annotations required, write
your aiobotocore
code as usual.
pyright
- Install
pyright
:npm i -g pyright
- Install
types-aiobotocore[cloudformation]
in your environment:
python -m pip install 'types-aiobotocore[cloudformation]'
Optionally, you can install types-aiobotocore
to typings
directory.
Type checking should now work. No explicit type annotations required, write
your aiobotocore
code as usual.
Explicit type annotations
Client annotations
CloudFormationClient
provides annotations for
session.create_client("cloudformation")
.
from aiobotocore.session import get_session
from types_aiobotocore_cloudformation import CloudFormationClient
session = get_session()
async with session.create_client("cloudformation") as client:
client: CloudFormationClient
# now client usage is checked by mypy and IDE should provide code completion
Paginators annotations
types_aiobotocore_cloudformation.paginator
module contains type annotations
for all paginators.
from aiobotocore.session import get_session
from types_aiobotocore_cloudformation import CloudFormationClient
from types_aiobotocore_cloudformation.paginator import (
DescribeAccountLimitsPaginator,
DescribeChangeSetPaginator,
DescribeStackEventsPaginator,
DescribeStacksPaginator,
ListChangeSetsPaginator,
ListExportsPaginator,
ListGeneratedTemplatesPaginator,
ListImportsPaginator,
ListResourceScanRelatedResourcesPaginator,
ListResourceScanResourcesPaginator,
ListResourceScansPaginator,
ListStackInstancesPaginator,
ListStackResourcesPaginator,
ListStackSetOperationResultsPaginator,
ListStackSetOperationsPaginator,
ListStackSetsPaginator,
ListStacksPaginator,
ListTypesPaginator,
)
session = get_session()
async with session.create_client("cloudformation") as client:
client: CloudFormationClient
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_account_limits_paginator: DescribeAccountLimitsPaginator = client.get_paginator(
"describe_account_limits"
)
describe_change_set_paginator: DescribeChangeSetPaginator = client.get_paginator(
"describe_change_set"
)
describe_stack_events_paginator: DescribeStackEventsPaginator = client.get_paginator(
"describe_stack_events"
)
describe_stacks_paginator: DescribeStacksPaginator = client.get_paginator("describe_stacks")
list_change_sets_paginator: ListChangeSetsPaginator = client.get_paginator("list_change_sets")
list_exports_paginator: ListExportsPaginator = client.get_paginator("list_exports")
list_generated_templates_paginator: ListGeneratedTemplatesPaginator = client.get_paginator(
"list_generated_templates"
)
list_imports_paginator: ListImportsPaginator = client.get_paginator("list_imports")
list_resource_scan_related_resources_paginator: ListResourceScanRelatedResourcesPaginator = (
client.get_paginator("list_resource_scan_related_resources")
)
list_resource_scan_resources_paginator: ListResourceScanResourcesPaginator = (
client.get_paginator("list_resource_scan_resources")
)
list_resource_scans_paginator: ListResourceScansPaginator = client.get_paginator(
"list_resource_scans"
)
list_stack_instances_paginator: ListStackInstancesPaginator = client.get_paginator(
"list_stack_instances"
)
list_stack_resources_paginator: ListStackResourcesPaginator = client.get_paginator(
"list_stack_resources"
)
list_stack_set_operation_results_paginator: ListStackSetOperationResultsPaginator = (
client.get_paginator("list_stack_set_operation_results")
)
list_stack_set_operations_paginator: ListStackSetOperationsPaginator = client.get_paginator(
"list_stack_set_operations"
)
list_stack_sets_paginator: ListStackSetsPaginator = client.get_paginator("list_stack_sets")
list_stacks_paginator: ListStacksPaginator = client.get_paginator("list_stacks")
list_types_paginator: ListTypesPaginator = client.get_paginator("list_types")
Waiters annotations
types_aiobotocore_cloudformation.waiter
module contains type annotations for
all waiters.
from aiobotocore.session import get_session
from types_aiobotocore_cloudformation.client import CloudFormationClient
from types_aiobotocore_cloudformation.waiter import (
ChangeSetCreateCompleteWaiter,
StackCreateCompleteWaiter,
StackDeleteCompleteWaiter,
StackExistsWaiter,
StackImportCompleteWaiter,
StackRollbackCompleteWaiter,
StackUpdateCompleteWaiter,
TypeRegistrationCompleteWaiter,
)
session = get_session()
async with session.create_client("cloudformation") as client:
client: CloudFormationClient
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
change_set_create_complete_waiter: ChangeSetCreateCompleteWaiter = client.get_waiter(
"change_set_create_complete"
)
stack_create_complete_waiter: StackCreateCompleteWaiter = client.get_waiter(
"stack_create_complete"
)
stack_delete_complete_waiter: StackDeleteCompleteWaiter = client.get_waiter(
"stack_delete_complete"
)
stack_exists_waiter: StackExistsWaiter = client.get_waiter("stack_exists")
stack_import_complete_waiter: StackImportCompleteWaiter = client.get_waiter(
"stack_import_complete"
)
stack_rollback_complete_waiter: StackRollbackCompleteWaiter = client.get_waiter(
"stack_rollback_complete"
)
stack_update_complete_waiter: StackUpdateCompleteWaiter = client.get_waiter(
"stack_update_complete"
)
type_registration_complete_waiter: TypeRegistrationCompleteWaiter = client.get_waiter(
"type_registration_complete"
)
Service Resource annotations
CloudFormationServiceResource
provides annotations for
aiobotocore.resource("cloudformation")
.
from aiobotocore.session import get_session
from types_aiobotocore_cloudformation import CloudFormationServiceResource
session = get_session()
async with session.resource("cloudformation") as resource:
resource: CloudFormationServiceResource
# now resource usage is checked by mypy and IDE should provide code completion
Other resources annotations
types_aiobotocore_cloudformation.service_resource
module contains type
annotations for all resources.
from aiobotocore.session import get_session
from types_aiobotocore_cloudformation import CloudFormationServiceResource
from types_aiobotocore_cloudformation.service_resource import (
Event,
Stack,
StackResource,
StackResourceSummary,
)
session = get_session()
async with session.resource("cloudformation") as resource:
resource: CloudFormationServiceResource
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
my_event: Event = resource.Event(...)
my_stack: Stack = resource.Stack(...)
my_stack_resource: StackResource = resource.StackResource(...)
my_stack_resource_summary: StackResourceSummary = resource.StackResourceSummary(...)
Collections annotations
types_aiobotocore_cloudformation.service_resource
module contains type
annotations for all CloudFormationServiceResource
collections.
from aiobotocore.session import get_session
from types_aiobotocore_cloudformation import CloudFormationServiceResource
from types_aiobotocore_cloudformation.service_resource import ServiceResourceStacksCollection
session = get_session()
async with session.resource("cloudformation") as resource:
resource: CloudFormationServiceResource
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
stacks: cloudformation_resources.ServiceResourceStacksCollection = resource.stacks
Literals
types_aiobotocore_cloudformation.literals
module contains literals extracted
from shapes that can be used in user code for type checking.
Full list of CloudFormation
Literals can be found in
docs.
from types_aiobotocore_cloudformation.literals import AccountFilterTypeType
def check_value(value: AccountFilterTypeType) -> bool: ...
Type definitions
types_aiobotocore_cloudformation.type_defs
module contains structures and
shapes assembled to typed dictionaries and unions for additional type checking.
Full list of CloudFormation
TypeDefs can be found in
docs.
from types_aiobotocore_cloudformation.type_defs import AccountGateResultTypeDef
def get_value() -> AccountGateResultTypeDef:
return {...}
How it works
Fully automated
mypy-boto3-builder carefully
generates type annotations for each service, patiently waiting for
aiobotocore
updates. It delivers drop-in type annotations for you and makes
sure that:
- All available
aiobotocore
services are covered. - Each public class and method of every
aiobotocore
service gets valid type annotations extracted frombotocore
schemas. - Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by ruff for readability.
What's new
Implemented features
- Fully type annotated
boto3
,botocore
,aiobotocore
andaioboto3
libraries mypy
,pyright
,VSCode
,PyCharm
,Sublime Text
andEmacs
compatibilityClient
,ServiceResource
,Resource
,Waiter
Paginator
type annotations for each service- Generated
TypeDefs
for each service - Generated
Literals
for each service - Auto discovery of types for
boto3.client
andboto3.resource
calls - Auto discovery of types for
session.client
andsession.resource
calls - Auto discovery of types for
client.get_waiter
andclient.get_paginator
calls - Auto discovery of types for
ServiceResource
andResource
collections - Auto discovery of types for
aiobotocore.Session.create_client
calls
Latest changes
Builder changelog can be found in Releases.
Versioning
types-aiobotocore-cloudformation
version is the same as related aiobotocore
version and follows PEP 440
format.
Thank you
- Allie Fitter for boto3-type-annotations, this package is based on top of his work
- black developers for an awesome formatting tool
- Timothy Edmund Crosley for isort and how flexible it is
- mypy developers for doing all dirty work for us
- pyright team for the new era of typed Python
Documentation
All services type annotations can be found in aiobotocore docs
Support and contributing
This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.
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 types_aiobotocore_cloudformation-2.15.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c6ab58fdb4c270f3cd493ad5adb83489937e8d977824243d198b73e8ba8d017 |
|
MD5 | 0deb7fdff8e9c5861fe96d34f391d77a |
|
BLAKE2b-256 | aa1ef1ffc27bad51e75ed9c7be908f53d5c83686fd3a658df8ea2a03134a81f9 |
Hashes for types_aiobotocore_cloudformation-2.15.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 510a4c7adc65659d37d5f9685bad7e331e0b4642cb41b469d01a5721073c2a58 |
|
MD5 | b0b3d10dc172404fd9d0052512373348 |
|
BLAKE2b-256 | 701745520440c251185ec96de21c7172d06da7e2ae9801f3fdcc2b7447628a57 |