由mypyboto3buider 4.2.0生成的boto3.DocDB 1.16.35服务的类型注释
mypy-boto3-docdb的Python项目详细描述
mypy-boto3-docdb公司
的类型批注 boto3.DocDB 1.16.35服务 兼容 VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright 以及其他工具。在
更多信息可在boto3-stubs页找到。在
了解它如何帮助查找和修复潜在的错误:
如何安装
为DocDB
服务安装boto3-stubs
。在
python -m pip install boto3-stubs[docdb]
使用
VSCode
- 安装Python extension
- 安装Pylance extension
- 将
Pylance
设置为Python语言服务器 - 在您的环境中安装
boto-stubs[docdb]
:python -m pip install 'boto3-stubs[docdb]'
类型检查和自动完成都应该适用于DocDB
服务。
不需要显式的类型注释,请照常编写boto3
代码。在
PyCharm
- 在您的环境中安装
boto-stubs[docdb]
:python -m pip install 'boto3-stubs[docdb]'
类型检查和自动完成都应该适用于DocDB
服务。
不需要显式的类型注释,请照常编写boto3
代码。
自动完成在大型项目或安装了大量boto3-stubs
子模块时可能会很慢。在
其他IDE
没有经过测试,但是只要您的IDE支持mypy
或{
mypy
- 安装
mypy
:python -m pip install mypy
- 在您的环境中安装
boto-stubs[docdb]
:python -m pip install 'boto3-stubs[docdb]'
- {cd13>像往常一样
类型检查应该适用于DocDB
服务。
不需要显式的类型注释,请照常编写boto3
代码。在
pyright
- 安装
pyright
:yarn global add pyright
- 在您的环境中安装
boto-stubs[docdb]
:python -m pip install 'boto3-stubs[docdb]'
- 或者,您可以将
boto3-stubs
安装到typings
文件夹中。在
类型检查应该适用于DocDB
服务。
不需要显式的类型注释,请照常编写boto3
代码。在
显式类型批注
客户端注释
DocDBClient
为boto3.client("docdb")
提供注释。在
分页器注释
mypy_boto3_docdb.paginator
模块包含所有分页器的类型注释。在
frommypy_boto3_docdbimportDocDBClientfrommypy_boto3_docdb.paginatorimport(DescribeCertificatesPaginator,DescribeDBClusterParameterGroupsPaginator,DescribeDBClusterParametersPaginator,DescribeDBClusterSnapshotsPaginator,DescribeDBClustersPaginator,DescribeDBEngineVersionsPaginator,DescribeDBInstancesPaginator,DescribeDBSubnetGroupsPaginator,DescribeEventsPaginator,DescribeOrderableDBInstanceOptionsPaginator,DescribePendingMaintenanceActionsPaginator,)client:DocDBClient=boto3.client("docdb")# Explicit type annotations are optional here# Type should be correctly discovered by mypy and IDEs# VSCode requires explicit type annotationsdescribe_certificates_paginator:DescribeCertificatesPaginator=client.get_paginator("describe_certificates")describe_db_cluster_parameter_groups_paginator:DescribeDBClusterParameterGroupsPaginator=client.get_paginator("describe_db_cluster_parameter_groups")describe_db_cluster_parameters_paginator:DescribeDBClusterParametersPaginator=client.get_paginator("describe_db_cluster_parameters")describe_db_cluster_snapshots_paginator:DescribeDBClusterSnapshotsPaginator=client.get_paginator("describe_db_cluster_snapshots")describe_db_clusters_paginator:DescribeDBClustersPaginator=client.get_paginator("describe_db_clusters")describe_db_engine_versions_paginator:DescribeDBEngineVersionsPaginator=client.get_paginator("describe_db_engine_versions")describe_db_instances_paginator:DescribeDBInstancesPaginator=client.get_paginator("describe_db_instances")describe_db_subnet_groups_paginator:DescribeDBSubnetGroupsPaginator=client.get_paginator("describe_db_subnet_groups")describe_events_paginator:DescribeEventsPaginator=client.get_paginator("describe_events")describe_orderable_db_instance_options_paginator:DescribeOrderableDBInstanceOptionsPaginator=client.get_paginator("describe_orderable_db_instance_options")describe_pending_maintenance_actions_paginator:DescribePendingMaintenanceActionsPaginator=client.get_paginator("describe_pending_maintenance_actions")
服务员注释
mypy_boto3_docdb.waiter
模块包含所有等待者的类型注释。在
frommypy_boto3_docdbimportDocDBClientfrommypy_boto3_docdb.waiterimportDBInstanceAvailableWaiter,DBInstanceDeletedWaiterclient:DocDBClient=boto3.client("docdb")# Explicit type annotations are optional here# Type should be correctly discovered by mypy and IDEs# VSCode requires explicit type annotationsdb_instance_available_waiter:DBInstanceAvailableWaiter=client.get_waiter("db_instance_available")db_instance_deleted_waiter:DBInstanceDeletedWaiter=client.get_waiter("db_instance_deleted")
键入的措辞
mypy_boto3_docdb.type_defs
模块包含组合的结构和形状
以进行额外的类型检查。在
frommypy_boto3_docdb.type_defsimport(ApplyPendingMaintenanceActionResultTypeDef,AvailabilityZoneTypeDef,CertificateMessageTypeDef,CertificateTypeDef,CloudwatchLogsExportConfigurationTypeDef,CopyDBClusterParameterGroupResultTypeDef,CopyDBClusterSnapshotResultTypeDef,CreateDBClusterParameterGroupResultTypeDef,CreateDBClusterResultTypeDef,CreateDBClusterSnapshotResultTypeDef,CreateDBInstanceResultTypeDef,CreateDBSubnetGroupResultTypeDef,DBClusterMemberTypeDef,DBClusterMessageTypeDef,DBClusterParameterGroupDetailsTypeDef,DBClusterParameterGroupNameMessageTypeDef,DBClusterParameterGroupsMessageTypeDef,DBClusterParameterGroupTypeDef,DBClusterRoleTypeDef,DBClusterSnapshotAttributesResultTypeDef,DBClusterSnapshotAttributeTypeDef,DBClusterSnapshotMessageTypeDef,DBClusterSnapshotTypeDef,DBClusterTypeDef,DBEngineVersionMessageTypeDef,DBEngineVersionTypeDef,DBInstanceMessageTypeDef,DBInstanceStatusInfoTypeDef,DBInstanceTypeDef,DBSubnetGroupMessageTypeDef,DBSubnetGroupTypeDef,DeleteDBClusterResultTypeDef,DeleteDBClusterSnapshotResultTypeDef,DeleteDBInstanceResultTypeDef,DescribeDBClusterSnapshotAttributesResultTypeDef,DescribeEngineDefaultClusterParametersResultTypeDef,EndpointTypeDef,EngineDefaultsTypeDef,EventCategoriesMapTypeDef,EventCategoriesMessageTypeDef,EventsMessageTypeDef,EventTypeDef,FailoverDBClusterResultTypeDef,FilterTypeDef,ModifyDBClusterResultTypeDef,ModifyDBClusterSnapshotAttributeResultTypeDef,ModifyDBInstanceResultTypeDef,ModifyDBSubnetGroupResultTypeDef,OrderableDBInstanceOptionsMessageTypeDef,OrderableDBInstanceOptionTypeDef,PaginatorConfigTypeDef,ParameterTypeDef,PendingCloudwatchLogsExportsTypeDef,PendingMaintenanceActionsMessageTypeDef,PendingMaintenanceActionTypeDef,PendingModifiedValuesTypeDef,RebootDBInstanceResultTypeDef,ResourcePendingMaintenanceActionsTypeDef,RestoreDBClusterFromSnapshotResultTypeDef,RestoreDBClusterToPointInTimeResultTypeDef,StartDBClusterResultTypeDef,StopDBClusterResultTypeDef,SubnetTypeDef,TagListMessageTypeDef,TagTypeDef,UpgradeTargetTypeDef,VpcSecurityGroupMembershipTypeDef,WaiterConfigTypeDef,)defget_structure()->AvailabilityZoneTypeDef:return{...}
- 项目
标签: