🧐How import statement finds modules and packages

1.Import Search 순서

모듈이나 패키지를 사용하려면 import를 해야합니다.
import를 하기 위해선 사용하고자 하는 파일이나 디렉토리가 어디에 있는지 파이썬이 찾아야 하는데
파이썬은 모듈/패키지를 찾을때 아래의 장소를 순서대로 보면서 찾습니다.

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

1.sys.modules

파이썬이 모듈이나 package를 찾기위해 가장 먼저 확인하는 곳으로 dictionary 형태입니다. 그리고 이미 import된 모듈과 package들을 저장하고 있습니다.
즉, 한번 import된 모듈과 package들은 파이썬이 또 다시 찾지 않고 sys.modules를 확인하여 가져옵니다.
한 번 이상 사용되었거나 이미 내장 되어 있는 module이나 패키지만 존재하므로 새롭게 import되는 것들은 sys.modules 에서 찾을 수 없습니다.

import sys

print(sys.modules)
'''
{'sys': <module 'sys' (built-in)>, 'builtins': <module 'builtins' (built-in)>,...}
'''

2.built-in modules

파이썬에서 제공하는 파이썬 공식 라이브러리들 입니다.
Built-in 모듈들은 이미 파이썬에 포함되어 나오므로 파이썬이 쉽게 찾을 수 있습니다

3.sys.path

마지막으로 보는 장소가 바로 sys.path 입니다.
sys.path는 기본적으로 list이며 string 요소들을 가지고 있는 list 입니다.
각 string 요소들은 다음 처럼 경로를 나타냅니다.
그러므로 파이썬은 list의 각 경로를 하나 하나 확인하면서 해당 경로에 import 하고자 하는 package가 위치해 있는지 확인합니다.

참고로 sys 는 파이썬에 포함되어 있는 모듈입니다. 그러므로 다음 처럼 sys 모듈을 import 해서 sys.modules와 sys.path 를 출력할수도 있고 수정 할 수 도 있습니다.

import sys

print(sys.path)
print(sys.modules)

정리를 하자면, 파이썬은 import 하고자 하는 모듈과 package를 찾을때에 먼저 sys.modules를 보고, 없으면 파이썬 built-in 모듈들을 확인 하고 마지막으로 sys.path에 지정되어 있는 경로들을 확인해서 찾습니다.
sys.path 에서도 못찾으면 ModuleNotFoundError 에러를 리턴합니다.

2. Absolute Path & Relative Path

파이썬의 built-in 모듈과 pip 을 통해 설치한 외부 모듈 및 package는 일반적으로 import 하는데 큰 문제가 되지 않습니다. Built-in 모듈은 설치하면서 내장되어 있고, pip으로 설치한 외부 모듈은 자동으로 site-packages 라는 디렉토리에 설치가 되는데, 이 site-packages 는 sys.path에 이미 포함되어 있기때문에 찾는데 문제가 없습니다.

문제는 직접 개발한 local package 입니다. 직접 개발한 local package를 import 할 때는 해당 package의 위치에 맞게 import 경로를 잘 선언해야 합니다. Local package를 import 하는 경로에는 absolute path 와 relative path 가 있습니다.

다음과 같은 경로의 프로젝트가 있다고 가정해보겠습니다.

└── my_app
    ├── main.py
    ├── package1
    │   ├── module1.py
    │   └── module2.py
    └── package2
        ├── __init__.py
        ├── module3.py
        ├── module4.py
        └── subpackage1
            └── module5.py

2-1. Absolute path

Absolute path는 말 그대로 절대 경로 입니다. import를 하는 파일이나 경로에 상관없이 항상 경로가 동일합니다.그 말은 생략이나 축약되지 않고 명확히 명시된 경로를 뜻합니다. 어디에서 쓰든 항상 같아서 사용하는데 헷갈리지 않다는 장점이 있습니다.

Absolute path를 사용해 위 프로젝트의 package1 과 package2를 import 하면 다음과 같습니다.

from package1 import module1
from package1.module2 import function1
from package2 import class1
from package2.subpackage1.module5 import function2

경로들의 시작점이 전부 "my_app" 프로젝트의 가장 최상위 디렉토리에서 시작합니다.예를 들어, subpackage1의 module5 모듈의 function2 함수를 import 하기 위해서는 다음 경로를 거치게 됩니다.

my_app => package2 => subpackage1 => module5.py

my_app 프로젝트 내에서는 어느 파일, 어느 위치에서 import 하던지 경로가 항상 위와 동일합니다.

일반적으로 local package를 import 할때는 absolute path를 사용하면 됩니다.
다만 absolute path를 사용하게 되면 한가지 단점이 있는데 바로 경로가 길어질 수 있다는 점입니다.
그래서 이러한 단점을 보완하기 위해서 relative path를 사용할 수 있습니다.

2-2.Relative path

Relative path 는 absolute path와 다르게 프로젝트의 최상단 디렉토리를 기준으로 경로를 잡는게 아니라 import 하는 위치를 기준으로 경로를 정의합니다. 그래서 일반적으로 relative path는 local package 안에서 다른 local package를 import 할때 사용됩니다.

예를 들어, package2의 module3에서 package2의 하위 package인 subpackage1의 module5의 function2 함수를 import하려고 하면 다음 처럼 할 수 있습니다.

# package2/module3.py

from .subpackage1.module5 import function2

여기서 dot(.)은 import가 선언되는 파일의 현재 위치를 말합니다. 현재위치는 package2/module3.py 이므로 현재 위치에서부터 원하는 모듈의 경로만 선언해주는 것입니다.

또한 dot 2개를 사용할 수도 있는데, dot 2개(..) 는 현재위치에서 상위 디렉토리로 가는 경로를 말합니다.

Relative path는 선언해야 하는 경로의 길이를 줄여준다는 장점은 있지만 헷갈리기 쉽고 파일 위치가 변경되면 경로 위치도 변경되어야 하는 단점이 있습니다. 그러므로 웬만한 경우 absolute path를 사용하는걸 권장합니다.

🤨개념 정리 & 문제 풀이

1.sys.modules 와 sys.path의 차이점을 서술해 주세요.

sys.modules

• 파이썬이 제일먼저 모듈이나 패키지를 찾는곳
• 딕셔너리구조
• import 되있는 모듈과 패키지 저장 (다시 찾지 않아도 됨)

sys.path

• 모듈과 패키지를 1,2를 찾고 마지막으로 sys.path를 찾음
• 리스트구조(string 요소를 가진 리스트)

2. sys 도 import 해야하는 모듈입니다. 파이썬은 sys 모듈의 위치를 어떻게 찾을 수 있을까요?

'sys': <module 'sys' (built-in)>

sys모듈은 이미 built-in 되어 있기 때문에 built-in module들이 있는 부분에서 찾을수 있습니다.

그렇기 때문에 위에서 설명한듯이 sys 모듈을 import 해서 sys.modules와 sys.path 를 출력, 수정이 가능한 것입니다.

3. Absolute path와 relative path의 차이점을 서술해 주세요

Absolute path

• 절대경로
• 경로의 시작점이 가장 최상위 디렉토리를 기준으로
• 그래서 import하는 경로와 상관없이 늘 동일
• 경로가 길어지는 단점이 있음

Relative path

• 상대경로
• 경로의 시작점이 import 하는 위치를 기준으로
• 그래서 경로가 동일하지 않음
• 경로는 짧아지지만 헷갈릴 위험도가 높음