一组pythonista存根文件
pythonista-stubs的Python项目详细描述
Python存根
用于Pythonista iOS API的存根。这允许更好的错误检测和IDE/编辑器自动完成。
安装和使用
pip install pythonista-stubs --upgrade
注意:您可能需要pip3
,特别是如果您使用自制程序安装了python3
然后可以使用mypy执行类型检查
- PyCharm:立即工作
- 波形学:vim-mypy
- emacs:使用Flycheck和Flycheck-mypy
- 崇高的文本:SublimeLinter-contrib-mypy
- 原子:linter-mypy
- vs代码:为mypy提供basic integration。
- 薄片8:flake8-mypy
另请参见:mypy integrations
API覆盖范围
Module | Status |
---|---|
appex | ✔ |
canvas | ✘ |
cb | ✘ |
clipboard | ✔ |
console | ✔ |
dialogs | ✘ |
contacts | ✘ |
editor | ✘ |
keychain | ✘ |
linguistictagger | ✘ |
location | ✘ |
motion | ✘ |
notification | ✘ |
objc_util | ✘ |
photos | ✘ |
reminders | ✔ |
scene | ✘ |
sound | ✔ |
speech | ✔ |
✘ | |
ui | ✘ |
使用
构建政治公众人物
- PEP 484 -- Type Hints
- PEP 561 -- Distributing and Packaging Type Information
- PEP 3107 -- Function Annotations
贡献
如果您发现任何问题,请file a bug report。比一个好的bug报告更优秀的是一个bug的修复,或者一个非常需要的存根的实现。我们很想得到你的贡献。
我们使用常见的github拉取请求流,这对于 如果你参与过Github上的其他项目。对于 力学,见Mypy's git and GitHub workflow help page, 或者GitHub's own documentation。
代码格式化
此项目使用pyflakes进行处理,并严格使用Black进行代码格式化。
惯例
- 长函数和方法应该用每行一个参数分开
- 所有函数体都应为空
- 喜欢
...
胜过pass
- 首选与类/函数签名在同一行的
...
- 避免在单个类中的连续模块级函数、名称或方法与字段之间出现垂直空格
- 在顶级类定义之间使用一个空行
- 不要使用docstrings
- 使用变量注释而不是类型注释
- 对于具有类型和默认值的参数,请在
=
周围使用空格
- 使用
float
而不是Union[int, float]
- 避免联合返回类型:https://github.com/python/mypy/issues/1693
- 存根中的导入被认为是私有的,除非它们使用
from library import name as name
- 尽可能避免使用
Any
类型 - 出于易读性的原因,类型变量和别名应以下划线作为前缀,以使读者清楚地看到它们不是存根api的一部分。
- 这些约定源自typeshed
行为准则
参与这个社区的每个人都应该尊重他人,并且更普遍地遵循Python Community Code of Conduct中阐述的准则。
作者
- Harold Martin-gmail上的harold.martin
免责声明
这不是一个正式项目,与omz:software无关