Pycharm, 针对Python2 的type hint docstring 是否有某种简化的方式 ?
2017/2/13
描述
实际现象
期望借助Pycharm的type hint, 提升Python2的编码体验
但是 :type:
和 :param:
分开写, 导致不必要的冗余
预期现象
能够合在一起写, 可以看到:type:
根本没必要分开
重现步骤
拷贝相关代码到Pycharm中
然后试着调用该函数
在Pycharm中查看该函数的签名
相关代码
一段示例(可以看到, type 和 param 分开了, 导致不必要的冗余)
def test(arg1, arg2, arg3):
"""A test function
要是能够合二为一就好了, 但是又不能失掉类型提示的功能
比如 :param str arg1: arg1 is first argument
:type arg1: str
:param arg1:
:type arg2: dict
:param arg2:
:type arg3: list
:param arg3:
:rtype: list
:return:
"""
for item in ('hello', 'world', 'good'):
arg3.append(item)
return range(100)
from __future__ import absolute_import, unicode_literals
from datetime import datetime
def test(arg1, arg2, arg3, func, generic, arg4):
"""A test function
:type arg1: (str, int)
:param arg1:
:type arg2: dict[str, str]
:param arg2:
:type arg3: list
:param arg3:
:type func: (str, int) -> list
:param func:
:type generic: T
:param generic:
:type arg4: list[dict[str, datetime]]
:rtype: (str, int)
:return:
"""
for item in ('hello', 'world', 'good'):
arg3.append(item)
return ('hezhiming', 23)
test()
上下文环境
Pycharm4.5
Python2.7.x
Windows 10
尝试解决
官方文档, 没有给出明确的帮助: https://www.jetbrains.com/hel...
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论