PVOutput API 的接口
项目描述
光伏输出
PVOutput.org python API 模块。适用于此处的 R2 API 版本规范。
从PVOutput 上的帐户页面获取您的 API 密钥
示例用法
这是一个快速的代码示例:
from pvoutput import PVOutput
import json
apikey = 'aaaaaabbbbbbccccccddddddeeeeeeffffffgggg'
systemid = 12345
pvo = PVOutput(apikey=apikey, systemid=systemid)
print(json.dumps(pvo.check_rate_limit(), indent=2))
会给你这样的输出:
{
"X-Rate-Limit-Remaining": "271",
"X-Rate-Limit-Limit": "300",
"X-Rate-Limit-Reset": "1570597200"
}
示例目录中有更多示例代码片段。
安装
Prodish 用法
python -m pip install pvoutput从 pypi 安装
开发安装东西
python -m venv venv
source venv/bin/activate
python -m pip install --upgrade pip flit
python -m flit install
输入验证
这是由pvoutput.base.PVOutputBase.validate_data函数处理的。
它需要输入数据和配置参数的字典,如下表所述:
| 字段名称 | 必需的 | 有效类型 | 描述 |
|---|---|---|---|
type |
是的 | Any |
这是一个与字段类型匹配的 python 类型对象。 |
required |
不 | bool |
这定义了该字段是否是必需的。 |
description |
不 | Any |
这当前未使用,但通常包含来自 PVOutput API Docs 的描述 |
donation_required |
不 | bool |
DonationRequired如果设置为 true,并且用户没有捐赠,如果用户尝试使用需要他们捐赠的功能,它将引发异常。这是一整件事。 |
maxlen |
不 | int |
字段的最大长度。IE。if len(field) > maxlen: raise ValueError |
maxval |
不 | int |
字段的最大值。 |
minval |
不 | int |
字段的最小值。 |
additional_validators |
不 | List[function] |
针对该字段运行的函数列表,如果出现问题,应该抛出异常。 |
示例配置
"date_val": {
"required": True,
"description": "Date",
"type": date,
"donation_required": False,
"additional_validators" : [
validate_delete_status_date
]
}
贡献/测试
pylint,black并且mypy应该在提交 PR 之前全部通过。
执照
MIT 许可证(请参阅 参考资料LICENSE),不要将它用于您关心的任何事情 - 我根本不提供任何担保,它可能会偷走您的袜子并喂饱您的狗。
变更日志
- 0.0.1 初始版本
- 0.0.2 2019-10-12 修复了一些错误
- 0.0.3 2019-10-13 添加 PVOutput.getstatus() 将当前状态作为字典返回
- 0.0.4 2019-11-05 使用 sonarqube 进行代码清理,添加了 registernotification 的错误检查
- 0.0.5 异步事物
- 0.0.6 我在上传到 pypi 时破坏了构建,在 0.0.7 中修复。
- 0.0.7 2021-12-27 #117修复 getstatus 问题
- 0.0.8 2022-01-02 @cheops 在清理我的很多烂摊子方面做得很好,而且测试要好得多。
- 0.0.10 2022-08-27 为同步客户端中的 HTTP 连接添加了显式超时。
- 0.0.11 2022-08-27 在 aiohttp 客户端中为 HTTP 连接添加了显式超时。
项目详情
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。
源分布
pvoutput-0.0.11.tar.gz
(13.1 kB
查看哈希)
内置分布
pvoutput-0.0.11-py3-none-any.whl
(15.1 kB
查看哈希)