Type annotations for boto3.AutoScalingPlans 1.14.22 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-autoscaling-plans
Type annotations for boto3.AutoScalingPlans 1.14.22 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for AutoScalingPlans
service.
python -m pip install boto3-stubs[autoscaling-plans]
How to use
Client annotations
AutoScalingPlansClient
provides annotations for boto3.client("autoscaling-plans")
.
import boto3
from mypy_boto3_autoscaling_plans import AutoScalingPlansClient
from mypy_boto3_autoscaling_plans.paginator import (
DescribeScalingPlanResourcesPaginator,
DescribeScalingPlansPaginator,
)
from mypy_boto3_autoscaling_plans.type_defs import ApplicationSourceTypeDef, ...
client: AutoScalingPlansClient = boto3.client("autoscaling-plans")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: AutoScalingPlansClient = session.client("autoscaling-plans")
Paginators annotations
mypy_boto3_autoscaling_plans.paginator
module contains type annotations for all paginators.
client: AutoScalingPlansClient = boto3.client("autoscaling-plans")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_scaling_plan_resources_paginator: DescribeScalingPlanResourcesPaginator = client.get_paginator("describe_scaling_plan_resources")
describe_scaling_plans_paginator: DescribeScalingPlansPaginator = client.get_paginator("describe_scaling_plans")
Typed dictionations
mypy_boto3_autoscaling_plans.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> ApplicationSourceTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_autoscaling_plans
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
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("autoscaling-plans")
session_client = boto3.Session().client("autoscaling-plans")
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-autoscaling-plans-1.14.22.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc4e134f16f5c5fcf81f03dca54869d1c8d1b4d710d49cec60278042f225223b |
|
MD5 | 3bd9cc13d88b46397e779cc552476c43 |
|
BLAKE2b-256 | 1c4d5c8f3bb44247af3377ea3e53469053c9e73a70c28fe6ce8270db5c989f78 |
Hashes for mypy_boto3_autoscaling_plans-1.14.22.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b10bcdd1e32a369637615448336f6a198c5acacac51bbcc1fc0e5a41a80c5e1e |
|
MD5 | b0b118855ae10ae65aa54e00a988f61b |
|
BLAKE2b-256 | d633ad9d3c05e9e113d11e22b9c7d3f3709656f49dabf88e7d9c1bdca8afc085 |