Type annotations for boto3.AutoScalingPlans 1.14.28 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-autoscaling-plans
Type annotations for boto3.AutoScalingPlans 1.14.28 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.28.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a584dbf9e6ede8fa89fd5a3e6d6b80c6baf88bdaa0196f4b90aaf6d9b607b3ce |
|
MD5 | 0869cd361114abc7c9210abf0f66a508 |
|
BLAKE2b-256 | cfc76ba768d9dde6e8d209e1f4d9093fcacc46c0452b87c87fd882f5b246d28e |
Hashes for mypy_boto3_autoscaling_plans-1.14.28.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9056d76b8c11241a8f94ee0b46d5e72815971c4dcc2a7e6c6eba63a79b78f14 |
|
MD5 | af8730b8a54bd4b3ecff18b34d16996a |
|
BLAKE2b-256 | e4270d2412416b1cd67eb5500ff28ee831598941b7985289851bb45450bd908c |