[Python] docstring (문서화 / 사용자 정의 함수 )

🎈 python docstring references: https://wikidocs.net/16050

24. Docstring - 문서화

• docstring은 모듈, 함수, 클래스 또는 메소드 정의의 첫 번째 명령문으로 발생하는 문자열 리터럴

• Module 첫번째 줄, 함수 선언 후 내부 바로 아랫줄 또는 클래스 선언 후 내부 바로 아랫줄에 큰따옴표 3개나 작은 따옴표 3개로 작성하면 된다.

 

🖐 Docstring 사용 예시

def hello():
  """이 함수는 'Hello World!'를 출력한다!"""
  print('Hello World!')
  
hello()

# Hello World!

# 아래 형식에 대해서는 pep8 Guide 참고 : https://peps.python.org/pep-0008/
def hello(name: str) -> None:    # None을 써서 각각의 parameter가 type을 따라가도록 code 입력을 받도록
  if not isinstance(name, str):
    raise TypeError("Name Must be a String!")
  print(f"안녕!,{name}")
  
hello("Lee")
# 안녕!,Lee

hello(123)
# TypeError: Name Must be a String!

 

👀 Docstring 의 범용성

# 범용성이 떨어지는 예시
def add(a, b, c):
  return a + b + c

print(add(1, 2, 3))
# 6

print(add(1, 2))
# TypeError: add() missing 1 required positional argument: 'c'


# 보완된 코드 - *args 사용
def add(*args):
  print(args, type(args))

add(1, 2, 3, 4, 5)
# (1, 2, 3, 4, 5) <class 'tuple'>


def add(*args):
  addition = 0
  for number in args:
    addition += number
  return addition

print(add(1, 2))
print(add(1, 2, 3))
print(add(1, 2, 3, 4))

# kwargs : dictionary 형태로 받음
# 머신러닝 클래스, 하이퍼파라미터 튜닝 시, 입력 값을 dictionary룰 기본값으로 받기 때문에
# => kwargs 반드시 정의!
def temp(**kwargs):
  for key, value in kwargs.items():
    print(key, value)

temp(name="evan", age=30, city="Incheon")