파이썬 2의 클래스에 대해 __doc__을 설정하십시오.

Question

많은 수의 (100 개에 가까운) 클래스를 프로그래밍 방식으로 만들고 있는데 클래스의 문서 문자열을 설정할 수 있기를 원합니다. 각 클래스 docstrings은 채워질 특정 부분이있는 동일한 기본 구조를 갖습니다. 클래스를 만들 때 템플릿 문자열을 정의한 다음 클래스 별 인수로 채 웁니다.

난 후 나는 무엇을 인위적인 예는 생각으로 내가 help(A)를 호출 할 때 A.__doc__ = class_docstr.format(name="A")이 그래서 내가 이런 걸 볼 수 설정 어떻게 든하고 싶으면 무엇 다음

class_docstr = """ 
This is the docstring for the {name} class. 
""" 


class A(object): 

    def __init__(self): 
     pass 


class B(object): 

    def __init__(self): 
     pass 


class C(object): 

    def __init__(self): 
     pass 

:

class A(__builtin__.object) 
| This is the docstring for the A class. 

을

이 작업을 수행하기 위해 메타 클래스를 사용해야 할 수도 있다고 생각하지만 어떻게해야할지 모르겠습니다.

Answer 1

당신은 클래스 정의 내부의 __doc__ 클래스 변수에 할당하여 문서화 문자열을 설정할 수 있습니다

class A(object): 
    __doc__ = class_docstr.format(name="A") 

    # whatever else 

이 클래스를 만든 후에 A.__doc__에 할당하는, 나중에 작동하지 않는 경우에도, 작동합니다.

Answer 2

당신이 정말로 여기에 메타 클래스를 사용하려면, 열심히해서는 안됩니다 ... 말했다와

>>> class Meta(type): 
... def __init__(cls, *args): 
...  super(Meta, cls).__init__(*args) 
...  cls.__doc__ = class_docstr.format(name=cls.__name__) 
... 
>>> class A(object): 
... __metaclass__ = Meta 
... 
>>> A.__doc__ 
'\nThis is the docstring for the A class.\n' 

이 당신은 업데이트 할 수 있습니다