由mypyboto3buider4.2.0生成的boto3.Kinesis 1.16.35服务的类型注释
mypy-boto3-kinesis的Python项目详细描述
mypy-boto3-运动
的类型批注 boto3.Kinesis 1.16.35服务 兼容 VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright 以及其他工具。在
更多信息可在boto3-stubs页找到。在
了解它如何帮助查找和修复潜在的错误:
如何安装
为Kinesis
服务安装boto3-stubs
。在
python -m pip install boto3-stubs[kinesis]
使用
VSCode
- 安装Python extension
- 安装Pylance extension
- 将
Pylance
设置为Python语言服务器 - 在您的环境中安装
boto-stubs[kinesis]
:python -m pip install 'boto3-stubs[kinesis]'
类型检查和自动完成都应该适用于Kinesis
服务。
不需要显式的类型注释,请照常编写boto3
代码。在
PyCharm
- 在您的环境中安装
boto-stubs[kinesis]
:python -m pip install 'boto3-stubs[kinesis]'
类型检查和自动完成都应该适用于Kinesis
服务。
不需要显式的类型注释,请照常编写boto3
代码。
自动完成在大型项目或安装了大量boto3-stubs
子模块时可能会很慢。在
其他IDE
没有经过测试,但是只要您的IDE支持mypy
或{
mypy
- 安装
mypy
:python -m pip install mypy
- 在您的环境中安装
boto-stubs[kinesis]
:python -m pip install 'boto3-stubs[kinesis]'
- 像往常一样运行
mypy
类型检查应该适用于Kinesis
服务。
不需要显式的类型注释,请照常编写boto3
代码。在
pyright
- 安装
pyright
:yarn global add pyright
- 在您的环境中安装
boto-stubs[kinesis]
:python -m pip install 'boto3-stubs[kinesis]'
- 或者,您可以将
boto3-stubs
安装到typings
文件夹中。在
类型检查应该适用于Kinesis
服务。
不需要显式的类型注释,请照常编写boto3
代码。在
显式类型批注
客户端注释
KinesisClient
为boto3.client("kinesis")
提供注释。在
分页器注释
mypy_boto3_kinesis.paginator
模块包含所有分页器的类型注释。在
frommypy_boto3_kinesisimportKinesisClientfrommypy_boto3_kinesis.paginatorimport(DescribeStreamPaginator,ListShardsPaginator,ListStreamConsumersPaginator,ListStreamsPaginator,)client:KinesisClient=boto3.client("kinesis")# Explicit type annotations are optional here# Type should be correctly discovered by mypy and IDEs# VSCode requires explicit type annotationsdescribe_stream_paginator:DescribeStreamPaginator=client.get_paginator("describe_stream")list_shards_paginator:ListShardsPaginator=client.get_paginator("list_shards")list_stream_consumers_paginator:ListStreamConsumersPaginator=client.get_paginator("list_stream_consumers")list_streams_paginator:ListStreamsPaginator=client.get_paginator("list_streams")
服务员注释
mypy_boto3_kinesis.waiter
模块包含所有等待者的类型注释。在
frommypy_boto3_kinesisimportKinesisClientfrommypy_boto3_kinesis.waiterimportStreamExistsWaiter,StreamNotExistsWaiterclient:KinesisClient=boto3.client("kinesis")# Explicit type annotations are optional here# Type should be correctly discovered by mypy and IDEs# VSCode requires explicit type annotationsstream_exists_waiter:StreamExistsWaiter=client.get_waiter("stream_exists")stream_not_exists_waiter:StreamNotExistsWaiter=client.get_waiter("stream_not_exists")
键入的措辞
mypy_boto3_kinesis.type_defs
模块包含组合的结构和形状
以进行额外的类型检查。在
frommypy_boto3_kinesis.type_defsimport(ChildShardTypeDef,ConsumerDescriptionTypeDef,ConsumerTypeDef,DescribeLimitsOutputTypeDef,DescribeStreamConsumerOutputTypeDef,DescribeStreamOutputTypeDef,DescribeStreamSummaryOutputTypeDef,EnhancedMetricsTypeDef,EnhancedMonitoringOutputTypeDef,GetRecordsOutputTypeDef,GetShardIteratorOutputTypeDef,HashKeyRangeTypeDef,InternalFailureExceptionTypeDef,KMSAccessDeniedExceptionTypeDef,KMSDisabledExceptionTypeDef,KMSInvalidStateExceptionTypeDef,KMSNotFoundExceptionTypeDef,KMSOptInRequiredTypeDef,KMSThrottlingExceptionTypeDef,ListShardsOutputTypeDef,ListStreamConsumersOutputTypeDef,ListStreamsOutputTypeDef,ListTagsForStreamOutputTypeDef,PaginatorConfigTypeDef,PutRecordOutputTypeDef,PutRecordsOutputTypeDef,PutRecordsRequestEntryTypeDef,PutRecordsResultEntryTypeDef,RecordTypeDef,RegisterStreamConsumerOutputTypeDef,ResourceInUseExceptionTypeDef,ResourceNotFoundExceptionTypeDef,ResponseMetadata,SequenceNumberRangeTypeDef,ShardFilterTypeDef,ShardTypeDef,StartingPositionTypeDef,StreamDescriptionSummaryTypeDef,StreamDescriptionTypeDef,SubscribeToShardEventStreamTypeDef,SubscribeToShardEventTypeDef,SubscribeToShardOutputTypeDef,TagTypeDef,UpdateShardCountOutputTypeDef,WaiterConfigTypeDef,)defget_structure()->ChildShardTypeDef:return{...}
- 项目
标签: