问题标签 [docstring]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
python - 在 PyDev 中查看函数文档字符串的热键?
在 PyDev 中,当光标悬停在函数名称上时,会出现带有文档字符串文本的工具提示。
有没有办法为此事件分配一个热键,以便仅使用键盘查看文档字符串?
python - python docstring打印机问题
我正在努力通过 Zed Shaw 的 LPTHW,我在(新)练习 43 额外学分 3 中遇到了障碍。
所以在这里我试图创建一个函数,打印另一个函数,它是一个大的文档字符串。
这里是引擎
这是我试图调用来启动游戏的一些函数。
这是它在主程序中的调用方式
但我得到的只是
编辑:为了成功完成练习,我需要编辑引擎以打印出文档字符串,而不是编辑函数。
python - Python上“def”后面的字符串是什么?(不是文档字符串)
我正在 Udacity 上观看 CS262 的视频,我对这种程序定义感到困惑:
此代码使用库 ply (.lex)
我有一些 Python 经验和知识,但是我对过程定义行之后的第一行感到很困惑。
Python 解释器如何使用、解释或访问该字符串(reg. exp. string)?它只是一个未分配的字符串,没有指向它的变量。
我已经完成了通常的 Google 和 SO 搜索,但找不到它实际上是什么。
预先感谢您的所有答案和解释。
python - 在 Python 文档字符串中引用参数
我使用 Sphinx 和 autodocs 功能来确保我们的项目中有好的文档。
但是,在为方法或函数编写文档字符串时,我发现在文本中引用它们的参数很有用。但似乎没有一种结构化的方式来做到这一点。
我们可以说例如
但这没有结构,需要你记住你使用的风格,如果你改变风格,你必须追捕并杀死所有不正确的风格。
:param: 在信息字段列表之外不起作用,所以你不能写
/li>我已经看到一些项目使用 :parm: 但这没有记录并且似乎不起作用。所以他们必须有一些定制
- 我可以使用 generic_roles,但这似乎是我在解决我确信其他人遇到的问题。
所以希望我刚刚错过了一些非常明显的东西。
python - 继承父类文档字符串作为 __doc__ 属性
在 Python 类继承中有一个关于Inherit docstrings 的问题,但那里的答案涉及方法文档字符串。
我的问题是如何继承父类的文档字符串作为__doc__
属性。用例是Django rest 框架根据您的视图类的文档字符串在您的 API 的 html 版本中生成很好的文档。但是在没有文档字符串的类中继承基类(带有文档字符串)时,API 不会显示文档字符串。
很可能是 sphinx 和其他工具做了正确的事情并为我处理了文档字符串继承,但是 django rest 框架会查看 (empty).__doc__
属性。
我试过类似的东西super(SubClassWithoutDocstring, self).__doc__
,但这也只给了我一个None
.
python - 如果装饰器更改了 API,我应该如何处理装饰函数的文档字符串?
背景
我有一个库,其中包含多个读取或写入文件的函数。每个函数都接受文件作为第一个参数,可以是文件对象,也可以是文件名。因此,所有函数在开头都有相同的代码,类似于以下内容:
现在我想我可以在装饰器中编写一次并将所有功能包装在其中,而不是重复自己。(我也在考虑在同一个装饰器中实现上下文管理器接口。)
因此,如果我这样做,函数将如下所示:
问题
我担心的是现在函数的文档字符串与下面的代码不对应。(我打算用 . 保留装饰函数的文档字符串functools.wraps
。)它会降低代码的可读性/可维护性/透明度吗?据我了解,装饰器可以很容易地来来去去,但同时这有点改变了 API(我不打算删除该功能)。这种情况下的“最佳实践”方式是什么?
我可以考虑在装饰器中自动处理文档字符串,但是:
- 这不是最自然的事情;
- 这仅对在线文档有意义,并且不会帮助(相反)阅读源代码的人。
python - 使包装器显示为它在 help() 中包装的函数
不幸的是,我正在使用 python 2.4(不是选择),所以 2.5 中添加的任何美妙的东西(例如 functools)都不能帮助我
我想包装一个函数,但是让它在你做 help(wrapper) 时看起来是它包装的函数
我通过做部分实现了这一点
现在help(wrapper)
显示a
函数名称和a
文档字符串。除了感觉 hacky 之外,这不包括以下情况下的函数参数:
help(wrapper)
导致这b(*args, **kwargs)
显然不是我想要的。除非它嵌套在某个地方,否则似乎没有任何属性dir(a)
可以帮助我。
编辑:如果您可以使用 pypi,请查看有助于解决此问题的装饰器模块。
ironpython - IronPython:如何从 .NET 程序集中获取 XML 文档字符串
如何使用 IronPython 从 .NET 程序集中获取 XML 文档字符串?使用' _ doc _ '似乎不是办法。
如何获取实际的文档字符串,应该是“获取底部边缘之间的距离,以像素为单位......”
python - 如何根据python中的另一个函数自动更新函数文档字符串?
假设我有一些函数(比如 B1、B2、B3 等)调用相同的函数 A,我想在 B1、B2、B3 的文档字符串中放入一些解释函数 A 使用的参数的文本,这些已经在函数A的文档字符串中解释了。但是我不想将A的文档字符串复制到B1,然后是B2,然后是B3,然后如果我更改函数A的文档字符串,那么我必须更改B1,B2,B3 ...再次,所以我想知道是否有某种方法可以将 B1 的部分文档字符串链接到 A 的文档字符串,这样当 A 的文档字符串更新时,B1 的相应部分也会更新。这样用户就可以直接参考函数B1的docstring获取帮助信息,而无需查看A的docstring。(实际上A的参数都是kwargs)。一个简单的例子可能如下所示:
感谢您的帮助或将我推荐给其他链接,我尝试使用谷歌搜索,但没有找到目标信息。
python - 使用 ctypes 将文档字符串添加到从 dll 中提取的 python 函数
我正在尝试从 Windows dll 创建一堆 python 函数,并希望将文档字符串附加到每个新函数。
我当前的代码:
当我在解释器中运行此脚本并尝试使用该函数时,我收到“无文档字符串”消息。
无法弄清楚在那里添加一些东西。任何帮助表示赞赏。