46.4 패키지에서 from import 응용하기

지금까지 calcpkg 패키지의 모듈을 가져올 때 import calcpkg.operation처럼 패키지.모듈 형식을 사용했습니다. 그러면 import calcpkg로 패키지만 가져와서 모듈을 사용할 수는 없을까요? 이때는 calcpkg 패키지의 __init__.py 파일을 다음과 같이 수정합니다.

  • from . import 모듈

calcpkg/__init__.py

from . import operation    # 현재 패키지에서 operation 모듈을 가져옴
from . import geometry     # 현재 패키지에서 geometry 모듈을 가져옴

파이썬에서 __init__.py 파일은 폴더(디렉터리)가 패키지로 인식되도록 하는 역할도 하고, 이름 그대로 패키지를 초기화하는 역할도 합니다. 즉, import로 패키지를 가져오면 __init__.py 파일이 실행됩니다. 따라서 이 파일에서 from . import 모듈 형식으로 현재 패키지에서 모듈을 가져오게 만듭니다. 참고로 .(점)은 현재 패키지라는 뜻입니다.

이제 main.py에서 import calcpkg와 같이 패키지만 가져오도록 수정한 뒤 실행해봅니다.

main.py

import calcpkg    # calcpkg 패키지만 가져옴
 
print(calcpkg.operation.add(10, 20))    # operation 모듈의 add 함수 사용
print(calcpkg.operation.mul(10, 20))    # operation 모듈의 mul 함수 사용
 
print(calcpkg.geometry.triangle_area(30, 40))    # geometry 모듈의 triangle_area 함수 사용
print(calcpkg.geometry.rectangle_area(30, 40))   # geometry 모듈의 rectangle_area 함수 사용

실행 결과

30
200
600.0
1200

calcpkg__init__.py에서 하위 모듈을 함께 가져오게 만들었으므로 import calcpkg로 패키지만 가져와도 calcpkg.operation.add(10, 20)처럼 사용할 수 있습니다.

앞에서 from import 문법 중에 *(애스터리스크)를 지정하여 모든 변수, 함수, 클래스를 가져오는 방법이 있었습니다. 그럼 패키지에 속한 모든 변수, 함수, 클래스를 가져오려면 어떻게 해야 할까요? 먼저 main.py에서 import calcpkgfrom calcpkg import *와 같이 수정하고, 각 함수들도 앞에 붙은 calcpkg.operation, calcpkg.geometry를 삭제한 뒤 실행해봅니다.

  • from 패키지 import *

main.py

from calcpkg import *    # calcpkg 패키지의 모든 변수, 함수, 클래스를 가져옴
 
print(add(10, 20))    # operation 모듈의 add 함수 사용
print(mul(10, 20))    # operation 모듈의 mul 함수 사용
 
print(triangle_area(30, 40))    # geometry 모듈의 triangle_area 함수 사용
print(rectangle_area(30, 40))   # geometry 모듈의 rectangle_area 함수 사용

실행 결과

Traceback (most recent call last):
  File "C:₩project₩main.py", line 3, in <module>
    print(add(10, 20))    # operation 모듈의 add 함수 사용
NameError: name 'add' is not defined

실행을 해보면 add가 정의되지 않았다면서 에러가 발생합니다. 왜냐하면 __init__.py에서 모듈만 가져왔을 뿐 모듈 안의 함수는 가져오지 않았기 때문입니다. IDLE의 파이썬 프롬프트에서 dir 함수를 호출하여 현재 네임스페이스(namespace, 이름공간)를 확인해봅니다(main.py에서 dir을 호출하고 main.py를 실행해도 됨).

>>> dir()
['__annotations__', '__builtins__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', 'geometry', 'operation']

현재 네임스페이스에는 operation, geometry만 들어있어서 add, mul처럼 함수 이름만으로는 호출할 수가 없습니다. 이때는 __init__.py에서 모듈 안의 함수를 가져오게 만들면 됩니다. 특히 현재 패키지(calcpkg)라는 것을 명확하게 나타내기 위해 모듈 앞에 .(점)을 붙입니다.

  • from .모듈 import 변수, 함수, 클래스

