由mypyboto3buider 4.2.0生成的boto3.sfn1.16.35服务的类型注释
mypy-boto3-stepfunctions的Python项目详细描述
mypy-boto3-阶跃函数
的类型批注 boto3.SFN 1.16.35服务 兼容 VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright 以及其他工具。在
更多信息可在boto3-stubs页找到。在
了解它如何帮助查找和修复潜在的错误:
如何安装
为SFN
服务安装boto3-stubs
。在
python -m pip install boto3-stubs[stepfunctions]
使用
VSCode
- 安装Python extension
- 安装Pylance extension
- 将
Pylance
设置为Python语言服务器 - 在您的环境中安装
boto-stubs[stepfunctions]
:python -m pip install 'boto3-stubs[stepfunctions]'
类型检查和自动完成都应该适用于SFN
服务。
不需要显式的类型注释,请照常编写boto3
代码。在
PyCharm
- 在您的环境中安装
boto-stubs[stepfunctions]
:python -m pip install 'boto3-stubs[stepfunctions]'
类型检查和自动完成都应该适用于SFN
服务。
不需要显式的类型注释,请照常编写boto3
代码。
自动完成在大型项目或安装了大量boto3-stubs
子模块时可能会很慢。在
其他IDE
没有经过测试,但是只要您的IDE支持mypy
或{
mypy
- 安装
mypy
:python -m pip install mypy
- 在您的环境中安装
boto-stubs[stepfunctions]
:python -m pip install 'boto3-stubs[stepfunctions]'
- 像往常一样运行
mypy
类型检查应该适用于SFN
服务。
不需要显式的类型注释,请照常编写boto3
代码。在
pyright
- 安装
pyright
:yarn global add pyright
- 在您的环境中安装
boto-stubs[stepfunctions]
:python -m pip install 'boto3-stubs[stepfunctions]'
- 或者,您可以将
boto3-stubs
安装到typings
文件夹中。在
类型检查应该适用于SFN
服务。
不需要显式的类型注释,请照常编写boto3
代码。在
显式类型批注
客户端注释
SFNClient
为boto3.client("stepfunctions")
提供注释。在
分页器注释
mypy_boto3_stepfunctions.paginator
模块包含所有分页器的类型注释。在
frommypy_boto3_stepfunctionsimportSFNClientfrommypy_boto3_stepfunctions.paginatorimport(GetExecutionHistoryPaginator,ListActivitiesPaginator,ListExecutionsPaginator,ListStateMachinesPaginator,)client:SFNClient=boto3.client("stepfunctions")# Explicit type annotations are optional here# Type should be correctly discovered by mypy and IDEs# VSCode requires explicit type annotationsget_execution_history_paginator:GetExecutionHistoryPaginator=client.get_paginator("get_execution_history")list_activities_paginator:ListActivitiesPaginator=client.get_paginator("list_activities")list_executions_paginator:ListExecutionsPaginator=client.get_paginator("list_executions")list_state_machines_paginator:ListStateMachinesPaginator=client.get_paginator("list_state_machines")
键入的措辞
mypy_boto3_stepfunctions.type_defs
模块包含组合的结构和形状
以进行额外的类型检查。在
frommypy_boto3_stepfunctions.type_defsimport(ActivityFailedEventDetailsTypeDef,ActivityListItemTypeDef,ActivityScheduledEventDetailsTypeDef,ActivityScheduleFailedEventDetailsTypeDef,ActivityStartedEventDetailsTypeDef,ActivitySucceededEventDetailsTypeDef,ActivityTimedOutEventDetailsTypeDef,BillingDetailsTypeDef,CloudWatchEventsExecutionDataDetailsTypeDef,CloudWatchLogsLogGroupTypeDef,CreateActivityOutputTypeDef,CreateStateMachineOutputTypeDef,DescribeActivityOutputTypeDef,DescribeExecutionOutputTypeDef,DescribeStateMachineForExecutionOutputTypeDef,DescribeStateMachineOutputTypeDef,ExecutionAbortedEventDetailsTypeDef,ExecutionFailedEventDetailsTypeDef,ExecutionListItemTypeDef,ExecutionStartedEventDetailsTypeDef,ExecutionSucceededEventDetailsTypeDef,ExecutionTimedOutEventDetailsTypeDef,GetActivityTaskOutputTypeDef,GetExecutionHistoryOutputTypeDef,HistoryEventExecutionDataDetailsTypeDef,HistoryEventTypeDef,LambdaFunctionFailedEventDetailsTypeDef,LambdaFunctionScheduledEventDetailsTypeDef,LambdaFunctionScheduleFailedEventDetailsTypeDef,LambdaFunctionStartFailedEventDetailsTypeDef,LambdaFunctionSucceededEventDetailsTypeDef,LambdaFunctionTimedOutEventDetailsTypeDef,ListActivitiesOutputTypeDef,ListExecutionsOutputTypeDef,ListStateMachinesOutputTypeDef,ListTagsForResourceOutputTypeDef,LogDestinationTypeDef,LoggingConfigurationTypeDef,MapIterationEventDetailsTypeDef,MapStateStartedEventDetailsTypeDef,PaginatorConfigTypeDef,ResponseMetadata,StartExecutionOutputTypeDef,StartSyncExecutionOutputTypeDef,StateEnteredEventDetailsTypeDef,StateExitedEventDetailsTypeDef,StateMachineListItemTypeDef,StopExecutionOutputTypeDef,TagTypeDef,TaskFailedEventDetailsTypeDef,TaskScheduledEventDetailsTypeDef,TaskStartedEventDetailsTypeDef,TaskStartFailedEventDetailsTypeDef,TaskSubmitFailedEventDetailsTypeDef,TaskSubmittedEventDetailsTypeDef,TaskSucceededEventDetailsTypeDef,TaskTimedOutEventDetailsTypeDef,TracingConfigurationTypeDef,UpdateStateMachineOutputTypeDef,)defget_structure()->ActivityFailedEventDetailsTypeDef:return{...}
- 项目
标签: