使用 mypy-boto3-builder 7.10.0 生成的 boto3.KinesisVideoMedia 1.24.36 服务的类型注释
项目描述
mypy-boto3-kinesis-video-media
boto3.KinesisVideoMedia 1.24.36服务的类型注释 兼容VSCode、 PyCharm、 Emacs、 Sublime Text、 mypy、 pyright和其他工具。
由 mypy-boto3-builder 7.10.0 生成。
更多信息可以在 boto3-stubs页面和 mypy-boto3-kinesis-video-media docs中找到。
了解它如何帮助查找和修复潜在错误：
如何安装
VSCode 扩展
将
AWS Boto3
扩展添加到您的 VSCode 并运行AWS boto3: Quick Start命令。
单击Modify并选择boto3 common和KinesisVideoMedia。
来自带有 pip 的 PyPI
安装boto3-stubs服务KinesisVideoMedia。
# install with boto3 type annotations
python -m pip install 'boto3-stubs[kinesis-video-media]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[kinesis-video-media]'
# standalone installation
python -m pip install mypy-boto3-kinesis-video-media
如何卸载
python -m pip uninstall -y mypy-boto3-kinesis-video-media
用法
VSCode
- 安装 Python 扩展
- 安装 Pylance 扩展
- 设置
Pylance为您的 Python 语言服务器 boto3-stubs[kinesis-video-media]在您的环境中安装：
python -m pip install 'boto3-stubs[kinesis-video-media]'
类型检查和代码完成现在都应该可以工作了。不需要显式类型注释，boto3像往常一样编写代码。
PyCharm
boto3-stubs-lite[kinesis-video-media]在您的环境中安装：
python -m pip install 'boto3-stubs-lite[kinesis-video-media]'`
类型检查和代码完成现在都应该可以工作了。需要显式类型注释。
使用boto3-stubs包代替隐式类型发现。
Emacs
- 安装
boto3-stubs您在环境中使用的服务：
python -m pip install 'boto3-stubs[kinesis-video-media]'
- 安装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 使用您安装的环境
boto3-stubs
类型检查现在应该可以工作了。不需要显式类型注释，boto3像往常一样编写代码。
崇高的文本
- 安装
boto3-stubs[kinesis-video-media]您在环境中使用的服务：
python -m pip install 'boto3-stubs[kinesis-video-media]'
- 安装LSP-pyright包
类型检查现在应该可以工作了。不需要显式类型注释，boto3像往常一样编写代码。
其他 IDE
未经测试，但只要您的 IDE 支持mypyor pyright，一切都应该工作。
我的
- 安装
mypy：python -m pip install mypy boto3-stubs[kinesis-video-media]在您的环境中安装：
python -m pip install 'boto3-stubs[kinesis-video-media]'`
类型检查现在应该可以工作了。不需要显式类型注释，boto3像往常一样编写代码。
版权
- 安装
pyright：npm i -g pyright boto3-stubs[kinesis-video-media]在您的环境中安装：
python -m pip install 'boto3-stubs[kinesis-video-media]'
或者，您可以安装boto3-stubs到typings文件夹。
类型检查现在应该可以工作了。不需要显式类型注释，boto3像往常一样编写代码。
显式类型注释
客户端注释
KinesisVideoMediaClient为
boto3.client("kinesis-video-media").
from boto3.session import Session
from mypy_boto3_kinesis_video_media import KinesisVideoMediaClient
client: KinesisVideoMediaClient = Session().client("kinesis-video-media")
# now client usage is checked by mypy and IDE should provide code completion
字面量
mypy_boto3_kinesis_video_media.literals模块包含从形状中提取的文字，可在用户代码中用于类型检查。
from mypy_boto3_kinesis_video_media.literals import (
StartSelectorTypeType,
KinesisVideoMediaServiceName,
ServiceName,
ResourceServiceName,
RegionName,
)
def check_value(value: StartSelectorTypeType) -> bool:
...
打字字典
mypy_boto3_kinesis_video_media.type_defs模块包含组装到类型化字典的结构和形状，以进行额外的类型检查。
from mypy_boto3_kinesis_video_media.type_defs import (
StartSelectorTypeDef,
ResponseMetadataTypeDef,
GetMediaInputRequestTypeDef,
GetMediaOutputTypeDef,
)
def get_structure() -> StartSelectorTypeDef:
return {
...
}
这个怎么运作
全自动
的mypy-boto3-builder为每个服务仔细生成类型注解，耐心等待boto3
更新。它为您提供插入式注释，并确保：
- 涵盖所有可用
boto3服务。 - 每个
boto3服务的每个公共类和方法都会从文档中提取有效的类型注释（botocore如果类型不正确，请归咎于文档）。 - 类型注释包括最新的文档。
- 每种方法都提供了文档链接。
- 为了可读性，代码由black和 isort处理。
什么是新的
实现的功能
- 全类型注释
boto3和botocore库aiobotocore mypy,pyright,VSCode,PyCharm,Sublime Text和Emacs兼容性Client,ServiceResource,Resource,WaiterPaginator为每个服务键入注释TypeDefs为每个服务生成Literals为每个服务生成- 自动发现类型
boto3.client和boto3.session调用 - 自动发现类型
session.client和session.session调用 - 自动发现类型
client.get_waiter和client.get_paginator调用 - 自动发现类型
ServiceResource和Resource集合 - 自动发现
aiobotocore.Session.create_client呼叫类型
最新变化
生成器更改日志可以在 Releases中找到。
版本控制
mypy-boto3-kinesis-video-media版本与相关boto3版本相同，遵循PEP 440格式。
谢谢
- Allie Fitter for boto3-type-annotations，这个包是基于他的工作
- 一个很棒的格式化工具的黑人开发者
- 蒂莫西·埃德蒙·克罗斯利 (Timothy Edmund Crosley ) 的 isort及其灵活度
- mypy开发人员为我们做了所有肮脏的工作
- pyright团队为类型化 Python 的新时代
文档
所有服务类型注释都可以在 boto3 文档中找到
支持和贡献
这个包是自动生成的。请在mypy-boto3-builder存储库中报告任何错误或请求新功能 。
