데이터 엔지니어(네번째 이야기)

Writing Functions in Python

 

1. Best Practices

 

Docstring formats

1) Google Style

2) Numpydoc

3) reStructuredText

4) EpyText

 

 

Google Style

""" : 구글 스타일에서 문서 문자열은 간결한 설명으로 시작하게 된다. 

Args : 함수에서 해당 인수가 어떠한 역할을 하는지를 나열하게 된다.

Returns : 반환되는 항목에 대해 설명하는 부분으로 함수의 이름과 설명이 명확해야 설명하기 좋다. 추가 줄은 들여쓰지 않아야 한다.

Raises : 오류가 발생한 경우 추가하게 된다.

Notes : 자유 양식 텍스트에 참고 사항 or 사용 예제를 포함할 수 있다.

 

NumpyDoc

 

 

2. Context Managers

 

3. Decorators

 

4. More on Decorators