python - python的sphinx中var、cvar、ivar有什么区别？

Question

我在阅读 sphinx 文档页面时讽刺地发现关于 var、ivar 和 cvar 之间区别的文档非常缺乏。我想知道是否有人可以解释内联代码中每个不同 namespace 之间的区别。

例子:

class foo(object):
    """
      :var str first:
      :ivar str last:
      :cvar str middle:
    """

这些 sphinx 标签之间的每一个有何不同，我如何知道哪一个是正确的，可以按设计正确使用？

Answer 1

var 当然是通用变量。当您不想对正在记录的变量做任何进一步区分时使用它。

ivar 是一个“实例变量”，或者说是在实例对象(类的实例)上设置的变量。通常，这些将在 __init__ 方法内定义(在 Python 中)。

cvar 是一个“类变量”，或者直接在类对象上设置的变量。通常，这将在类语句内设置，但在类中的任何特定方法之外。

这是一个例子:

class SomeClass(object):

    cvar = 'I am a class variable'

    def __init__(self):
        self.ivar = 'I am an instance variable'