🐍 모듈과 패키지

파이썬 모듈과 패키지에 대해 알아보자

sys.modules & sys.path

sys.modules

우선 sys.modules에 대해서 알아보자

sys.modules은 파이썬이 모듈이나 package를 찾기위해 가장 먼저 확인하는 곳이다.

sys.modules는 단순한 dictionary다. 그리고 이미 import된 모듈과 package들을 저장하고 있다.

즉, 한번 import된 모듈과 package들은 파이썬이 또 다시 찾지 않아도 되도록 하는 기능을 가지고 있다.

그러므로 새로 import 하는 모듈은 sys.modules 에서 찾을 수 없다.

sys.modules를 찍어보자

import sys
import math
print(sys.modules)

뭐가 많아보이지만 자세히 보면 딕셔너리 구조이며 맨 마지막줄을 보면 내가 import한 math모듈이 있는게 보인다.

첫째줄을 보면 built-in항목들도 보인다.

sys.modules에 math모듈이 담겨져 있기 때문에 내가 math모듈을 사용할 때 파이썬은 허허 이녀석 math모듈을 쓰는군 하면서 sys.modeles를 참조한다. 그래서 또 다시 찾지 않는다.

sys.path

sys.path는 기본적으로 list이며 string 요소들을 가지고 있는 list다.

각 string 요소들은 다음 처럼 경로를 나타낸다

sys.path도 찍어보자

print(sys,path)

[
'/Users/sdk/Desktop/codingtest/파이썬알고리즘인터뷰/08장연결리스트',
'/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',
'/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages'
]

파이썬이 모듈/package를 찾는 순서

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

그렇다면 sys는 어디서 찾아올까?

sys 모듈은 파이썬에 내장된 모듈이기 때문에 파이썬은 이 모듈을 어디에서 찾아야 할지 알고 있다.

응~ 증명해

아까 (sys.modules)를 프린트 찍어보면 sys가 built-in인것을 알 수 있다.

Absolute path와 relative path

Absolute path

Absolute path는 이름 그대로 절대 경로다. 왜 절대 경로인가 하면, import를 하는 파일이나 경로에 상관없이 항상 경로가 동일하기 때문이다.

└── my_app
    ├── main.py
    ├── package1
    │   ├── module1.py  -> func2()가 들어있음
    │   └── module2.py
    └── package2
        ├── __init__.py
        ├── module3.py  -> func3()가 들어있음
        ├── module4.py
        └── subpackage1
            └── module5.py

위와 같이 패키지가 구성되어있을 때 module3.py의 func3()를 import해보자

from package2.module3 import func3

이번엔 module1.py의 func2를 import해보자

from package1.mudule1 import func2

둘 다 보면 루트 디렉토리(my_app)에서 시작해서 찾는 걸 알 수 있다.

my_app => package2 => module1.py => func2

from package1.module2 import func2

my_app 프로젝트 내에서는 어느 파일, 어느 위치에서 import 하던지 경로가 항상 위와 같이 동일하게 되므로 absolute path 라고 하는 것이다.

relative path

Relative path 는 absolute path와 다르게 프로젝트의 최상단 디렉토리를 기준으로 경로를 잡는게 아니라 import 하는 위치를 기준으로 경로를 정의한다.

그래서 일반적으로 relative path는 local package 안에서 다른 local package를 import 할때 사용한다.

└── my_app
    ├── main.py
    ├── package1
    │   ├── module1.py  -> func2()가 들어있음
    │   └── module2.py
    └── package2
        ├── __init__.py
        ├── module3.py  -> func3()가 들어있음
        ├── module4.py
        └── subpackage1
            └── module5.py

예를 들어 내가 module1.py 에서 package2의 module3.py를 relative path로 임포트 해보자

from ..package2.module3 import func3() 

..은 상위 디렉토리로 이동하는것이다.
상위디렉토리 package2로이동하고 package2에있는 mudule3의 func3()를 임포트 한다.

Relative path는 선언해야 하는 경로의 길이를 줄여준다는 장점은 있지만 헷갈리기 쉽고 파일 위치가 변경되면 경로 위치도 변경되어야 하는 단점이 있다.

그러므로 웬만한 경우 absolute path를 사용하는게 권장 된다.

__init__, __main__

• 모듈을 임포트할 때 생기는 문제점을 알아보자

위와 같은 구조를 가진 패키지가 있다고 하자

각자 코드는

• main.py

# absoulte path
# from calculator.add_and_multiply import add_and_multiply 
 
# relative path
from .calculator.add_and_multiply import add_and_multiply
 
if __name__ == '__main__':
    print(add_and_multiply(1,2))

• add_and_multiply.py

from .multiplication import multiply
# from calculator.multiplication import multiply
 
def add_and_multiply(a,b):
    return multiply(a,b) + (a+b)

• multiplication.py

def multiply(a,b):
    return(a*b)

자 일단 main.py에서 add_and_multiply함수를 상대경로로 import해서 실행을 해보자

알려진 상위 패키지가 없는 상대 가져오기 시도라는 오류가 뜬다.
왜 이럴까?

상대 가져오기는 현재 모듈의 이름을 기반으로 합니다. 메인 모듈의 이름이 항상 "main"이므로 파이썬 애플리케이션의 메인 모듈로 사용되는 모듈은 항상 절대 가져오기를 사용해야 합니다.
출처

그렇다! 실행 버튼을 누르면 __name__이 __main__으로 바뀌기 때문에 항상 절대 경로를 써야한다.!

add_and_multiply 함수 직접 실행

상대경로

이번에는 add_and_multiply함수를 상대경로로 실행해보자

from .multiplication import multiply
 
def add_and_multiply(a,b):
    return multiply(a,b) + (a+b)

역시 이번에도 직접 실행했기 때문에 알려진 상위 패키지가 없는 상대 가져오기 시도라는 오류가 뜬다.

절대경로

그렇다면 절대경로로 하면 되겠지 하고 실행했지만

from calculator.multiplication import multiply
 
def add_and_multiply(a,b):
    return multiply(a,b) + (a+b)`

calculator모듈이 없다고 뜬다 왜 그럴까???

상대 가져오기는 모듈의 name 속성을 사용하여 패키지 계층에서 해당 모듈의 위치를 결정합니다. 모듈 이름에 패키지 정보가 포함되지 않은 경우(예: 'main'으로 설정됨) 상대 가져오기는 모듈이 파일 시스템에서 실제로 있는 위치에 관계없이 모듈이 최상위 모듈인 것처럼 해결됩니다.
출처

그렇다 실행을 하는 순간 이제 그 모듈은 최상위라고 인식하기 때문에 calculator를 인식하지 못하는 것이다.

#from .multiplication import multiply
from multiplication import multiply
 
def add_and_multiply(a,b):
    return multiply(a,b) + (a+b)

요로코롬 바꿔주면 실행이 된다.

__init__.py 의 역할

__init__.py 파일은 해당 디렉터리가 패키지의 일부임을 알려주는 역할을 한다.

python3.3 버전부터는 init.py 파일이 없어도 패키지로 인식한다(PEP 420). 하지만 하위 버전 호환을 위해 init.py 파일을 생성하는 것이 안전한 방법이다.
출처

Package 안에 init.py 파일이 있으면 package가 import 될때 init.py 파일의 코드들이 자동으로 실행된다.

일반적으로 다음 사항들을 할 수 있다.

• Import 할때 경로의 총 길이 줄여주기

• Package에서 import 할 수 있는 변수/함수/클래스 제한하기

• 그 외 package가 import될때 꼭 먼저 실행되어야 하는 코드들