파이썬의 도움말을 보는 법

   파이썬은 인터프리터에서 곧바로 도움말을 볼 수 있다. 내가 맨 처음 이 기능에 대해 들었을 때는 약간 시큰둥했는데, 실제로 사용을 하면서 비로소 왜 이 기능을 그리도 칭찬하는지 알 수 있었다. 실제로 파이썬으로 작업을 할 때 인터프리터에서 하는 경우는 별로 없고 스크립트를 작성한 소스 코드를 실행시켜서 사용을 할텐데, 다음과 같이 인터프리터를 이용해서 소스 코딩을 할 때 객체에서 지원되는 메쏘드에 대한 도움을 얻을 수 있다. MSDN이나 intellisense^[각주:1] 와는 차원이 다르다는...

주어진 객체가 어느 타입인지 살펴 보자.

type 명령어를 사용하면 인자로 주어진 객체가 어느 type 인지 알 수 있다. type 의 인자로는 변수명을 넘겨도 되고, 아예 변수 그 자체를 넘겨도 알아서 해준다.


주어진 객체가 어느 method 가 지원되는지 알아 보자.

이 기능이 정말 유용한데, 'a' 라는 string 타입의 객체에 적용할 수 있는 method 를 dir 명령어로 볼 수가 있다. 예상할 수 있듯이 string type 에는 strip, split, upper, lower 등의 method 들이 보인다. 객체 뿐만이 아니라 심지어 import 한 모듈에 어떤 method 들이 정의되어 있는지 볼 수도 있다.  import 한 모듈에 어느 method 가 지원되는지 알아 보자.

os 모듈을 import 한 후 위처럼 dir(os) 로, dir 에 모듈 이름을 인자로 넘겨 주면 그 모듈 안에 지정된 상수와 method 들이 나열된다. 그렇다면 각 모듈이 어느 기능을 하는지 알아야 할 것이다. 이것은 간단히 help 라는 명령어로 살펴 볼 수 있다.

원하는 method 에 대한 도움말을 살펴 보자.

위는 string type의 method 중 title 함수에 대한 도움말을 살펴 본 것이다. 실제로 사용을 해보면 설명대로 각 단어의 첫 알파벳만 대문자로 변환시켜 반환해 주는 것을 볼 수 있다.

위는 os 모듈에 있는 method 중 getcwd 의 도움말을 살펴 본 후 실제로 사용해 본 것이다. 예상할 수 있듯이 현재의 작업 경로가 반환 된다.


이처럼 파이썬은 각 객체에 적용할 수 있는 method 의 종류 및 설명을 인터프리터에서 직접 볼 수 있기 때문에 매우 편리하다.

---

좀 다른 얘기인데, os 모듈의 몇몇 method 는 linux 에서만 의미있는 것들이다. 이것은 python 이 리눅스/윈도우즈 등의 OS 에 상관없이 돌아가다 보니 발생한 일이다. 또한 원하는 기능을 하는 함수를 찾을 때는, 그 함수를 자신이 만든다면 그러한 기능을 함수 이름으로 가장 잘 표현할 수 있게 함수 이름을 지을 텐데 과연 어떤 함수 이름으로 했을까? 를 생각해 보고 그와 비슷한 이름을 찾으면 된다. 원래 함수를 작성할 때는 함수명만 보고도 무슨 기능을 하는지 예상할 수 있게끔 하는 것이 좋은 코딩 습관이고, 실제로 많은 라이브러리나 프로그래밍 언어들이 그러한 관례를 지키고자 한다. 물론 getcwd 처럼 다소 의아한 것도 있기는 한데, 이것은 C 의 함수 이름에서 온 느낌이 나는데, 실제로 여러 언어에서 비슷한 기능을 하는 함수들은 이름이 비슷하다.

1. visual studio 의 경우, 사용자가 작성하는 함수의 정의 바로 위에 주석을 달면 intellisense 로 그 주석이 tooltip 으로 뜨긴 한다. 그런데 왜 library 에 있는 함수들은 안 그런건데? >.<"" [본문으로]