TIL26. Python : About Modules

📌 이 포스팅에서는 Python의 modules에 대해 알아보겠습니다. module은 각종 변수, 함수, 클래스 등을 담고 있는 .py 파일이며, 여러 모듈이 그룹화되어있는 것이 패키지입니다.

🌈 About Modules

🔥 sys.modules 와 sys.path의 차이점

🔥 Absolute path와 Relative path의 차이

🔥 calculator 패키지

1. sys.modules 와 sys.path의 차이점

🤔 module을 어떻게 찾아올까?

✔️ 해당 파일이나 디렉토리가 어디있는지 경로를 알고, 그 경로에서 import함으로써 모듈 또는 패키지를 사용할 수 있습니다.
✔️ python은 다음 3가지 방소를 순서대로 보면서 모듈 또는 패키지를 탐색합니다.

1) sys.modules
2) built-in modules
3) sys.path

✔️ sys.modules은 딕셔너리 형태로 구성되어 있고, python이 모듈이나 패키지를 찾기 위해 가장 우선해서 확인하는 영역입니다. 특히, sys.modules은 한번 import된 모듈과 패키지는 다시 찾지 않도록 작동합니다.
✔️ built-in modules은 pythob에서 제공하는 공식 라이브러리입니다. 이미 python에 내장되어 있기 때문에 별도로 import하지 않고 사용할 수 있습니다. print(), len(), append() 와 같은 함수들은 모두 built-in module에 속해 있습니다.
✔️ sys.path은 마지막으로 탐색되는 영역으로 list에 담겨 경로로 저장되어 있습니다. sys.path에 site-packages에는 pip로 설치된 외부 모듈이 저장되어 있습니다. 아래처럼 sys.path를 출력하면 아래와 같이 경로를 확인할 수 있습니다.

import sys
print(sys.path)
"""
[
    '/Users/jangjaewon/Documents/C',
    '/Library/Frameworks/Python.framework/Versions/3.9/lib/python39.zip',
    '/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9',
    '/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/lib-dynload',
    '/Users/jangjaewon/Documents/A/z_env/lib/python3.9/site-packages'
]
"""

✔️ sys.path 에서도 못찾으면 "ModuleNotFoundError" 에러를 반환하기 때문에 "ModuleNotFoundError"를 보게되면 모듈 또는 패키지 지정에 문제가 없는지 확인해야합니다.

🤔 sys.modules 와 sys.path의 차이

✔️ sys.module은 한번 import된 모듈이나 패키지를 효율적으로 재사용하기 위해 저장해둔 곳이기 때문에 "해당 모듈의 사용 여부"를 체크하기 위해서 딕셔너리 형태로 존재합니다. 딕셔너리 형태 자료구조는 key를 통해 탐색하기 때문에 속도가 빠르고 존재하는지 없는지 바로 알 수 있습니다.
✔️ 이에 반해 sys.path는 리스트에 경로로써 모듈과 패키지가 담겨있고, 있는지 없는지가 아닌 어디(Where)에 존재하는지를 하나하나 탐색 탐색해야하기 때문에 딕셔너리 보다 배열이 효율적입니다. 이에 built-in module을 제외한 모든 모듈의 첫 import에선 sys.path를 일일히 확인해야합니다.

2. Absolute path와 Relative path의 차이

🤔 Absolute path와 Relative path가 무엇일까?

✔️ Absolute path는 절대경로로 최상단 디렉토리(Base Directory) 이후의 경로를 순차적으로 명시함으로써 모듈 또는 패키지를 사용하는 기본적인 방법입니다.
✔️ Absolute path의 단점은 최상단 디렉토리(Base Directory)를 기준으로 경로를 잡기 때문에 경로가 매우 길어질 수 있습니다.
✔️ Relative path는 경로를 지정함에 있어 기준점을 최상단 디렉토리(Base Directory)가 아닌 모듈을 사용하는 위치로 부터 설정하기 때문에 Absolute path의 단점을 보완하기 위해 사용합니다.
✔️ Relative path 방식 또한 단점이 존재하는데 상대적인 경로이기 때문에 모듈이나 패키지의 위치가 변경되면 경로 또한 변경해줘야한다는 단점이 있습니다.

3. calculator 패키지

+-- calculator
|        +-- __init__.py
|        +-- add_and_multiply.py
|        +-- multiplication.py
+-- main.py

🤔 main module을 지정하였을 때 패키지의 모듈을 어떻게 import 해야 할까?

✔️ 절대경로로 실행시키면 문제 없이 처리되는 것을 볼 수 있습니다.

from calculator.add_and_multiply import add_and_multiply 
if __name__ == '__main__':
    print(add_and_multiply(2,5)) # 17
"""

✔️ 상대경로는 아래와 같은 "ImportError" 에러가 발생합니다.
✔️ __main__을 이름으로 갖는 main module에서 모듈을 import 하는 경우에는 절대경로를 이용해야 합니다.

from .calculator.add_and_multiply import add_and_multiply
if __name__ == '__main__':
    print(add_and_multiply(2,5))
"""
Traceback (most recent call last):
  File "main.py", line 5, in <module>
    from .calculator.add_and_multiply import add_and_multiply
ImportError: attempted relative import with no known parent package
"""

🤔 main module을 지정하지 않았을 때 패키지의 모듈을 어떻게 import 해야 할까?

✔️ main module을 지정하지 않았을 때는 절대경로와 상대경로 모두 사용 가능합니다.

# absolule path
from calculator.multiplication import multiply
def add_and_multiply(a,b):
    return multiply(a,b) + (a+b)
print(multiply(3,9)) # 27

# relative path
from .multiplication import multiply
def add_and_multiply(a,b):
    return multiply(a,b) + (a+b)
print(multiply(3,9)) # 27

✔️ 즉, main module(__main__)이 지정된 상태에서는 절대경로로 import해야하고, main module이 지정된 상태가 아닌경우는 절대경로든 상대경로든 import하는데 문제가 없습니다.

🤔 init.py 의 역활

✔️ 해당 디렉토리가 패키지의 일부임을 알려주는 역할을 합니다
✔️ 3.3부터는 init이 없어도 인식한다고 하지만, 이전 버전에서 init.py 파일이 없다면 패키지로 인식되지 않을 수도 있습니다.