使用 mypy-boto3-builder 7.11.8 生成的 aiobotocore.AutoScaling 2.4.0 服务的类型注释
项目描述
类型-aiobotocore-自动缩放
为aiobotocore.AutoScaling 2.4.0服务键入注释, 兼容VSCode、 PyCharm、 Emacs、 Sublime Text、 mypy、 pyright和其他工具。
由 mypy-boto3-builder 7.11.8 生成。
更多信息可以在 types-aiobotocore页面和 types-aiobotocore-autoscaling 文档中找到。
了解它如何帮助查找和修复潜在错误:
如何安装
来自带有 pip 的 PyPI
安装types-aiobotocore服务AutoScaling。
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[autoscaling]'
# 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[autoscaling]'
# standalone installation
python -m pip install types-aiobotocore-autoscaling
如何卸载
python -m pip uninstall -y types-aiobotocore-autoscaling
用法
VSCode
- 安装 Python 扩展
- 安装 Pylance 扩展
- 设置
Pylance为您的 Python 语言服务器 types-aiobotocore[autoscaling]在您的环境中安装:
python -m pip install 'types-aiobotocore[autoscaling]'
类型检查和代码完成现在都应该可以工作了。不需要显式类型注释,aiobotocore像往常一样编写代码。
PyCharm
types-aiobotocore-lite[autoscaling]在您的环境中安装:
python -m pip install 'types-aiobotocore-lite[autoscaling]'`
类型检查和代码完成现在都应该可以工作了。需要显式类型注释。
使用types-aiobotocore包代替隐式类型发现。
Emacs
- 安装
types-aiobotocore您在环境中使用的服务:
python -m pip install 'types-aiobotocore[autoscaling]'
- 安装use-package、 lsp、 company和 flycheck包
- 安装lsp-pyright包
(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"))
)
- 确保 emacs 使用您安装的环境
types-aiobotocore
类型检查现在应该可以工作了。不需要显式类型注释,aiobotocore像往常一样编写代码。
崇高的文本
- 安装
types-aiobotocore[autoscaling]您在环境中使用的服务:
python -m pip install 'types-aiobotocore[autoscaling]'
- 安装LSP-pyright包
类型检查现在应该可以工作了。不需要显式类型注释,aiobotocore像往常一样编写代码。
其他 IDE
未经测试,但只要您的 IDE 支持mypyor pyright,一切都应该工作。
我的
- 安装
mypy:python -m pip install mypy types-aiobotocore[autoscaling]在您的环境中安装:
python -m pip install 'types-aiobotocore[autoscaling]'`
类型检查现在应该可以工作了。不需要显式类型注释,aiobotocore像往常一样编写代码。
版权
- 安装
pyright:npm i -g pyright types-aiobotocore[autoscaling]在您的环境中安装:
python -m pip install 'types-aiobotocore[autoscaling]'
或者,您可以安装types-aiobotocore到typings文件夹。
类型检查现在应该可以工作了。不需要显式类型注释,aiobotocore像往常一样编写代码。
显式类型注释
客户端注释
AutoScalingClient为
session.create_client("autoscaling").
from aiobotocore.session import get_session
from types_aiobotocore_autoscaling import AutoScalingClient
session = get_session()
async with session.create_client("autoscaling") as client:
client: AutoScalingClient
# now client usage is checked by mypy and IDE should provide code completion
分页器注释
types_aiobotocore_autoscaling.paginator模块包含所有分页器的类型注释。
from aiobotocore.session import get_session
from types_aiobotocore_autoscaling import AutoScalingClient
from types_aiobotocore_autoscaling.paginator import (
DescribeAutoScalingGroupsPaginator,
DescribeAutoScalingInstancesPaginator,
DescribeLaunchConfigurationsPaginator,
DescribeLoadBalancerTargetGroupsPaginator,
DescribeLoadBalancersPaginator,
DescribeNotificationConfigurationsPaginator,
DescribePoliciesPaginator,
DescribeScalingActivitiesPaginator,
DescribeScheduledActionsPaginator,
DescribeTagsPaginator,
)
session = get_session()
async with session.create_client("autoscaling") as client:
client: AutoScalingClient
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_auto_scaling_groups_paginator: DescribeAutoScalingGroupsPaginator = (
client.get_paginator("describe_auto_scaling_groups")
)
describe_auto_scaling_instances_paginator: DescribeAutoScalingInstancesPaginator = (
client.get_paginator("describe_auto_scaling_instances")
)
describe_launch_configurations_paginator: DescribeLaunchConfigurationsPaginator = (
client.get_paginator("describe_launch_configurations")
)
describe_load_balancer_target_groups_paginator: DescribeLoadBalancerTargetGroupsPaginator = (
client.get_paginator("describe_load_balancer_target_groups")
)
describe_load_balancers_paginator: DescribeLoadBalancersPaginator = client.get_paginator(
"describe_load_balancers"
)
describe_notification_configurations_paginator: DescribeNotificationConfigurationsPaginator = (
client.get_paginator("describe_notification_configurations")
)
describe_policies_paginator: DescribePoliciesPaginator = client.get_paginator(
"describe_policies"
)
describe_scaling_activities_paginator: DescribeScalingActivitiesPaginator = (
client.get_paginator("describe_scaling_activities")
)
describe_scheduled_actions_paginator: DescribeScheduledActionsPaginator = client.get_paginator(
"describe_scheduled_actions"
)
describe_tags_paginator: DescribeTagsPaginator = client.get_paginator("describe_tags")
字面量
types_aiobotocore_autoscaling.literals模块包含从形状中提取的文字,可在用户代码中用于类型检查。
from types_aiobotocore_autoscaling.literals import (
AcceleratorManufacturerType,
AcceleratorNameType,
AcceleratorTypeType,
BareMetalType,
BurstablePerformanceType,
CpuManufacturerType,
DescribeAutoScalingGroupsPaginatorName,
DescribeAutoScalingInstancesPaginatorName,
DescribeLaunchConfigurationsPaginatorName,
DescribeLoadBalancerTargetGroupsPaginatorName,
DescribeLoadBalancersPaginatorName,
DescribeNotificationConfigurationsPaginatorName,
DescribePoliciesPaginatorName,
DescribeScalingActivitiesPaginatorName,
DescribeScheduledActionsPaginatorName,
DescribeTagsPaginatorName,
InstanceGenerationType,
InstanceMetadataEndpointStateType,
InstanceMetadataHttpTokensStateType,
InstanceRefreshStatusType,
LifecycleStateType,
LocalStorageType,
LocalStorageTypeType,
MetricStatisticType,
MetricTypeType,
PredefinedLoadMetricTypeType,
PredefinedMetricPairTypeType,
PredefinedScalingMetricTypeType,
PredictiveScalingMaxCapacityBreachBehaviorType,
PredictiveScalingModeType,
RefreshStrategyType,
ScalingActivityStatusCodeType,
WarmPoolStateType,
WarmPoolStatusType,
AutoScalingServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
RegionName,
)
def check_value(value: AcceleratorManufacturerType) -> bool:
...
打字字典
types_aiobotocore_autoscaling.type_defs模块包含组装到类型化字典的结构和形状,以进行额外的类型检查。
from types_aiobotocore_autoscaling.type_defs import (
AcceleratorCountRequestTypeDef,
AcceleratorTotalMemoryMiBRequestTypeDef,
ActivityTypeDef,
ResponseMetadataTypeDef,
AdjustmentTypeTypeDef,
AlarmTypeDef,
AttachInstancesQueryRequestTypeDef,
AttachLoadBalancerTargetGroupsTypeRequestTypeDef,
AttachLoadBalancersTypeRequestTypeDef,
FilterTypeDef,
PaginatorConfigTypeDef,
EnabledMetricTypeDef,
LaunchTemplateSpecificationTypeDef,
SuspendedProcessTypeDef,
TagDescriptionTypeDef,
BaselineEbsBandwidthMbpsRequestTypeDef,
FailedScheduledUpdateGroupActionRequestTypeDef,
BatchDeleteScheduledActionTypeRequestTypeDef,
ScheduledUpdateGroupActionRequestTypeDef,
EbsTypeDef,
CancelInstanceRefreshTypeRequestTypeDef,
CapacityForecastTypeDef,
CompleteLifecycleActionTypeRequestTypeDef,
LifecycleHookSpecificationTypeDef,
TagTypeDef,
InstanceMetadataOptionsTypeDef,
InstanceMonitoringTypeDef,
MetricDimensionTypeDef,
DeleteAutoScalingGroupTypeRequestTypeDef,
DeleteLifecycleHookTypeRequestTypeDef,
DeleteNotificationConfigurationTypeRequestTypeDef,
DeletePolicyTypeRequestTypeDef,
DeleteScheduledActionTypeRequestTypeDef,
DeleteWarmPoolTypeRequestTypeDef,
DescribeAutoScalingInstancesTypeRequestTypeDef,
DescribeInstanceRefreshesTypeRequestTypeDef,
LifecycleHookTypeDef,
DescribeLifecycleHooksTypeRequestTypeDef,
DescribeLoadBalancerTargetGroupsRequestRequestTypeDef,
LoadBalancerTargetGroupStateTypeDef,
DescribeLoadBalancersRequestRequestTypeDef,
LoadBalancerStateTypeDef,
MetricCollectionTypeTypeDef,
MetricGranularityTypeTypeDef,
NotificationConfigurationTypeDef,
DescribeNotificationConfigurationsTypeRequestTypeDef,
DescribePoliciesTypeRequestTypeDef,
DescribeScalingActivitiesTypeRequestTypeDef,
DescribeScheduledActionsTypeRequestTypeDef,
DescribeWarmPoolTypeRequestTypeDef,
DetachInstancesQueryRequestTypeDef,
DetachLoadBalancerTargetGroupsTypeRequestTypeDef,
DetachLoadBalancersTypeRequestTypeDef,
DisableMetricsCollectionQueryRequestTypeDef,
EnableMetricsCollectionQueryRequestTypeDef,
EnterStandbyQueryRequestTypeDef,
ExecutePolicyTypeRequestTypeDef,
ExitStandbyQueryRequestTypeDef,
GetPredictiveScalingForecastTypeRequestTypeDef,
InstanceRefreshLivePoolProgressTypeDef,
InstanceRefreshWarmPoolProgressTypeDef,
RefreshPreferencesTypeDef,
MemoryGiBPerVCpuRequestTypeDef,
MemoryMiBRequestTypeDef,
NetworkInterfaceCountRequestTypeDef,
TotalLocalStorageGBRequestTypeDef,
VCpuCountRequestTypeDef,
InstanceReusePolicyTypeDef,
InstancesDistributionTypeDef,
LaunchConfigurationNameTypeRequestTypeDef,
LaunchConfigurationNamesTypeRequestTypeDef,
PredefinedMetricSpecificationTypeDef,
PredictiveScalingPredefinedLoadMetricTypeDef,
PredictiveScalingPredefinedMetricPairTypeDef,
PredictiveScalingPredefinedScalingMetricTypeDef,
ProcessTypeTypeDef,
PutLifecycleHookTypeRequestTypeDef,
PutNotificationConfigurationTypeRequestTypeDef,
StepAdjustmentTypeDef,
PutScheduledUpdateGroupActionTypeRequestTypeDef,
RecordLifecycleActionHeartbeatTypeRequestTypeDef,
ScalingProcessQueryRequestTypeDef,
ScheduledUpdateGroupActionTypeDef,
SetDesiredCapacityTypeRequestTypeDef,
SetInstanceHealthQueryRequestTypeDef,
SetInstanceProtectionQueryRequestTypeDef,
TerminateInstanceInAutoScalingGroupTypeRequestTypeDef,
ActivitiesTypeTypeDef,
ActivityTypeTypeDef,
CancelInstanceRefreshAnswerTypeDef,
DescribeAccountLimitsAnswerTypeDef,
DescribeAutoScalingNotificationTypesAnswerTypeDef,
DescribeLifecycleHookTypesAnswerTypeDef,
DescribeTerminationPolicyTypesAnswerTypeDef,
DetachInstancesAnswerTypeDef,
EmptyResponseMetadataTypeDef,
EnterStandbyAnswerTypeDef,
ExitStandbyAnswerTypeDef,
StartInstanceRefreshAnswerTypeDef,
DescribeAdjustmentTypesAnswerTypeDef,
PolicyARNTypeTypeDef,
AutoScalingGroupNamesTypeRequestTypeDef,
DescribeTagsTypeRequestTypeDef,
AutoScalingGroupNamesTypeDescribeAutoScalingGroupsPaginateTypeDef,
DescribeAutoScalingInstancesTypeDescribeAutoScalingInstancesPaginateTypeDef,
DescribeLoadBalancerTargetGroupsRequestDescribeLoadBalancerTargetGroupsPaginateTypeDef,
DescribeLoadBalancersRequestDescribeLoadBalancersPaginateTypeDef,
DescribeNotificationConfigurationsTypeDescribeNotificationConfigurationsPaginateTypeDef,
DescribePoliciesTypeDescribePoliciesPaginateTypeDef,
DescribeScalingActivitiesTypeDescribeScalingActivitiesPaginateTypeDef,
DescribeScheduledActionsTypeDescribeScheduledActionsPaginateTypeDef,
DescribeTagsTypeDescribeTagsPaginateTypeDef,
LaunchConfigurationNamesTypeDescribeLaunchConfigurationsPaginateTypeDef,
AutoScalingInstanceDetailsTypeDef,
InstanceTypeDef,
TagsTypeTypeDef,
BatchDeleteScheduledActionAnswerTypeDef,
BatchPutScheduledUpdateGroupActionAnswerTypeDef,
BatchPutScheduledUpdateGroupActionTypeRequestTypeDef,
BlockDeviceMappingTypeDef,
CreateOrUpdateTagsTypeRequestTypeDef,
DeleteTagsTypeRequestTypeDef,
CustomizedMetricSpecificationTypeDef,
MetricTypeDef,
DescribeLifecycleHooksAnswerTypeDef,
DescribeLoadBalancerTargetGroupsResponseTypeDef,
DescribeLoadBalancersResponseTypeDef,
DescribeMetricCollectionTypesAnswerTypeDef,
DescribeNotificationConfigurationsAnswerTypeDef,
InstanceRefreshProgressDetailsTypeDef,
InstanceRequirementsTypeDef,
PutWarmPoolTypeRequestTypeDef,
WarmPoolConfigurationTypeDef,
ProcessesTypeTypeDef,
ScheduledActionsTypeTypeDef,
AutoScalingInstancesTypeTypeDef,
CreateLaunchConfigurationTypeRequestTypeDef,
LaunchConfigurationTypeDef,
TargetTrackingConfigurationTypeDef,
MetricStatTypeDef,
LaunchTemplateOverridesTypeDef,
DescribeWarmPoolAnswerTypeDef,
LaunchConfigurationsTypeTypeDef,
MetricDataQueryTypeDef,
LaunchTemplateTypeDef,
PredictiveScalingCustomizedCapacityMetricTypeDef,
PredictiveScalingCustomizedLoadMetricTypeDef,
PredictiveScalingCustomizedScalingMetricTypeDef,
MixedInstancesPolicyTypeDef,
PredictiveScalingMetricSpecificationTypeDef,
AutoScalingGroupTypeDef,
CreateAutoScalingGroupTypeRequestTypeDef,
DesiredConfigurationTypeDef,
UpdateAutoScalingGroupTypeRequestTypeDef,
LoadForecastTypeDef,
PredictiveScalingConfigurationTypeDef,
AutoScalingGroupsTypeTypeDef,
InstanceRefreshTypeDef,
StartInstanceRefreshTypeRequestTypeDef,
GetPredictiveScalingForecastAnswerTypeDef,
PutScalingPolicyTypeRequestTypeDef,
ScalingPolicyTypeDef,
DescribeInstanceRefreshesAnswerTypeDef,
PoliciesTypeTypeDef,
)
def get_structure() -> AcceleratorCountRequestTypeDef:
return {...}
这个怎么运作
全自动
的mypy-boto3-builder为每个服务仔细生成类型注解,耐心等待
aiobotocore更新。它为您提供插入式注释,并确保:
- 涵盖所有可用
aiobotocore服务。 - 每个
aiobotocore服务的每个公共类和方法都会从文档中提取有效的类型注释(botocore如果类型不正确,请归咎于文档)。 - 类型注释包括最新的文档。
- 每种方法都提供了文档链接。
- 为了可读性,代码由black和 isort处理。
什么是新的
实现的功能
- 全类型注释
boto3和botocore库aiobotocore mypy,pyright,VSCode,PyCharm,Sublime Text和Emacs兼容性Client,ServiceResource,Resource,WaiterPaginator为每个服务键入注释TypeDefs为每个服务生成Literals为每个服务生成- 自动发现类型
boto3.client和boto3.session调用 - 自动发现类型
session.client和session.session调用 - 自动发现类型
client.get_waiter和client.get_paginator调用 - 自动发现类型
ServiceResource和Resource集合 - 自动发现
aiobotocore.Session.create_client呼叫类型
最新变化
生成器更改日志可以在 Releases中找到。
版本控制
types-aiobotocore-autoscaling版本与相关aiobotocore
版本相同,遵循PEP 440
格式。
谢谢
- Allie Fitter for boto3-type-annotations,这个包是基于他的工作
- 一个很棒的格式化工具的黑人开发者
- 蒂莫西·埃德蒙·克罗斯利 (Timothy Edmund Crosley ) 的 isort及其灵活度
- mypy开发人员为我们做了所有肮脏的工作
- pyright团队为类型化 Python 的新时代
文档
所有服务类型注释都可以在 aiobotocore 文档中找到
支持和贡献
这个包是自动生成的。请在mypy-boto3-builder存储库中报告任何错误或请求新功能 。