calcpkg/__init__.py

# 현재 패키지의 operation, geometry 모듈에서 각 함수를 가져옴
from .operation import add, mul
from .geometry import triangle_area, rectangle_area

이제 main.py 파일을 실행해보면 결과도 잘 출력되고 add, mul, triangle_area, rectangle_area처럼 함수 이름 그대로 호출할 수 있습니다.

실행 결과

30
200
600.0
1200

물론 __init__.py 파일에서 특정 함수(변수, 클래스)를 지정하지 않고 *을 사용해서 모든 함수(변수, 클래스)를 가져와도 상관없습니다.

  • from .모듈 import *

calcpkg/__init__.py

from .operation import *    # 현재 패키지의 operation 모듈에서 모든 변수, 함수, 클래스를 가져옴
from .geometry import *     # 현재 패키지의 geometry 모듈에서 모든 변수, 함수, 클래스를 가져옴

이렇게 패키지의 __init__.py에서 from .모듈 import 변수, 함수, 클래스 또는 from .모듈 import * 형식으로 작성했다면 패키지.함수 형식으로도 사용할 수 있습니다(변수, 클래스도 같은 형식). 이때는 import calcpkg와 같이 패키지만 가져오면 됩니다.

  • 패키지.변수
  • 패키지.함수
  • 패키지.클래스

main.py

import calcpkg    # calcpkg 패키지만 가져옴
 
print(calcpkg.add(10, 20))   # 패키지.함수 형식으로 operation 모듈의 add 함수 사용
print(calcpkg.mul(10, 20))   # 패키지.함수 형식으로 operation 모듈의 mul 함수 사용
 
print(calcpkg.triangle_area(30, 40)) # 패키지.함수 형식으로 geometry 모듈의 triangle_area 함수 사용
print(calcpkg.rectangle_area(30, 40))# 패키지.함수 형식으로 geometry 모듈의 rectangle_area 함수 사용

실행 결과

30
200
600.0
1200

__init__.py에서 from .모듈 import 변수, 함수, 클래스 또는 from .모듈 import * 형식으로 모듈을 가져오면 calcpkg 패키지의 네임스페이스에는 add, mul, triangle_area, rectangle_area가 들어갑니다. 따라서 모듈을 거치지 않고 calcpkg.add처럼 패키지에서 함수를 바로 사용할 수 있습니다.

지금까지 모듈과 패키지를 만드는 방법을 배웠습니다. 여기서는 스크립트가 프로그램의 시작점일 때와 모듈일 때를 판단하고 활용하는 부분이 중요합니다. 지금 당장은 모듈과 패키지를 만들 일이 많지 않으므로 모듈과 패키지 작성 방법은 그냥 넘어가도 됩니다. 나중에 모듈과 패키지를 만들어야 할 때 다시 돌아와서 찾아보면 됩니다.

참고 | __all__로 필요한 것만 공개하기

패키지의 __init__.py에서 from .모듈 import *로 모든 변수, 함수, 클래스를 가져오면 패키지 외부에 공개하고 싶지 않은 것까지 공개하게 됩니다. 이때는 __all__에 공개할 모듈, 변수, 함수, 클래스를 리스트 형태로 지정해주면 됩니다. __all__이라는 이름 그대로 모든 것(*)을 가져갈 때의 목록을 정합니다.

calcpkg/__init__.py

__all__ = ['add', 'triangle_area']    # calcpkg 패키지에서 add, triangle_area 함수만 공개
 
from .operation import *    # 현재 패키지의 operation 모듈에서 모든 변수, 함수, 클래스를 가져옴
from .geometry import *     # 현재 패키지의 geometry 모듈에서 모든 변수, 함수, 클래스를 가져옴

main.py

from calcpkg import *    # calcpkg 패키지의 모든 변수, 함수, 클래스를 가져옴
 
print(add(10, 20))    # add 함수는 공개되어 있으므로 사용할 수 있음
print(mul(10, 20))    # 에러: mul 함수는 공개되어 있지 않으므로 사용할 수 없음
 
