我正在尝试动态生成一些类定义(用于包装 C++ 扩展)。下面的描述符工作正常，除了当我尝试使用 help() 访问字段的文档字符串时，它为描述符而不是它自己的字段提供默认文档。但是，当我执行 help(classname) 时，它会检索传递给描述符的文档字符串:

class FieldDescriptor(object):
    def __init__(self, name, doc='No documentation available.'):
        self.name = name
        self.__doc__ = doc

    def __get__(self, obj, dtype=None):
        if obj is None and dtype is not None:
            print 'Doc is:', self.__doc__
            return self
        return obj.get_field(self.name)

    def __set__(self, obj, value):
        obj.set_field(self.name, value)

class TestClass(object):
    def __init__(self):
        self.fdict = {'a': None, 'b': None}

    def get_field(self, name):
        return self.fdict[name]

    def set_field(self, name, value):
        self.fdict[name] = value

fields = ['a', 'b']
def define_class(class_name, baseclass):
    class_obj = type(class_name, (baseclass,), {})
    for field in fields:
        setattr(class_obj, field, FieldDescriptor(field, doc='field %s in class %s' % (field, class_name)))
    globals()[class_name] = class_obj


if __name__ == '__main__':
    define_class('DerivedClass', TestClass)
    help(DerivedClass.a)
    help(DerivedClass)
    v = DerivedClass()
    help(v.a)

“python test.py”打印:

Doc is: field a in class DerivedClass
Help on FieldDescriptor in module __main__ object:

class FieldDescriptor(__builtin__.object)
 |  Methods defined here:
 |  
 |  __get__(self, obj, dtype=None)
 |  
 |  __init__(self, name, doc='No documentation available.')
 |  
 |  __set__(self, obj, value)
 |  
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |  
 |  __dict__
 |      dictionary for instance variables (if defined)
 |  
 |  __weakref__
 |      list of weak references to the object (if defined)

Doc is: field a in class DerivedClass
Doc is: field b in class DerivedClass
Help on class DerivedClass in module __main__:

class DerivedClass(TestClass)
 |  Method resolution order:
 |      DerivedClass
 |      TestClass
 |      __builtin__.object
 |  
 |  Data descriptors defined here:
 |  
 |  a
 |      field a in class DerivedClass
 |  
 |  b
 |      field b in class DerivedClass
 |  
 |  ----------------------------------------------------------------------
 |  Methods inherited from TestClass:
 |  
 |  __init__(self)
 |  
 |  get_field(self, name)
 |  
 |  set_field(self, name, value)
 |  
 |  ----------------------------------------------------------------------
 |  Data descriptors inherited from TestClass:
 |  
 |  __dict__
 |      dictionary for instance variables (if defined)
 |  
 |  __weakref__
 |      list of weak references to the object (if defined)

Help on NoneType object:

class NoneType(object)
 |  Methods defined here:
 |  
 |  __hash__(...)
 |      x.__hash__()  hash(x)
 |  
 |  __repr__(...)
 |      x.__repr__()  repr(x)

Any idea how one can get the descriptor.__doc__ for help(class.field) ? And is there a way to bypass this and have something like a getter function for doc in stead of having to store the doc string in the descriptor?

like:

class FieldDescriptor(object):
    def __init__(self, name, doc='No documentation available.'):
        self.name = name
        self.__doc__ = doc

    def __get__(self, obj, dtype=None):
        if obj is None and dtype is not None:
            print 'Doc is:', self.__doc__
            return self
        return obj.get_field(self.name)

    def __set__(self, obj, value):
        obj.set_field(self.name, value)

    # This is what I'd like to have
    def __doc__(self, obj, dtype):
       return dtype.generate_docstring(self.name)

更新: 实际上，我是从 __get__ 的定义开始的:

def __get__(self, obj, dtype=None):
    return obj.get_field(self.name)

问题在于当我说:

help(DerivedClass.a)

Python 抛出异常表明我正在尝试调用 None.get_field。因此，help() 使用 obj=None 和 dtype=DerivedClass 调用 __get__ 方法。这就是为什么我决定在 obj=None 和 dtype!=None 时返回 FieldDescriptor 实例的原因。 我的印象是 help(xyz) 试图显示 xyz.__doc__。按照这个逻辑，如果 __get__ 返回 descriptor_instance，那么 descriptor_instance.__doc__ 应该由 help() 打印，整个类都是这种情况[help(DerivedClass)]，但不适用于单个字段 [help(DerivedClass.a)]。

最佳答案

发生的事情是，当您请求 help(DerivedClass.a) - python 计算括号内的表达式 - 这是描述符的 __get__ 方法返回的对象- 然后他们搜索该对象的帮助(包括文档字符串)。

实现此功能(包括动态文档字符串生成)的一种方法是让您的 __get__ 方法重新生成具有所需文档字符串的动态生成的对象。但是这个对象本身需要是原始对象的适当代理对象，并且会在您的代码上产生一些开销 - 以及许多特殊情况。

无论如何，让它按照您想要的方式工作的唯一方法是修改 __get__ 本身返回的对象，以便它们按照您希望的方式运行。

我建议，如果您在帮助中只需要一些信息，就像您正在做的那样，也许您希望从 __get__ 返回的对象属于定义 的类__repr__ 方法(而不仅仅是一个 __doc__ 字符串)。

关于python - 在 Python 描述符中创建动态文档字符串，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/10045192/