由mypyboto3buider4.2.0生成的boto3.S3 1.16.35服务的类型注释
mypy-boto3-s3的Python项目详细描述
mypy-boto3-s3型
的类型批注 boto3.S3 1.16.35服务 兼容 VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright 以及其他工具。在
更多信息可在boto3-stubs页找到。在
了解它如何帮助查找和修复潜在的错误:
如何安装
为S3
服务安装boto3-stubs
。在
python -m pip install boto3-stubs[s3]
使用
VSCode
- 安装Python extension
- 安装Pylance extension
- 将
Pylance
设置为Python语言服务器 - 在您的环境中安装
boto-stubs[s3]
:python -m pip install 'boto3-stubs[s3]'
类型检查和自动完成都应该适用于S3
服务。
不需要显式的类型注释,请照常编写boto3
代码。在
PyCharm
- 在您的环境中安装
boto-stubs[s3]
:python -m pip install 'boto3-stubs[s3]'
类型检查和自动完成都应该适用于S3
服务。
不需要显式的类型注释,请照常编写boto3
代码。
自动完成在大型项目或安装了大量boto3-stubs
子模块时可能会很慢。在
其他IDE
没有经过测试,但是只要您的IDE支持mypy
或{
mypy
- 安装
mypy
:python -m pip install mypy
- 在您的环境中安装
boto-stubs[s3]
:python -m pip install 'boto3-stubs[s3]'
- 像往常一样运行
mypy
类型检查应该适用于S3
服务。
不需要显式的类型注释,请照常编写boto3
代码。在
pyright
- 安装
pyright
:yarn global add pyright
- 在您的环境中安装
boto-stubs[s3]
:python -m pip install 'boto3-stubs[s3]'
- 或者,您可以将
boto3-stubs
安装到typings
文件夹中。在
类型检查应该适用于S3
服务。
不需要显式的类型注释,请照常编写boto3
代码。在
显式类型批注
客户端注释
S3Client
为boto3.client("s3")
提供注释。在
分页器注释
mypy_boto3_s3.paginator
模块包含所有分页器的类型注释。在
frommypy_boto3_s3importS3Clientfrommypy_boto3_s3.paginatorimport(ListMultipartUploadsPaginator,ListObjectsPaginator,ListObjectsV2Paginator,ListObjectVersionsPaginator,ListPartsPaginator,)client:S3Client=boto3.client("s3")# Explicit type annotations are optional here# Type should be correctly discovered by mypy and IDEs# VSCode requires explicit type annotationslist_multipart_uploads_paginator:ListMultipartUploadsPaginator=client.get_paginator("list_multipart_uploads")list_object_versions_paginator:ListObjectVersionsPaginator=client.get_paginator("list_object_versions")list_objects_paginator:ListObjectsPaginator=client.get_paginator("list_objects")list_objects_v2_paginator:ListObjectsV2Paginator=client.get_paginator("list_objects_v2")list_parts_paginator:ListPartsPaginator=client.get_paginator("list_parts")
服务员注释
mypy_boto3_s3.waiter
模块包含所有等待者的类型注释。在
frommypy_boto3_s3importS3Clientfrommypy_boto3_s3.waiterimport(BucketExistsWaiter,BucketNotExistsWaiter,ObjectExistsWaiter,ObjectNotExistsWaiter,)client:S3Client=boto3.client("s3")# Explicit type annotations are optional here# Type should be correctly discovered by mypy and IDEs# VSCode requires explicit type annotationsbucket_exists_waiter:BucketExistsWaiter=client.get_waiter("bucket_exists")bucket_not_exists_waiter:BucketNotExistsWaiter=client.get_waiter("bucket_not_exists")object_exists_waiter:ObjectExistsWaiter=client.get_waiter("object_exists")object_not_exists_waiter:ObjectNotExistsWaiter=client.get_waiter("object_not_exists")
服务资源注释
S3ServiceResource
为boto3.resource("s3")
提供注释。在
frommypy_boto3_s3importS3ServiceResourceresource:S3ServiceResource=boto3.resource("s3")# now resource usage is checked by mypy and IDE should provide code auto-complete# works for session as wellsession=boto3.session.Session(region="us-west-1")session_resource:S3ServiceResource=session.resource("s3")
其他资源注释
mypy_boto3_s3.service_resource
模块包含所有资源的类型注释。在
frommypy_boto3_s3importS3ServiceResourcefrommypy_boto3_s3.service_resourceimport(Bucket,BucketAcl,BucketCors,BucketLifecycle,BucketLifecycleConfiguration,BucketLogging,BucketNotification,BucketPolicy,BucketRequestPayment,BucketTagging,BucketVersioning,BucketWebsite,MultipartUpload,MultipartUploadPart,Object,ObjectAcl,ObjectSummary,ObjectVersion,)resource:S3ServiceResource=boto3.resource("s3")# Explicit type annotations are optional here# Type should be correctly discovered by mypy and IDEsmy_bucket:Bucket=resource.Bucket(...)my_bucket_acl:BucketAcl=resource.BucketAcl(...)my_bucket_cors:BucketCors=resource.BucketCors(...)my_bucket_lifecycle:BucketLifecycle=resource.BucketLifecycle(...)my_bucket_lifecycle_configuration:BucketLifecycleConfiguration=resource.BucketLifecycleConfiguration(...)my_bucket_logging:BucketLogging=resource.BucketLogging(...)my_bucket_notification:BucketNotification=resource.BucketNotification(...)my_bucket_policy:BucketPolicy=resource.BucketPolicy(...)my_bucket_request_payment:BucketRequestPayment=resource.BucketRequestPayment(...)my_bucket_tagging:BucketTagging=resource.BucketTagging(...)my_bucket_versioning:BucketVersioning=resource.BucketVersioning(...)my_bucket_website:BucketWebsite=resource.BucketWebsite(...)my_multipart_upload:MultipartUpload=resource.MultipartUpload(...)my_multipart_upload_part:MultipartUploadPart=resource.MultipartUploadPart(...)my_object:Object=resource.Object(...)my_object_acl:ObjectAcl=resource.ObjectAcl(...)my_object_summary:ObjectSummary=resource.ObjectSummary(...)my_object_version:ObjectVersion=resource.ObjectVersion(...)
集合注释
mypy_boto3_s3.service_resource
模块包含类型注释
对于所有S3ServiceResource
集合。在
frommypy_boto3_s3importS3ServiceResourcefrommypy_boto3_s3.service_resourceimportServiceResourceBucketsCollectionresource:S3ServiceResource=boto3.resource("s3")# Explicit type annotations are optional here# Type should be correctly discovered by mypy and IDEsbuckets:s3_resources.ServiceResourceBucketsCollection=resource.buckets
键入的措辞
mypy_boto3_s3.type_defs
模块包含组装的结构和形状
以进行额外的类型检查。在
frommypy_boto3_s3.type_defsimport(AbortIncompleteMultipartUploadTypeDef,AbortMultipartUploadOutputTypeDef,AccelerateConfigurationTypeDef,AccessControlPolicyTypeDef,AccessControlTranslationTypeDef,AnalyticsAndOperatorTypeDef,AnalyticsConfigurationTypeDef,AnalyticsExportDestinationTypeDef,AnalyticsFilterTypeDef,AnalyticsS3BucketDestinationTypeDef,BucketLifecycleConfigurationTypeDef,BucketLoggingStatusTypeDef,BucketTypeDef,CloudFunctionConfigurationTypeDef,CommonPrefixTypeDef,CompletedMultipartUploadTypeDef,CompletedPartTypeDef,CompleteMultipartUploadOutputTypeDef,ConditionTypeDef,CopyObjectOutputTypeDef,CopyObjectResultTypeDef,CopyPartResultTypeDef,CopySourceTypeDef,CORSConfigurationTypeDef,CORSRuleTypeDef,CreateBucketConfigurationTypeDef,CreateBucketOutputTypeDef,CreateMultipartUploadOutputTypeDef,CSVInputTypeDef,CSVOutputTypeDef,DefaultRetentionTypeDef,DeletedObjectTypeDef,DeleteMarkerEntryTypeDef,DeleteMarkerReplicationTypeDef,DeleteObjectOutputTypeDef,DeleteObjectsOutputTypeDef,DeleteObjectTaggingOutputTypeDef,DeleteTypeDef,DestinationTypeDef,EncryptionConfigurationTypeDef,EncryptionTypeDef,ErrorDocumentTypeDef,ErrorTypeDef,ExistingObjectReplicationTypeDef,FilterRuleTypeDef,GetBucketAccelerateConfigurationOutputTypeDef,GetBucketAclOutputTypeDef,GetBucketAnalyticsConfigurationOutputTypeDef,GetBucketCorsOutputTypeDef,GetBucketEncryptionOutputTypeDef,GetBucketIntelligentTieringConfigurationOutputTypeDef,GetBucketInventoryConfigurationOutputTypeDef,GetBucketLifecycleConfigurationOutputTypeDef,GetBucketLifecycleOutputTypeDef,GetBucketLocationOutputTypeDef,GetBucketLoggingOutputTypeDef,GetBucketMetricsConfigurationOutputTypeDef,GetBucketOwnershipControlsOutputTypeDef,GetBucketPolicyOutputTypeDef,GetBucketPolicyStatusOutputTypeDef,GetBucketReplicationOutputTypeDef,GetBucketRequestPaymentOutputTypeDef,GetBucketTaggingOutputTypeDef,GetBucketVersioningOutputTypeDef,GetBucketWebsiteOutputTypeDef,GetObjectAclOutputTypeDef,GetObjectLegalHoldOutputTypeDef,GetObjectLockConfigurationOutputTypeDef,GetObjectOutputTypeDef,GetObjectRetentionOutputTypeDef,GetObjectTaggingOutputTypeDef,GetObjectTorrentOutputTypeDef,GetPublicAccessBlockOutputTypeDef,GlacierJobParametersTypeDef,GranteeTypeDef,GrantTypeDef,HeadObjectOutputTypeDef,IndexDocumentTypeDef,InitiatorTypeDef,InputSerializationTypeDef,IntelligentTieringAndOperatorTypeDef,IntelligentTieringConfigurationTypeDef,IntelligentTieringFilterTypeDef,InventoryConfigurationTypeDef,InventoryDestinationTypeDef,InventoryEncryptionTypeDef,InventoryFilterTypeDef,InventoryS3BucketDestinationTypeDef,InventoryScheduleTypeDef,JSONInputTypeDef,JSONOutputTypeDef,LambdaFunctionConfigurationTypeDef,LifecycleConfigurationTypeDef,LifecycleExpirationTypeDef,LifecycleRuleAndOperatorTypeDef,LifecycleRuleFilterTypeDef,LifecycleRuleTypeDef,ListBucketAnalyticsConfigurationsOutputTypeDef,ListBucketIntelligentTieringConfigurationsOutputTypeDef,ListBucketInventoryConfigurationsOutputTypeDef,ListBucketMetricsConfigurationsOutputTypeDef,ListBucketsOutputTypeDef,ListMultipartUploadsOutputTypeDef,ListObjectsOutputTypeDef,ListObjectsV2OutputTypeDef,ListObjectVersionsOutputTypeDef,ListPartsOutputTypeDef,LoggingEnabledTypeDef,MetadataEntryTypeDef,MetricsAndOperatorTypeDef,MetricsConfigurationTypeDef,MetricsFilterTypeDef,MetricsTypeDef,MultipartUploadTypeDef,NoncurrentVersionExpirationTypeDef,NoncurrentVersionTransitionTypeDef,NotificationConfigurationDeprecatedTypeDef,NotificationConfigurationFilterTypeDef,NotificationConfigurationTypeDef,ObjectIdentifierTypeDef,ObjectLockConfigurationTypeDef,ObjectLockLegalHoldTypeDef,ObjectLockRetentionTypeDef,ObjectLockRuleTypeDef,ObjectTypeDef,ObjectVersionTypeDef,OutputLocationTypeDef,OutputSerializationTypeDef,OwnershipControlsRuleTypeDef,OwnershipControlsTypeDef,OwnerTypeDef,PaginatorConfigTypeDef,PartTypeDef,PolicyStatusTypeDef,ProgressEventTypeDef,ProgressTypeDef,PublicAccessBlockConfigurationTypeDef,PutObjectAclOutputTypeDef,PutObjectLegalHoldOutputTypeDef,PutObjectLockConfigurationOutputTypeDef,PutObjectOutputTypeDef,PutObjectRetentionOutputTypeDef,PutObjectTaggingOutputTypeDef,QueueConfigurationDeprecatedTypeDef,QueueConfigurationTypeDef,RecordsEventTypeDef,RedirectAllRequestsToTypeDef,RedirectTypeDef,ReplicaModificationsTypeDef,ReplicationConfigurationTypeDef,ReplicationRuleAndOperatorTypeDef,ReplicationRuleFilterTypeDef,ReplicationRuleTypeDef,ReplicationTimeTypeDef,ReplicationTimeValueTypeDef,RequestPaymentConfigurationTypeDef,RequestProgressTypeDef,ResponseMetadata,RestoreObjectOutputTypeDef,RestoreRequestTypeDef,RoutingRuleTypeDef,RuleTypeDef,S3KeyFilterTypeDef,S3LocationTypeDef,ScanRangeTypeDef,SelectObjectContentEventStreamTypeDef,SelectObjectContentOutputTypeDef,SelectParametersTypeDef,ServerSideEncryptionByDefaultTypeDef,ServerSideEncryptionConfigurationTypeDef,ServerSideEncryptionRuleTypeDef,SourceSelectionCriteriaTypeDef,SseKmsEncryptedObjectsTypeDef,SSEKMSTypeDef,StatsEventTypeDef,StatsTypeDef,StorageClassAnalysisDataExportTypeDef,StorageClassAnalysisTypeDef,TaggingTypeDef,TagTypeDef,TargetGrantTypeDef,TieringTypeDef,TopicConfigurationDeprecatedTypeDef,TopicConfigurationTypeDef,TransitionTypeDef,UploadPartCopyOutputTypeDef,UploadPartOutputTypeDef,VersioningConfigurationTypeDef,WaiterConfigTypeDef,WebsiteConfigurationTypeDef,)defget_structure()->AbortIncompleteMultipartUploadTypeDef:return{...}
- 项目
标签: