파이썬으로 개발을 하다 보면 특정 함수나 모듈의 사용법이 궁금해서 공식 문서를 찾아봐야 할 때가 많습니다. 하지만 매번 웹 브라우저로 문서 사이트를 열어볼 필요는 없습니다. 파이썬은 인터프리터 안에서 곧바로 문서를 확인할 수 있도록 help()라는 내장 도움말 함수를 기본적으로 제공하기 때문입니다.
기본 문법
help('조회할 용어')괄호 안에는 도움말을 보고 싶은 대상, 즉 모듈, 함수, 클래스, 키워드 등의 이름을 문자열 형태로 전달합니다. help() 함수는 해당 이름에 대한 파이썬 공식 문서 내용을 그대로 화면에 출력해 줍니다.
인터랙티브 도움말 모드
인자 없이 help()를 호출하면 대화형(interactive) 도움말 모드에 진입합니다. 이 모드에서는 모듈 이름, 키워드, 주제 등을 계속 입력하며 문서를 탐색할 수 있고, quit을 입력하면 모드를 빠져나옵니다.
사용 예제
아래 예제에서는 time 모듈에 대한 도움말을 조회해 보겠습니다. 출력 결과는 파이썬 공식 문서에서 가져온 것으로 매우 방대하고 상세한 편입니다.
print(help('time'))실행 결과
위 코드를 실행하면 다음과 같은 결과가 출력됩니다.
Help on built-in module time:
NAME
time - This module provides various functions to manipulate time values.
DESCRIPTION
There are two standard representations of time. One is the number
of seconds since the Epoch, in UTC (a.k.a. GMT). It may be an integer
or a floating point number (to represent fractions of seconds).
The Epoch is system-defined; on Unix, it is generally January 1st, 1970.
The actual value can be retrieved by calling gmtime(0).
....................출력 결과의 구조를 간단히 살펴보면 다음과 같습니다.
- NAME – 모듈의 이름과 한 줄 요약 설명
- DESCRIPTION – 에포크(Epoch) 기준 시간 표현 방식 등 모듈에 대한 자세한 설명
- 그 아래로 모듈이 제공하는 함수들의 목록과 각각의 사용법이 이어집니다
정리
help() 함수는 별도의 검색 없이 코드 작성 중에 즉시 공식 문서를 확인할 수 있는 강력한 도구입니다. 함수 시그니처가 기억나지 않거나 모듈의 기능을 빠르게 파악하고 싶을 때 적극적으로 활용해 보세요. 더 자세한 정보가 필요하다면 dir() 함수로 객체의 속성 목록을 먼저 확인한 뒤, 각 항목에 대해 help()를 호출하는 방식도 유용합니다.