print(triangle_area(30, 40))    # triangle_area 함수는 공개되어 있으므로 사용할 수 있음
print(rectangle_area(30, 40))   # 에러: rectangle_area 함수는 공개되어 있으므로 사용할 수 있음

main.py에서 from calcpkg import *로 패키지의 모든 변수, 함수, 클래스를 가져온다 하더라도 __all__에 지정된 add, triangle_area 함수만 사용할 수 있습니다.

실행 결과

30
Traceback (most recent call last):
  File "C:₩project₩main.py", line 4, in <module>
    print(mul(10, 20))    # 에러: mul 함수는 공개되어 있지 않으므로 사용할 수 없음
NameError: name 'mul' is not defined
참고 | 하위 패키지 사용하기

파이썬의 패키지는 패키지 안에 하위 패키지를 만들 수 있습니다. 즉, 패키지 안에 폴더(디렉터리)를 만들고 __init__.py와 모듈을 넣으면 하위 패키지가 됩니다.

예를 들어서 다음과 같이 calcpkg 안에 operationgeometry 하위 패키지가 있고, 그 아래에 모듈이 들어있습니다.

import로 하위 패키지의 모듈을 가져올 때는 계층 순서대로 .(점)을 붙여서 가져오면 됩니다.

import 패키지.하위패키지.모듈

즉, import calcpkg.operation.element와 같은 식입니다. 함수를 사용할 때는 calcpkg.operation.element.add(10, 20)이 되겠죠?

만약, import calcpkg처럼 패키지만 가져와서 사용하고 싶다면 calcpkg/__init__.py에서 하위 패키지의 모듈에 들어있는 변수, 함수, 클래스를 모두 가져오게 만들면 됩니다.

calcpkg/__init__.py

from .operation.element import *
from .operation.logic import *
from .geometry.shape import *
from .geometry.vector import *

이렇게 하면 calcpkg.add(10, 20), calcpkg.triangle_area(30, 40) 또는, add(10, 20), triangle_area(30, 40)처럼 사용할 수 있습니다.

참고로 하위 패키지 안에서 옆에 있는 패키지의 요소를 가져와서 사용하려면 ..을 사용해야 합니다. ..은 상위 폴더(디렉터리)라는 뜻이며 ..패키지 또는 ..모듈은 상위 폴더에 있는 패키지, 모듈이라는 뜻입니다. 즉, 현재 패키지와 같은 계층의 패키지 또는 모듈입니다. 그리고 ...은 상위 폴더의 상위 폴더라는 뜻이며 위로 갈 수록 .이 하나씩 늘어납니다.

from ..패키지 import 모듈

from ..패키지.모듈 import 클래스, 변수, 함수

from ..패키지.모듈 import *

예를 들어 calcpkg/geometry/shape.py에서 옆에 있는 calcpkg/operation 패키지의 element 모듈을 사용한다면 다음과 같이 from ..operation import element로 지정해줍니다. 또는, from ..operation.element import mul과 같이 지정하면 mul을 함수 그대로 사용할 수 있습니다.

calcpkg/operation/shape.py

from ..operation import element             # from ..operation.element import mul
 
def triangle_area(base, height):
    return element.mul(base, height) / 2    # mul(base, height)
 
def rectangle_area(width, height):
    return element.mul(width, height)       # mul(width, height)
그림 46-3 패키지 안의 하위 패키지 계층
그림 46 3 패키지 안의 하위 패키지 계층
참고 | 모듈과 패키지의 독스트링

모듈의 독스트링은 모듈 파일의 첫 줄에 """ """(큰따옴표 세 개) 또는 ''' '''(작은따옴표 세 개)를 사용하여 문자열을 넣습니다.

모듈.py

'''모듈의 독스트링'''

패키지의 독스트링은 __init__.py 파일의 첫 줄에 """ """(큰따옴표 세 개) 또는 ''' '''(작은따옴표 세 개)를 사용하여 문자열을 넣습니다.

__init__.py

'''패키지의 독스트링'''

모듈과 패키지의 독스트링을 출력하려면 모듈 또는 패키지의 __doc__를 출력하면 됩니다.

모듈.__doc__
패키지.__doc__
최근 수정: 2017년 9월 27일, 수요일, 오후 8:48