파이썬 코드에서 문서 문자열의 위치를 ​​변경하십시오.

Question

글쎄, 저는 파이썬을 좋아하지만, 두 가지 성가신 내용을 주로 찾습니다. 선언 아래에는 자체 및 문서 문자열이 있습니다.

내가 알고 싶습니다. 내 코드에서 선언 전에 내 문서 문자열을 어떻게 가져야합니까? 예 :

"""Class docstring""" 
class MyClass(object): 
    "Method documentation" 
    def my_method(self): 
     pass 

아마도 어떤 형태의 데코레이터를 사용하고 있을까요?

Answer 1

__doc__ 속성을 설정하는 장식을 작성할 수 있습니다 :

def doc(docstr): 
    def deco(f): 
     f.__doc__ = docstr 
     return f 
    return deco 

이 새로운 스타일의 클래스에 대한 기능과 이전 스타일 클래스 작동하지만하지 않습니다는 __doc__ 속성 이후 새로운 스타일의 클래스는 읽기 전용입니다 (메타 클래스를 사용하지 않으면 거의 이득을 얻지 못해 더욱 복잡해집니다).

어쨌든 이러한 장식자를 사용하지 말 것을 권장합니다. 그냥 평범한 대회에 충실하십시오. 그런 식으로, 동료 개발자가 즉시 문서화 문자열의 소스 코드를 분석하는 도구가 제대로 작동하는 문서화 문자열 무엇 이해 등

편집 :

def doc(docstr): 
    def deco(f): 
     if isinstance(f, type): 
      d = vars(f).copy() 
      d["__doc__"] = docstr 
      return type(f.__name__, f.__bases__, d) 
     f.__doc__ = docstr 
     return f 
    return deco 

: 새로운 스타일의 클래스를 포함하려면,이 구현을 사용할 수 있습니다

__doc__은 읽기 전용이므로 원하는 문서로 새 유형 객체를 만들어야합니다. 단순화를 위해 사용자 정의 메타 클래스는 고려하지 않습니다 (원하는 경우 type을 위의 코드에서 f.__class__로 바꿉니다).

이번에도이 데코레이터를 사용하지 않는 것이 좋습니다. 당신은 이미 귀하의 질문에 제안으로 다음과 같이

Answer 2

그래도 작동하지 않습니다. docstring은 정의에 따라 선언 다음의 행에있는 문자열입니다.

데코레이터로이 작업을 실제로 수행하려는 경우에는 래핑 된 함수 (또는 클래스)의 __doc__ 속성을 설정하는 데코레이터를 만들 수 있습니다.

Answer 3

정말로 알고 싶다면.

def doc(text): 
    def w(f): 
    f.__doc__ = text 
    return f 
    return w 

Answer 4

, 당신은 뭔가를 할 수 :

from functools import wraps 

def docstring(docstr): 
    def decorator(cls): 
     @wraps(cls) 
     def wrapper(*args, **kwargs): 
      return cls(*args, **kwargs) 
     wrapper.__doc__ = docstr 
     return wrapper 
    return decorator 

@docstring("""Class docstring""") 
class MyClass(object): 
    def my_method(self): 
     pass 

print MyClass.__doc__ # Class docstring 

는 그러나, 나는 현재 구문에 비해이 특히 더 잘 찾을 수 없습니다.