使用 mypy-boto3-builder 7.11.10 生成的 aiobotocore.MediaConnect 2.4.0 服务的类型注释
项目描述
类型-aiobotocore-mediaconnect
aiobotocore.MediaConnect 2.4.0服务的类型注释 兼容VSCode、 PyCharm、 Emacs、 Sublime Text、 mypy、 pyright和其他工具。
由 mypy-boto3-builder 7.11.10 生成。
更多信息可以在 types-aiobotocore页面和 types-aiobotocore-mediaconnect 文档中找到。
了解它如何帮助查找和修复潜在错误:
如何安装
来自带有 pip 的 PyPI
安装types-aiobotocore
服务MediaConnect
。
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[mediaconnect]'
# 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[mediaconnect]'
# standalone installation
python -m pip install types-aiobotocore-mediaconnect
如何卸载
python -m pip uninstall -y types-aiobotocore-mediaconnect
用法
VSCode
- 安装 Python 扩展
- 安装 Pylance 扩展
- 设置
Pylance
为您的 Python 语言服务器 types-aiobotocore[mediaconnect]
在您的环境中安装:
python -m pip install 'types-aiobotocore[mediaconnect]'
类型检查和代码完成现在都应该可以工作了。不需要显式类型注释,aiobotocore
像往常一样编写代码。
PyCharm
types-aiobotocore-lite[mediaconnect]
在您的环境中安装:
python -m pip install 'types-aiobotocore-lite[mediaconnect]'`
类型检查和代码完成现在都应该可以工作了。需要显式类型注释。
使用types-aiobotocore
包代替隐式类型发现。
Emacs
- 安装
types-aiobotocore
您在环境中使用的服务:
python -m pip install 'types-aiobotocore[mediaconnect]'
- 安装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[mediaconnect]
您在环境中使用的服务:
python -m pip install 'types-aiobotocore[mediaconnect]'
- 安装LSP-pyright包
类型检查现在应该可以工作了。不需要显式类型注释,aiobotocore
像往常一样编写代码。
其他 IDE
未经测试,但只要您的 IDE 支持mypy
or pyright
,一切都应该工作。
我的
- 安装
mypy
:python -m pip install mypy
types-aiobotocore[mediaconnect]
在您的环境中安装:
python -m pip install 'types-aiobotocore[mediaconnect]'`
类型检查现在应该可以工作了。不需要显式类型注释,aiobotocore
像往常一样编写代码。
版权
- 安装
pyright
:npm i -g pyright
types-aiobotocore[mediaconnect]
在您的环境中安装:
python -m pip install 'types-aiobotocore[mediaconnect]'
或者,您可以安装types-aiobotocore
到typings
文件夹。
类型检查现在应该可以工作了。不需要显式类型注释,aiobotocore
像往常一样编写代码。
显式类型注释
客户端注释
MediaConnectClient
为
session.create_client("mediaconnect")
.
from aiobotocore.session import get_session
from types_aiobotocore_mediaconnect import MediaConnectClient
session = get_session()
async with session.create_client("mediaconnect") as client:
client: MediaConnectClient
# now client usage is checked by mypy and IDE should provide code completion
分页器注释
types_aiobotocore_mediaconnect.paginator
模块包含所有分页器的类型注释。
from aiobotocore.session import get_session
from types_aiobotocore_mediaconnect import MediaConnectClient
from types_aiobotocore_mediaconnect.paginator import (
ListEntitlementsPaginator,
ListFlowsPaginator,
ListOfferingsPaginator,
ListReservationsPaginator,
)
session = get_session()
async with session.create_client("mediaconnect") as client:
client: MediaConnectClient
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_entitlements_paginator: ListEntitlementsPaginator = client.get_paginator(
"list_entitlements"
)
list_flows_paginator: ListFlowsPaginator = client.get_paginator("list_flows")
list_offerings_paginator: ListOfferingsPaginator = client.get_paginator("list_offerings")
list_reservations_paginator: ListReservationsPaginator = client.get_paginator(
"list_reservations"
)
服务员注释
types_aiobotocore_mediaconnect.waiter
模块包含所有服务员的类型注释。
from aiobotocore.session import get_session
from types_aiobotocore_mediaconnect.client import MediaConnectClient
from types_aiobotocore_mediaconnect.waiter import (
FlowActiveWaiter,
FlowDeletedWaiter,
FlowStandbyWaiter,
)
session = get_session()
async with session.create_client("mediaconnect") as client:
client: MediaConnectClient
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
flow_active_waiter: FlowActiveWaiter = client.get_waiter("flow_active")
flow_deleted_waiter: FlowDeletedWaiter = client.get_waiter("flow_deleted")
flow_standby_waiter: FlowStandbyWaiter = client.get_waiter("flow_standby")
字面量
types_aiobotocore_mediaconnect.literals
模块包含从形状中提取的文字,可在用户代码中用于类型检查。
from types_aiobotocore_mediaconnect.literals import (
AlgorithmType,
ColorimetryType,
DurationUnitsType,
EncoderProfileType,
EncodingNameType,
EntitlementStatusType,
FailoverModeType,
FlowActiveWaiterName,
FlowDeletedWaiterName,
FlowStandbyWaiterName,
KeyTypeType,
ListEntitlementsPaginatorName,
ListFlowsPaginatorName,
ListOfferingsPaginatorName,
ListReservationsPaginatorName,
MaintenanceDayType,
MediaStreamTypeType,
NetworkInterfaceTypeType,
PriceUnitsType,
ProtocolType,
RangeType,
ReservationStateType,
ResourceTypeType,
ScanModeType,
SourceTypeType,
StateType,
StatusType,
TcsType,
MediaConnectServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: AlgorithmType) -> bool:
...
打字字典
types_aiobotocore_mediaconnect.type_defs
模块包含组装到类型化字典的结构和形状,以进行额外的类型检查。
from types_aiobotocore_mediaconnect.type_defs import (
ResponseMetadataTypeDef,
VpcInterfaceRequestTypeDef,
VpcInterfaceTypeDef,
AddMaintenanceTypeDef,
EncryptionTypeDef,
VpcInterfaceAttachmentTypeDef,
DeleteFlowRequestRequestTypeDef,
WaiterConfigTypeDef,
DescribeFlowRequestRequestTypeDef,
MessagesTypeDef,
DescribeOfferingRequestRequestTypeDef,
DescribeReservationRequestRequestTypeDef,
InterfaceRequestTypeDef,
InterfaceTypeDef,
EncodingParametersRequestTypeDef,
EncodingParametersTypeDef,
SourcePriorityTypeDef,
MaintenanceTypeDef,
FmtpRequestTypeDef,
FmtpTypeDef,
PaginatorConfigTypeDef,
ListEntitlementsRequestRequestTypeDef,
ListedEntitlementTypeDef,
ListFlowsRequestRequestTypeDef,
ListOfferingsRequestRequestTypeDef,
ListReservationsRequestRequestTypeDef,
ListTagsForResourceRequestRequestTypeDef,
ResourceSpecificationTypeDef,
TransportTypeDef,
PurchaseOfferingRequestRequestTypeDef,
RemoveFlowMediaStreamRequestRequestTypeDef,
RemoveFlowOutputRequestRequestTypeDef,
RemoveFlowSourceRequestRequestTypeDef,
RemoveFlowVpcInterfaceRequestRequestTypeDef,
RevokeFlowEntitlementRequestRequestTypeDef,
StartFlowRequestRequestTypeDef,
StopFlowRequestRequestTypeDef,
TagResourceRequestRequestTypeDef,
UntagResourceRequestRequestTypeDef,
UpdateEncryptionTypeDef,
UpdateMaintenanceTypeDef,
DeleteFlowResponseTypeDef,
EmptyResponseMetadataTypeDef,
ListTagsForResourceResponseTypeDef,
RemoveFlowMediaStreamResponseTypeDef,
RemoveFlowOutputResponseTypeDef,
RemoveFlowSourceResponseTypeDef,
RemoveFlowVpcInterfaceResponseTypeDef,
RevokeFlowEntitlementResponseTypeDef,
StartFlowResponseTypeDef,
StopFlowResponseTypeDef,
AddFlowVpcInterfacesRequestRequestTypeDef,
AddFlowVpcInterfacesResponseTypeDef,
EntitlementTypeDef,
GrantEntitlementRequestTypeDef,
DescribeFlowRequestFlowActiveWaitTypeDef,
DescribeFlowRequestFlowDeletedWaitTypeDef,
DescribeFlowRequestFlowStandbyWaitTypeDef,
DestinationConfigurationRequestTypeDef,
InputConfigurationRequestTypeDef,
DestinationConfigurationTypeDef,
InputConfigurationTypeDef,
FailoverConfigTypeDef,
UpdateFailoverConfigTypeDef,
ListedFlowTypeDef,
MediaStreamAttributesRequestTypeDef,
MediaStreamAttributesTypeDef,
ListEntitlementsRequestListEntitlementsPaginateTypeDef,
ListFlowsRequestListFlowsPaginateTypeDef,
ListOfferingsRequestListOfferingsPaginateTypeDef,
ListReservationsRequestListReservationsPaginateTypeDef,
ListEntitlementsResponseTypeDef,
OfferingTypeDef,
ReservationTypeDef,
UpdateFlowEntitlementRequestRequestTypeDef,
GrantFlowEntitlementsResponseTypeDef,
UpdateFlowEntitlementResponseTypeDef,
GrantFlowEntitlementsRequestRequestTypeDef,
MediaStreamOutputConfigurationRequestTypeDef,
MediaStreamSourceConfigurationRequestTypeDef,
MediaStreamOutputConfigurationTypeDef,
MediaStreamSourceConfigurationTypeDef,
UpdateFlowRequestRequestTypeDef,
ListFlowsResponseTypeDef,
AddMediaStreamRequestTypeDef,
UpdateFlowMediaStreamRequestRequestTypeDef,
MediaStreamTypeDef,
DescribeOfferingResponseTypeDef,
ListOfferingsResponseTypeDef,
DescribeReservationResponseTypeDef,
ListReservationsResponseTypeDef,
PurchaseOfferingResponseTypeDef,
AddOutputRequestTypeDef,
UpdateFlowOutputRequestRequestTypeDef,
SetSourceRequestTypeDef,
UpdateFlowSourceRequestRequestTypeDef,
OutputTypeDef,
SourceTypeDef,
AddFlowMediaStreamsRequestRequestTypeDef,
AddFlowMediaStreamsResponseTypeDef,
UpdateFlowMediaStreamResponseTypeDef,
AddFlowOutputsRequestRequestTypeDef,
AddFlowSourcesRequestRequestTypeDef,
CreateFlowRequestRequestTypeDef,
AddFlowOutputsResponseTypeDef,
UpdateFlowOutputResponseTypeDef,
AddFlowSourcesResponseTypeDef,
FlowTypeDef,
UpdateFlowSourceResponseTypeDef,
CreateFlowResponseTypeDef,
DescribeFlowResponseTypeDef,
UpdateFlowResponseTypeDef,
)
def get_structure() -> ResponseMetadataTypeDef:
return {...}
这个怎么运作
全自动
的mypy-boto3-builder为每个服务仔细生成类型注解,耐心等待
aiobotocore
更新。它为您提供插入式注释,并确保:
- 涵盖所有可用
aiobotocore
服务。 - 每个
aiobotocore
服务的每个公共类和方法都会从文档中提取有效的类型注释(botocore
如果类型不正确,请归咎于文档)。 - 类型注释包括最新的文档。
- 每种方法都提供了文档链接。
- 为了可读性,代码由black和 isort处理。
什么是新的
实现的功能
- 全类型注释
boto3
和botocore
库aiobotocore
mypy
,pyright
,VSCode
,PyCharm
,Sublime Text
和Emacs
兼容性Client
,ServiceResource
,Resource
,Waiter
Paginator
为每个服务键入注释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-mediaconnect
版本与相关aiobotocore
版本相同,遵循PEP 440
格式。
谢谢
- Allie Fitter for boto3-type-annotations,这个包是基于他的工作
- 一个很棒的格式化工具的黑人开发者
- 蒂莫西·埃德蒙·克罗斯利 (Timothy Edmund Crosley ) 的 isort及其灵活度
- mypy开发人员为我们做了所有肮脏的工作
- pyright团队为类型化 Python 的新时代
文档
所有服务类型注释都可以在 aiobotocore 文档中找到
支持和贡献
这个包是自动生成的。请在mypy-boto3-builder存储库中报告任何错误或请求新功能 。