모듈(module)
모듈이란 함수나 변수 또는 클래스를 모아 놓은 파이썬 파일이다. 모듈은 다른 파이썬 프로그램에서 불러와 사용할 수 있도록 만든 파이썬 파일이라고도 할 수 있다. 우리는 파이썬으로 프로그래밍 할 때 매우 많은 모듈을 사용한다. 다른 사람들이 이미 만들어 놓은 모듈을 사용할 수도 있고 우리가 직접 만들어 사용할 수도 있다.
모듈 만들기
모듈에 대해 자세히 살펴보기 전에 간단한 모듈을 한 번 만들어 본다.
def add(a, b):
return a + b
def sub(a, b):
return a-b
위와 같이 add 와 sub 함수만 있는 파일을 만들고 디렉터리에 저장한다. 이 파일이 바로 모듈이다.
파이썬 확장자
.py로 만든 파이썬 파일은 모두 모듈이다.
모듈 불러오기
우리가 만든 파일, 즉 모듈을 파이썬에서 불러와 사용하려면 어떻게 해야 할까?
먼저 다음과 같이 명령 프롬프트 창을 열고 위에서 만든 파일을 저장한 디렉터리로 이동한 후 대화형 인터프리터를 실행해 본다.
kimseoyeon:practice/ $ cd python_crawling [9:50:59]
kimseoyeon:python_crawling/ $ python3
반드시 예제 파일을 저장한 디렉터리로 이동한 후 python을 실행해야 한다. 그래야만 대화형 인터프리터에서 모듈을 읽을 수 있다.
그리고 다음과 같이 따라 해 본다.
>>> import mod1
>>> print(mod1.add(3, 4))
7
>>> print(mod1.sub(4, 2))
2
모듈을 불러오기 위해 import mod1(파일이름)이라고 입력했다. 실수로 import [mod1.py](http://mod1.py)라고 입력하지 않도록 주의한다. import는 이미 만들어 놓은 파이썬 모듈을 사용할 수 있게 해 주는 명령어이다. mod1.py 파일에 있는 add 함수를 사용하기 위해서는 mod1.add 처럼 모듈 이름 뒤에 도트 연산자(.)를 붙이고 함수 이름을 쓰면 된다.
import는 현재 디렉터리에 있는 파일이나 파이썬 라이브러리가 저장된 디렉터리에 있는 모듈만 불러올 수 있다.파이썬 라이브러리는 파이썬을 설치할 때 자동으로 설치되는 파이썬 모듈을 말한다.
import의 사용 방법은 다음과 같다.
import 모듈_이름
여기에서 모듈 이름은 mod1.py에서 .py 확장자를 제거한 mod1만을 가리킨다.
때로는 mid1.add, mod1.sub 처럼 쓰지 않고 add, sub 처럼 모듈 이름 없이 함수 이름만 쓰고 싶은 경우도 있을 것이다. 이럴 때는 다음과 같이 사용하면 된다.
from 모듈_이름 import 모듈_함수
위와 같이 함수를 직접 import 하면 모듈 이름을 붙이지 않고 해당 모듈의 함수를 쓸 수 있다.
다음과 같이 따라 해 본다.
>>> from mod1 import add
>>> add(3, 4)
7
그런데 이렇게 하면 mod1.py 파일의 add 함수 하나만 사용할 수 있다. add 함수와 sub 함수 둘 다 모듈 이름을 붙이지 않고 사용하려면 어떻게 해야 할까?
2가지 방법이 있다.
from mod1 import add, sub
첫 번쨰 방법은 위와 같이 from 모듈_이름 import 모듈_함수1, 모듈_함수2처럼 사용하는 것이다. 쉼표(,)로 구분하여 필요한 함수를 부러올 수 있다.
from mod1 import *
두 번째 방법은 * 문자를 사용하는 것이다. * 문자는 ‘모든 것’이라는 뜻이다. 따라서 from mod1 import *은 mod1 모듈의 모든 함수를 불러와 사용하겠다는 뜻이다.
if name == “main”:의 의미
이번에는 mod1.py 파일을 다음과 같이 수정해 본다.
def add(a, b):
return a + b
def sub(a, b):
return a - b
print(add(1, 4))
print(sub(4, 2))
add(1, 4)와 sub(4, 2)의 결과를 출력하는 문장을 추가했다. 그리고 출력한 결괏값을 확인하기 위해 mod1.py 파일을 다음과 같이 실행해 본다.
kimseoyeon:python_crawling/ $ python mod1.py [10:53:04]
5
2
예상한 대로 결괏값이 잘 출력된다. 그런데 이 mod1.py 파일의 add와 sub 함수를 사용하기 위해 mod1 모듈을 import 할 때는 조금 이상한 문제가 있다. 명령 프롬프트 창에서 다음을 따라 해 본다.
kimseoyeon:python_crawling/ $ python [10:54:54]
Python 3.8.18 (default, Dec 7 2023, 16:15:31)
[Clang 14.0.3 (clang-1403.0.22.14.1)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import mod1
5
2
엉뚱하게도 import mod1 을 수행하는 순간 mod1.py파일이 실행되어 결괏값을 출력한다. 우리는 단지 mod1.py 파일의 add와 sub 함수만 사용하려고 했는데 말이다.
이러한 문제를 방지하려면 mod1.py 파일을 다음처럼 수정해야 한다.
def add(a, b):
return a + b
def sub(a, b):
return a - b
if __name__ == '__main__':
print(add(1, 4))
print(sub(4, 2))
if __name__ === '__main__'을 사용하면 python [mod1.py](http://mod1.py) 처럼 직접 이 파일을 실행했을 때는 __name__ == '__main__'이 참이 되어 if 문 다음 문장이 수행된다. 이와 반대로 대화형 인터프리터나 다른 파일에서 이 모듈을 불러 사용할 때는 __name__ == '__main__'이 거짓이 되어 if 문 다음 문장이 수행되지 않는다.
위와 같이 수정한 후 다시 대화형 인터프리터를 열고 실행해 본다.
>>> import mod1
>>>
아무런 결괏값도 출력되지 않는 것을 확인할 수 있다.
**__name__**변수란?파이썬의
__name__변수는 파이썬이 내부적으로 사용하는 특별한 변수 이름이다. 만약python mod1.py처럼 직접 mod1.py파일을 실행할 경우, mod1.py의__name__변수에는__main__값이 젖아된다. 하지만 파이썬 셀이나 다른 파이썬 모듈에서mod1을import할 경우에는 mod1.py의__name__변수에 mod1.py의 모듈 이름인mod1이 저장된다.>>> import mod1 >>> mod1.__name__ 'mod1'
클래스나 변수 등을 포함한 모듈
지금까지 살펴본 모듈은 함수만 포함했지만, 클래스나 변수 등을 포함할 수도 있다. 다음과 같은 프로그램을 작성해 본다.
PI = 3.141592
class Math:
def solv(self, r):
return PI * (r ** 2)
def add(a, b):
return a + b
이 파일은 원의 넓이를 계산하는 Math 클래스와 두 값을 더하는 add 함수 그리고 원주율 값에 해당하는 PI 변수처럼 클래스, 함수, 변수 등을 모두 포함하고 있다.
대화형 인터프리터를 열어 다음과 같이 따라 해 본다.
kimseoyeon:python_crawling/ $ python [11:09:10]
Python 3.8.18 (default, Dec 7 2023, 16:15:31)
[Clang 14.0.3 (clang-1403.0.22.14.1)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import mod2
>>> print(mod2.PI)
3.141592
위 예에서 볼 수 있듯이 mod2.PI를 입력해서 mod2.py 파일에 잇는 PI 변수의 값을 사용할 수 있다.
>>> a = mod2.Math()
>>> print(a.solv(2))
12.566368
위 예는 mod2.py에 있는 Math 클래스를 사용하는 방법을 보여 준다.
>>> print(mod2.add(mod2.PI, 4.4))
7.5415920000000005
mod2.py에 있는 add 함수 역시 당연히 사용할 수 있다.
다른 파일에서 모듈 불러오기
지금까지는 만들어 놓은 모듈 파일을 사용하기 위해 대화형 인터프리터만 사용했다. 이번에는 다른 파이썬 파일에서 이전에 만들어 놓은 모듈을 불러와서 사용하는 방법에 대해 알아본다.
먼저 데이터로 파일을 생성하고 다음과 같이 작성한다.modtest
import mod2
result = mod2.add(3, 4)
print(result)
위에서 볼 수 있듯이 다른 파이썬 파일에서도 import mod2로 mod2 모듈을 불러와서 사용할 수 있다. 대화형 인터프리터에서 한 것과 동일한 방법이다. 위 예제가 정상적으로 실행되기 위해서는 위에서 작성한 파일과 mod2.py 파일이 동일한 디렉터리에 있어야 한다.
다른 디렉터리에 있는 모듈을 불러오는 방법
우리는 지금까지 해당 모듈이 있는 디렉터리로 이동한 후에야 그 모듈을 사용할 수 있었다. 이번에는 모듈을 저장한 디렉터리로 이동하지 않고 모듈을 불러와서 사용하는 방법에 대해 알아본다.
먼저 다음과 같이 이전에 만든 mod2.py 파일을 python_crawling\mymod로 이동시킨다.
kimseoyeon:python_crawling/ $ mkdir mymod [11:21:32]
kimseoyeon:python_crawling/ $ mv mod2.py mymod
그리고 다음 예를 따라 해 본다.
sys.path.append 사용하기
먼저 파이썬 셸을 실행한 후 sys 모듈을 불러온다.
kimseoyeon:python_crawling/ $ python [11:22:15]
Python 3.8.18 (default, Dec 7 2023, 16:15:31)
[Clang 14.0.3 (clang-1403.0.22.14.1)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
sys 모듈은 파이썬을 설치할 때 함께 설치되는 라이브러리 모듈이다. 이 sys 모듈을 사용하면 파이썬 라이브러리가 설치되어 있는 디렉터리를 확인할 수 있다.
다음과 같이 입력해 본다.
>>> sys.path
['', '/Users/kimseoyeon/.pyenv/versions/3.8.18/lib/python38.zip', '/Users/kimseoyeon/.pyenv/versions/3.8.18/lib/python3.8', '/Users/kimseoyeon/.pyenv/versions/3.8.18/lib/python3.8/lib-dynload', '/Users/kimseoyeon/.pyenv/versions/3.8.18/lib/python3.8/site-packages']
sys.path는 파이썬 라이브러리가 설치되어 있는 디렉터리 목록을 보여 준다. 이 디렉터리 안에 저장된 파이썬 모듈은 모듈이 저장된 디렉터리로 이동할 필요 없이 바로 불러 사용할 수 있다.
그렇다면 sys.path에 mymod 디렉터리를 추가하면 mymod 디렉터리에 저장된 파이썬 모듈은 아무 곳에서나 불러 사용할 수 있지 않을까? 당연하다. sys.path는 리스트이므로 우리는 다음과 같이 할 수 있다.
>>> sys.path.append('/Users/kimseoyeon/python_crawling/mymod')
>>> sys.path
['', '/Users/kimseoyeon/.pyenv/versions/3.8.18/lib/python38.zip', '/Users/kimseoyeon/.pyenv/versions/3.8.18/lib/python3.8', '/Users/kimseoyeon/.pyenv/versions/3.8.18/lib/python3.8/lib-dynload', '/Users/kimseoyeon/.pyenv/versions/3.8.18/lib/python3.8/site-packages', '/Users/kimseoyeon/python_crawling/mymod']
sys.path.append를 사용해서 mymod가 있는 디렉터리를 sys.path에 추가했다 .그리고 다시 sys.path를 출력해 보니 가장 마지막에 디렉터리가 추가되었다.
실제로 디렉터리 이동 없이 바로 모듈을 불러와서 사용할 수 있는지 확인해 본다.
>>> import mod2
>>> print(mod2.add(3, 4))
7
이상 없이 불러와서 사용할 수 있다.
PYTHONPATH 환경 변수 사용하기
모듈을 불러와서 사용하는 또 다른 방법으로는 PYTHONPATH 환경 변수를 사용하는 것이 있다.
다음과 같이 따라 해 본다.
kimseoyeon:python_crawling/ $ set PYTHONOATH=디렉터리_경로
kimseoyeon:python_crawling/ $ python
>> import mod2
>> print(mod2.add(3, 4))
7
set 명령어를 사용해 PYTHONPATH 환경 변수에 mod2.py파일이 있는 디렉터리를 설정한다. 그러면 디렉터리 이동이나 별도의 모듈 추가 작업 없이 mymod 디렉터리에 저장된 mod2 모듈을 불러와서 사용할 수 있다.
맥이나 유닉스 환경에서는
set대신export명령을 사용해야 한다.
