首页 > TAG信息列表 > Docstring

关于Python docstring几种主流风格

今天在整理Python文档的时候，发现除了目前在用的如下格式外，还有很多种。就简单整理一下。 def foo(bar: str) -> str: """ foo function :param str bar: bar :return: return bar :rtype: str """ return bar 目前流行的格式有如下几种，我

python笔记30-docstring注释添加变量

前言 python里面添加字符串注释非常简单，如何将变量放入 python 的函数注释里面呢？ docstring也就是给代码加注释的内容了，python可以给函数，类、方法，模块添加注释内容，注释标准格式一般是三个双引号，如："""美程序员枪击4同事，竟因代码不写注释？""" docstring 先看一个简单案例，在函数里面

如何修改 BeautifulReport 中每一个用例的描述

 ddt文件中的ddt()方法把原来的test_data_docstring = _get_test_data_docstring(func, v)注释掉如果数据是用对象来保存的，就添加test_data_docstring = v.title如果数据使用字典来保存的，就添加test_data_docstring = v["title"]修改后生成的测试报告就能把title列显示到

结构化的python文档字符串,对IDE友好

在PHP中,我习惯了PHPdoc语法： /** Do something useful @param first Primary data @return int @throws BadException */ function($first){ ... —简短有用的参考：当您只需要记住“那是什么？”时,非常方便,尤其是对于第三方库.另外,所有IDE都可以在弹出提示中显示此内容. 似乎P

带有vim pythoncomplete的Python文档字符串未显示我自己的类函数的换行符

尝试在自己的类函数上使用Python Omni Completion时,出现一些意外结果.函数的文档字符串未使用换行符正确格式化,如下图所示： 当我从标准python库导入模块时,得到的结果是我期望的： 根据python docstring conventions,源文件中的换行符应解释为换行符.有谁知道这是怎么回事,也许怎么

python-sphinx：通过raw :: latex包含.tex文件

我想在狮身人面像中包含乳胶文档. sphinx html构建不包括使用.. raw :: latex指令链接的乳胶文件.我有 这是我的目录结构 docs/ source/ importlatex.rst index.rst build/ tex/ texfile.tex index.rst看起来像 Welcome to documentation!

python-epydoc隐藏一些类函数？

我的班上有一些方法,只能供该班的其他方法使用.我已经给他们的名字加上了“ _”.我可以对epydoc隐藏这些功能吗？这是个好主意吗？ 我应该使用“ _”还是双下划线？老实说,在某些地方阅读了它们之后,我没有发现任何不同.是否应仅在模块/类(实例)函数上使用此命名约定？还是变量？解决方法:如

解析Python模块文档字符串

是否可以使用AST解析模块级文档字符串？ 我正在使用python documenter here并访问模块令牌,而抓取文档不会产生模块级docstring.到目前为止,我不得不求助于导入模块并获取其__doc__或使用inspect来获取文档. 我查看了pydoc module来源,以了解其他文档编制者如何解析docstrings的线索,

python-如何使用epytext为PyCharm中的自动完成提示记录kwarg？

是否可以获取有关kwargs的其他提示,这将为您提供预定义可能的关键字参数的示例？也许epytext不支持它？ class Person(): def __init__(self, **kwargs): """ @param name: Name @type name: str @param age: Age @type age: int

Code Search

简介 本次作业的主题是 Code Search，即使用更自然的方式搜索代码，是对传统代码搜索的一种改进。一种最自然的方法去搜索代码则是使用自然语言去搜索代码，描述需要的代码的功能，搜索系统返回与此类似的代码片段或函数。 本次结对编程我和队友分别调研复现了两个不同的 Code Search 方法

在python中具有多行和单行字符串文字的优点是什么？

我知道三重引号字符串用作文档字符串,但是是否真的需要两个字符串文字？ 在单行和两行之间进行标识时,是否有任何用例？多行很有用. 在Clojure中,我们有1个字符串文字,它是多行的,我们将其用作docstring.那么为什么python有区别呢？解决方法:明确说明创建多行字符串文字的优点可能通过以

加载模块时,Python文档字符串和注释是否存储在内存中？

Are Python docstrings and comments stored in memory when a module is loaded? 我想知道这是否属实,因为我通常会很好地记录我的代码;这可能会影响内存使用吗？ 通常每个Python对象都有一个__doc__方法.这些文档字符串是从文件中读取还是以其他方式处理？ 我在论坛,谷歌和邮件列

如何在Sphinx处理的文档字符串中为单个参数或返回值表达多个类型？

有时Python中的函数可能接受灵活类型的参数.或者它可以返回灵活类型的值.现在我不记得现在这样一个功能的一个很好的例子,因此我在下面用玩具示例展示这样的功能可能是什么样子. 我想知道如何使用Sphinx文档表示法为这些函数编写文档字符串.在下面的示例中,参数可以是str或int.同样

如何用doxygen记录Python代码

我喜欢doxygen来创建C或PHP代码的文档.我有一个即将推出的Python项目,我想我记得Python没有/ * .. * / comments,并且还有自己的自我文档工具,这似乎是pythonic的文档方式. 由于我熟悉doxygen,我如何使用它来生成我的Python文档？有什么特别需要注意的吗？解决方法:这是documented on t

如何在Python中记录类属性？

我正在编写一个轻量级类,其属性旨在可公开访问,并且有时仅在特定实例中被覆盖.在Python语言中没有为类属性或任何类型的属性创建文档字符串的规定.记录这些属性的可接受方式是什么？目前我正在做这样的事情： class Albatross(object): """A bird with a flight speed exceeding t

如何在Python中注释掉一段代码

参见英文答案 > Why doesn’t Python have multiline comments?                                    17个 有没有一种机制可以注释掉大块的Python代码？ 现在,我可以看到注释代码的唯一方法是使用#开始每一行,或者用三引号括起代码：“”“. 这些

什么是标准的Python文档字符串格式？

我在Python中看过几种不同风格的文档字符串,是否有官方或“同意”的风格？解决方法:格式 Python文档字符串可以按照其他帖子显示的几种格式编写.但是没有提到默认的Sphinx文档字符串格式,它基于reStructuredText(reST).您可以在that tuto中获得有关主要格式的一些信息. 请注意,PEP 28

Python上“def”之后的字符串是什么？ (不是文档字符串)

我正在观看关于Udacity的CS262的视频,我对这种程序定义感到困惑： def t_WORD(token): r'[^ <>]+' # any reg. exp. ruleset is placed here # ... more processing # ... more processing return token 此代码使用库层(.lex) 我有一些Python的经验和知识,但我对此

Python：为什么这个doc测试失败了？

doctest中的这段代码在单独运行时起作用,但在这个doctest中,它在10个地方失败了.我无法弄清楚它为什么会这样.以下是整个模块： class requireparams(object): """ >>> @requireparams(['name', 'pass', 'code']) >>> def complex_function(params

python – 像文档一样解析sphinx

我有一个sphinx格式的docstring,我想从中提取不同的部分(param,return,type,rtype等)以便进一步处理.我怎样才能做到这一点？解决方法:你可以使用docutils,这是Sphinx的基础.在this other answer中,我使用docutils.core.publish_doctree来获取reStructuredText文档的XML表示(实际上是

如何有选择地覆盖python的帮助(MYclass)中的文本与更短和定制的东西？

我正在学习编写用户友好的类和方法,我希望用户知道如何在终端中使用它们. Python的标准帮助(MYclass)返回我不想要的十八行,这是一个小窗口的半屏幕,那些刚学习python的人将失去与前一行从顶部消失的连续性. 有什么方法可以覆盖使用帮助(MYclass)(或帮助(MYmethod))显示的内容,以便

如何更改python(2.7)的测试描述unitest

似乎单元测试模块在Python 2.7中已经发生了很大的变化 我有一个测试用例： class DemoTest(unittest.TestCase): def test_foo(self): """Test foo""" pass 控制台输出是： 测试foo ……好的 升级到Python 2.7后,控制台输出现在是： test_foo(testcase.demotest.DemoTest

python – 将docstring设置为def中的表达式

我想在def中设置func_doc(作为表达式). def f(): '''My function help''' #Set the docstring def g(): "My function " + "help" # An expression, so not read as a docstring # can I put something here to set the

python – 实现保留docstring的类属性

我有一个描述符,可以将方法转换为类级别的属性： class classproperty(object): def __init__(self, getter): self.getter = getter self.__doc__ = getter.__doc__ def __get__(self, instance, owner): return self.getter(owner) 像这样使用

python – 使用三引号在非标准上下文中创建“docstrings”是一个好习惯吗？

我正在看某人的代码,这些代码在所有地方都有这种“docstrings”： SLEEP_TIME_ON_FAILURE = 5 """Time to keep the connection open in case of failure.""" SOCKET_TIMEOUT = 15 """Socket timeout for inherited socket.""" ... 根据