未知类属性的Docstring样式？
未知类属性的Docstring样式是指在编写Python类时，为了方便其他开发人员理解和使用该类，需要在类的定义处添加文档字符串（Docstring）。文档字符串是一个描述类的注释，通常包含类的功能、使用方法、参数说明等信息。
对于未知类属性的Docstring样式，可以采用以下格式：
class ClassName:
"""
类的功能描述
Attributes:
attribute1 (type): 属性1的描述
attribute2 (type): 属性2的描述
Methods:
method1 (type): 方法1的描述
method2 (type): 方法2的描述
"""
def __init__(self, parameter1, parameter2):
"""
类的构造方法
Args:
parameter1 (type): 参数1的描述
parameter2 (type): 参数2的描述
"""
self.attribute1 = parameter1
self.attribute2 = parameter2
def method1(self, parameter):
"""
方法1的功能描述
Args:
parameter (type): 参数的描述
Returns:
type: 返回值的描述
"""
# 方法的实现
def method2(self):
"""
方法2的功能描述
"""
# 方法的实现在上述样式中，类的文档字符串包含了类的功能描述、属性和方法的描述。每个属性和方法都有自己的文档字符串，描述了其功能、参数和返回值等信息。
对于未知类属性的Docstring样式，可以根据实际情况进行调整和补充，以确保文档字符串能够清晰地描述类的功能和使用方法。
腾讯云相关产品和产品介绍链接地址：
- 腾讯云文档：https://cloud.tencent.com/document/product/213
相关·内容
好吧，我喜欢Python，但主要觉得两件事很烦人: self和声明下面的docstring。
我想知道的是，我应该如何在代码中的声明之前拥有我的文档字符串？类似于：
"""Class docstring"""
class MyClass(object):
"Method documentation"
def my_method(self):
pass
也许使用了某种形式的装饰器？
浏览 5提问于2012-01-19得票数 1
回答已采纳
2回答
我有一个描述符，它将方法转换为类级别上的属性：
class classproperty(object):
def __init__(self, getter):
self.getter = getter
self.__doc__ = getter.__doc__
def __get__(self, instance, owner):
return self.getter(owner)
像这样使用：
class A(object):
@classproperty
def test(cls):
&#
浏览 0提问于2014-03-12得票数 4
回答已采纳
在Python2.5(实际上是Jython)中，对于UnitTest TestCase类，没有SetUpClass方法，而__init__实际上是不可接受的(对self没有参考)。当我试图更改TestCase中的docstring时：
import os
fileName = os.path.split(__file__)[1]
testCaseName = os.path.splitext(fileName)[0]
setattr(__name__, '__doc__', testCaseName)
我得到了：
setattr(__name__, '__doc__&#
浏览 4提问于2011-05-01得票数 1
2回答
为用户构建GUI以选择他们想要运行的Python脚本。每个脚本都有自己的文档字符串来解释脚本的输入和输出。我想在他们突出显示脚本后在UI中显示该信息，但没有选择运行该脚本，并且我似乎无法从基本程序访问文档字符串。 例如。 """this is a docstring"""
print('hello world') 是 对于本例，但通常是未知的，因为它是用户在GUI中选择的内容。 # index is test.py
def on_selected(self, index):
script_path = self.tree
浏览 28提问于2021-03-02得票数 0
回答已采纳
让我们从以下几个方面开始：
class Example(object):
change_docstring = True
@add_to_docstring(" (additional content!)")
def example_method(self):
"""Example docstring."""
pass
我要做的是允许@add_to_docstring装饰器将其参数字符串附加到方法only的docstring中，如果change_docstring属性是T
浏览 4提问于2017-11-22得票数 3
回答已采纳
我有一个python项目，许多函数和类都缺少docstring。我知道PyCharm可以使用意图操作通过Insert文档字符串存根命令自动添加文档字符串。然而，对于大量的方法和功能，它是繁琐的。是否有一种方法一次将文档字符串批量添加到所有函数中？然后我将手动填写所需的内容。
如果不在PyCharm中，是否有其他客户端可以这样做？
谢谢你的帮助..。
浏览 2提问于2016-05-31得票数 8
回答已采纳
这里有一个关于的问题，但这里的答案涉及到方法文档字符串。
我的问题是如何继承父类的文档字符串作为__doc__属性。用法是会根据视图类的文档字符串在API的html版本中生成良好的文档。但是当在没有docstring的类中继承基类(带有docstring)时，API不会显示docstring。
很可能是sphinx和其他工具做了正确的事情，并为我处理了文档字符串继承，但django rest框架查看的是(空) .__doc__属性。
class ParentWithDocstring(object):
"""Parent docstring""&
浏览 0提问于2012-12-19得票数 14
回答已采纳
我正在学习如何使用Sphinx为我的代码创建文档。在我看到这样的例子之后：
def complex(real=0.0, imag=0.0):
"""Form a complex number.
Keyword arguments:
real -- the real part (default 0.0)
imag -- the imaginary part (default 0.0)
"""
if imag == 0.0 and real == 0.0: return complex_zero
浏览 5提问于2020-06-23得票数 2
回答已采纳
我正在尝试创建一个在类中调用的装饰符，它将从该类中提取属性，并使用这些类属性来编辑函数的docstring。
我的问题是，我找到了编辑函数的docstring (将函数的__doc__属性设置为新字符串)的装饰器的示例，还找到了从父类中提取属性的装饰器示例(通过将self传递给装饰器)，但我还没有找到能够同时执行这两种操作的装饰器示例。
我试着将这两个例子结合起来，但是没有用：
def my_decorator(func):
def wrapper(self, *args, **kwargs):
name = func.__name__ # pull function
浏览 1提问于2018-09-18得票数 1
回答已采纳
这也许是个愚蠢/琐碎的问题，但我在这件事上很困惑。
在构造函数中，还是在类主体本身中，声明实例字段的鼓励(pythonic)方法是什么？
class Foo:
""" Foo class """
# While we are at it, how to properly document the fields?
bar = None
def __init__(self, baz):
""" Make a Foo """
self.
浏览 5提问于2014-08-07得票数 3
回答已采纳
我有一个包装函数，它返回一个函数。是否有一种方式以编程方式设置返回函数的docstring？如果我可以写信给__doc__，我会做以下工作：
def wrapper(a):
def add_something(b):
return a + b
add_something.__doc__ = 'Adds ' + str(a) + ' to `b`'
return add_something
那我就可以
>>> add_three = wrapper(3)
>>> add_three.__do
浏览 8提问于2010-10-30得票数 65
回答已采纳
这些是等同的吗？
class Empty : pass
和
class Empty:
'''
This class intentionally left blank
'''
对于可读性而言，第二种方法似乎更好，并且可以将pass放在末尾，但这似乎没有必要。
该注释是否被视为pass
浏览 0提问于2018-04-10得票数 13
回答已采纳
1回答
我可以提供这样的帮助信息：
def my_func():
"help text"
这样help(my_func)就可以打印help text了。
可以从全局变量构造帮助字符串吗？
例如：
test = "123"
def my_func():
"help text" + test
不会为help(my_func)打印任何东西
浏览 0提问于2018-03-05得票数 1
回答已采纳
当您开始编写函数时，PyCharm5.0自动完成docstring：
然而，这种格式似乎没有遵循任何良好的最佳做法。如何更改这一点，以便参数采用Sphinx autodoc格式：
def communicate(self, bytes):
"""Communicate with devices
:param bytes: Outgoing request as array of bytes
"""
浏览 2提问于2016-03-06得票数 2
回答已采纳
1回答
我实现了一个抽象类： from abc import ABC, abstractmethod
class Study(ABC):
""" Define the purpose of the study here """
def __init__(self, value):
self.value = value
@abstractmethod
def do_something(self):
pass 我还实现了一个子类： class PilotStudy(Study):
def do
浏览 13提问于2019-12-13得票数 1
回答已采纳
1回答
我有一个类，有几个类似的方法，每个类都有长的文档字符串，它们相似，但由于几个短语/单词而不同。我想构建一个docstring模板，然后将字符串格式应用于它。下面是一个笨拙的实现，其中__doc__是在类方法之后定义的。
capture_doc = """
%(direc)s normal.
a %(sym)s b."""
class Cls():
def a(self):
pass
def b(self):
pass
a.__doc__ = capture_doc % {'
浏览 3提问于2017-07-20得票数 3
回答已采纳
我想在命令行应用程序中获取docstring，但是每次调用builtin help()函数时，Python都会进入交互模式。
如何获得对象的docstring和而不是有Python抓取焦点？
浏览 3提问于2009-08-13得票数 5
回答已采纳
我在教程中遇到了以下函数。当我调用函数时，没有打印"This prints a passed string into this function"。为什么函数调用时不打印这段文字？
def printme(str):
"This prints a passed string into this function"
print str
return
# Now you can call printme function
printme("I'm first call to user defined function!")
浏览 4提问于2015-10-15得票数 4
回答已采纳
3回答
我的理解是，模块docstring应该只提供一个模块所做的事情的一般描述，而像author和version这样的细节应该只包含在模块的注释中。
但是，我在注释和文档字符串中看到了以下内容：
__author__ = "..."
__version__ = "..."
__date__ = "..."
放置像这样的物品的正确位置在哪里？在模块顶部列出哪些其他__[name]__变量是常见的？
浏览 2提问于2010-09-03得票数 16
回答已采纳
1回答
我有一些现有的Python3.6代码，我想要转移到Python3.7数据类。我有__init__方法和漂亮的文档字符串文档，指定构造函数的属性和它们的类型。
但是，如果我将这些类更改为使用3.7中的新Python数据类，则构造函数是隐式的。在这种情况下，我如何提供构造函数文档？我喜欢数据类的想法，但如果我必须放弃清晰的文档才能使用它们，我就不喜欢了。
经过编辑以澄清我目前使用的是文档字符串
浏览 42提问于2018-07-02得票数 33
回答已采纳
1回答
我遇到了一个奇怪的错误，在注释出行中出现了“期望缩进块”- #______ICHIMOKU系统的COMPONENTS_____中心= False =查看是否。我不知道为什么。如果我删除这一行，并在该位置添加任何其他内容，它将开始在取代它的代码的下一部分中显示该错误。请帮帮忙。
"""
In this project I am going to import data from NSE, learn OOP and
try and learn how to implement various calculations
"""
import date
浏览 2提问于2018-02-03得票数 0
回答已采纳
是否可以修改 (以及相应的colorscheme文件)，以便在class和def语句(也称为.文档字符串)将在vim下突出显示python语法时突出显示为注释。
class URLopener:
"""Class to open URLs.
This is a class rather than just a subroutine because we may need
more than one set of global protocol-specific options.
Note -- this is a base class for those
浏览 0提问于2013-04-16得票数 16
回答已采纳
在Python中记录一个类或方法很容易：
class Something:
""" Description of the class. """
def do_it(self):
""" Description of the method. """
pass
class_variable = 1 # How to comment?
@property
def give_me_some_special_dict(self):
"""
浏览 0提问于2011-05-19得票数 83
回答已采纳
在python项目中，我生成autoapi文档。特殊注释出现在生成的html文件中。例如，它正在最后的html页面上工作和显示：
def do_action(self,params):
"""
This is function to do some cool stuffs.
Actually it should
"""
pass
或
...
applicationConfig = None
"""This variable hold some important data"""
浏览 0提问于2019-11-26得票数 3
回答已采纳
1回答
我在吉突布做了一个项目，用计算机视觉解决数独。因为这是我的第一个项目，我很想得到一些关于我的代码的反馈。由于不允许链接我的存储库，所以我选择了我创建的一个类。
我主要在寻找关于我如何编写代码的反馈，而不一定是关于算法的。我能做些什么来提高它的可读性，或者使它看起来更好看，或者更多的是琵琶吗？
class PreprocessNumber:
"""
A class used to process images from a Sudoku board.
Each box in the Sudoku board should be gi
浏览 0提问于2019-08-25得票数 4
我有一个这样的类：
class MyBase(object):
x = 3
"""Documentation for property x"""
和另一个继承它的类：
class MyObj(MyBase):
x = 0
当我使用sphinx的autodoc生成文档时，MyObj.x没有文档。有没有办法从MyBase.x继承文档字符串？我发现了，但是因为它使用了一个装饰器，所以它只适用于类方法。有什么方法可以用属性做到这一点吗？
浏览 0提问于2011-04-02得票数 3
回答已采纳
1回答
基本倒计时器
、、、、
下面是一个名为Countdown的类，它从条目中获取秒作为输入，并在按下"Start"按钮时开始计数，同时在标签上显示剩余时间：
import tkinter as tk
import datetime
class Countdown(tk.Frame):
'''A Frame with label to show the time left, an entry to input the seconds to count
down from, and a start button to start counting down.'
浏览 0提问于2018-01-05得票数 5
回答已采纳
现在有没有人用一种简单的方法将现有项目中的所有文档字符串从reStructured文本转换为
看起来可以做这样的事情，但看起来很复杂，所以我想我会问以前是否有人这样做过。任何想法都会很感激的。
浏览 3提问于2017-07-06得票数 13
回答已采纳
似乎只有一个包含单引号的字符串的文件是合法的Python代码。Python解释器不会抱怨以下内容：
#!/usr/bin/python
"somevalue"
如果我想将某个一次性值(比如API键)与其他配置设置隔离开来，是否可以将这样的文件作为模块导入另一个脚本并使用该字符串？
导入模块的默认字符串表示形式将类似于<module x from y-path>。是否可以以某种方式访问该模块中包含的字符串值？
(为了先发制人地切断切线，我知道我可以将文件作为文本读取，或者在另一个脚本中将值分配给variable和from module import variable
浏览 2提问于2017-04-01得票数 1
回答已采纳
有没有人能给我解释一下为什么Android Studio 1.1.0会出现这个警告：
未知属性样式
完全警告:检查会突出显示Android资源文件和AndroidManifest.xml中的未知XML属性
以下是代码片段：
<fragment
android:id="@+id/frag_logo"
tools:layout="@layout/fragment_logo"
style="@style/FragmentLogo"/>
警告发生在style属性上。
我使用的是gradle和android构建工具21.
浏览 0提问于2015-06-19得票数 9
我目前正在为Python开发一个基于C++的模块。我发现Boost::Python可以很好地完成我想要完成的任务。但是，我现在遇到了一些由Boost::Python生成的文档字符串的问题。给定以下Boost::Python定义：
BOOST_PYTHON_MODULE(gcsmt)
{
class_<gcsmt::Units>("Units", "Sets the units used as input.", no_init)
.def("PrintSupported", &gcsmt::Units::printSup
浏览 1提问于2011-05-25得票数 10
回答已采纳
这个问题似乎经常出现在StackOverflow和其他地方，但我在任何地方都找不到一个完全令人满意的解决方案。
似乎有两种常见的解决方案。第一个(例如来自)使用了一个函数装饰器：
class SuperClass:
def my_method(self):
'''Has a docstring'''
pass
class MyClass(SuperClass):
@copy_docstring_from(SuperClass)
def my_method(self):
pa
浏览 1提问于2013-07-01得票数 8
回答已采纳
1回答
根据pydev手册，可以使用注释为变量提供类型提示
我正在尝试通知pydev类成员的类型(以便代码完成和智能感知能够正常工作)。
以下是我尝试过的方法：
class a:
def __init__(self):
self.a=None
self.b=None
def setVariable(self,a,b)
self.a=a
self.b=b
def doSomething(self):
': :type self.a: packageX.moduleY.ClassZ'
浏览 4提问于2014-03-18得票数 6
我试图以某种方式获得一个文档，以便使一个部分方法能够工作。我目前的代码是
from functools import partialmethod
class Fun(object):
def test(self, num):
"""
I have a documentation
"""
return num
test2 = partialmethod(test, num=10)
test2.__doc__ = """Blub"""
test3
浏览 0提问于2015-10-07得票数 5
回答已采纳
为什么下面的示例无法在setter方法中运行其doctest？
class Foo:
a = None
@property
def a(self):
pass
@a.setter
def a(self, v):
'''
>>> 1 == 1
False
'''
pass
if __name__ == "__main__":
import doctest
do
浏览 1提问于2014-04-28得票数 5
回答已采纳
在我的对象的init中，我想要创建一个可迭代的对象属性。例如：
class MyClass(object):
def __init__(self, parameters):
attributes = ['name',
'memory',
'regressors',
'use_const']
for attr_name in attributes():
浏览 2提问于2015-12-01得票数 0
回答已采纳
2回答
比较以下几点。
示例1:装饰器之前的docstring。
@app.route("/")
"""
summary
"""
def hello() -> str:
return "Hello World"
相对于示例2:装饰器后面的docstring：
"""
summary
"""
@app.route("/")
def hello() -> str:
return "Hello World"
浏览 7提问于2022-02-23得票数 2
回答已采纳
我正在处理Python3中的typing模块，看看我能在多大程度上扩展它的DSL。为了使这个DSL可用，我想提取一些用户定义的类的DocStrings，比如这个：
class MyRecord:
"""
This is just a foo.
Wouldn't it be cool if you could extract this DocString's text at runtime?
"""
foo: str
我一直在搜索并找到了，但它没有告诉我在这种情况下使用DocStrings的
浏览 2提问于2020-04-14得票数 2
回答已采纳
似乎有两个地方可以为一个类放置docstring：
在阶级定义下：
class MyClass(object):
""" Summary of MyClass
Body
...
"""
就在__init__构造函数下面：
...
def __init__(self, arg1, arg2):
""" Summary of MyClass
Body
...
""
浏览 0提问于2019-01-14得票数 23
回答已采纳
3回答
我在试着记录名字。当我构建文档时，我会得到一个警告WARNING: duplicate object description和在文档化后相同的空函数。例如：
如何删除这些别名？我已经尝试过，向conf.py编写了几个函数来创建空属性。
另外，我认为值得一提的是，在构建完之后，我得到了一张使用:noindex:的便条，但我不明白我应该在哪里使用它？在我的docstring，rst文件还是其他什么地方？
代码示例：
File = namedtuple("File", ["path", "size", "extension",
浏览 3提问于2020-05-03得票数 2
回答已采纳
比方说，我有这样的功能：
def myFunc():
# useful function to calculate stuff
这将产生缩进错误，除非我添加pass。
def myFunc():
# useful function to calculate stuff
pass
但是，如果我将注释替换为docstring，则不需要pass：
def myFunc():
"""useful function to calculate stuff"""
据我所知，这似乎是一个奇怪的特性，因为据我所知，这两种特性都没有在
浏览 3提问于2014-01-20得票数 1
回答已采纳
2回答
在Python中，我经常生成一个泡菜文件，以保存我在编程期间所做的工作。
是否有可能将类似docstring的东西存储在泡菜中，从而解释如何产生这个泡菜，以及它的含义。
浏览 1提问于2018-11-24得票数 0
回答已采纳
我通常在__init__中初始化所有实例属性
def __init__(self):
"""
Initializer docstring.
"""
self.test1 = None #: test1 docstring
self._test2 = None #: test2 docstring
self.test3 = None
"""test3 docstring"""
self._test4 = None
"""tes
浏览 0提问于2016-03-16得票数 1
如何获得名称空间元数据？我要：
=> (in-ns my.test)
#<Namespace my.test>
=> (meta *ns*)
{:a "hello"}
=> ; Return back to repl namespace:
(in-ns 'user)
; Or use 'with-ns
我的命名空间定义是：
(ns ^{:a "hello"} my.test
...)
任何(meta #'my.test)变体都会失败，尽管它对def-ined实体很有用。我可以理解，(ns...
浏览 6提问于2013-09-17得票数 3
回答已采纳
我有这样的代码：
constString = """
Default docstring info:
1
2
3"""
class A():
def A1():
"""
First unique docstring.
"""
pass
def A2():
"""
Second unique docstring.
"
浏览 2提问于2013-12-03得票数 4
回答已采纳
1回答
当图片的src未知时，我需要向图片添加一个类。
这就是我尝试过的
if ($(".main-template img").attr('src') != '') {
$(this).addClass('noRelImage');
}
还有，我试过了
if ($(".main-template img").src.length > 0) {
$(this).addClass('noRelImage');
}
不走运
这是标记的外观：
<div class="main-
浏览 0提问于2019-11-04得票数 1
1回答
我希望在python脚本注释中包含Windows路径，而不会导致编码错误。
如果我在注释中包含了一个Windows路径，我有时会收到一个编码错误，例如，"UnicodeDecodeError：'utf-8‘编解码器无法解码位置4612的字节0xa 6:无效的开始字节“。
我找到了一篇“文章”，其中指出在注释中包含Windows可能会触发unicode错误。
另一方面，有时我可以在注释中包含路径，而不会触发unicode错误。我不明白为什么某些Windows路径会触发错误，而其他路径则不会。
下面是一些Windows路径的示例，这些路径会导致或不会导致编码错误，如下所示：
浏览 4提问于2021-07-28得票数 0
回答已采纳
我有个关于docstring标准的问题。链接：非常有用，但是它说在类中为init方法编写docstring既可以在类头下完成，也可以在init头下完成。我想知道人们对这件事的看法是什么，即用一种或另一种方式来做它的利弊。
浏览 1提问于2015-02-13得票数 1
我正在尝试找出这段代码中哪些地方不起作用：
#!/usr/bin/python
import cmd
class My_class (cmd.Cmd):
"""docstring for Twitter_handler"""
def __init__(self):
super(My_class, self).__init__()
if __name__ == '__main__':
my_handler = My_class()
下面是我得到的错误
Traceback (most re
浏览 0提问于2009-04-20得票数 7
回答已采纳
4回答
是否有方法匹配具有未知自定义数据属性的元素？说到未知，我的意思是，元素可能如下所示：
<div data-unknown="foo"></div>
或
<td data-someOtherCustomDataAttribute="bar"></td>
我想匹配所有具有数据-*属性的元素。也就是说，div和td标记都应该匹配。我知道如何匹配值，但不知道属性本身。
有什么线索吗？
浏览 16提问于2012-07-29得票数 1
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
实时音视频活动推荐
腾讯云开发者
