TIL_16 | [Python] import, modules, path..(too hard😂)

python을 공부하다가 보니 빼놓을 수 없는 고급(?)기술이 있다. 바로 import, from으로 이루어진 녀석들과 modules, path!

오늘은 이 개념들을 완전정복 해보려 한다!

Modules & Packages

파이썬에서 모듈은 변수나 함수 그리고 클래스 등을 모아놓은 파일

❓왜 모아놨어?

• 다른 파일에서 재사용이 가능하게 하려고
• 전체 코드가 한 파일에 넣기에는 너무 커졌을때 여러 파일로 나누어서 정리를 하기 위해서

우리는 len(list)같은 내장 함수를 쓸때 len을 선언한적은 없지만 잘 써왔다. 이미 파이썬에서 모듈로 구현해놓았기 때문!

Module 만들 수 있어?

그냥 파일을 만들고 그 안에 재사용하고 싶은 함수나 클래스 혹은 변수등을 구현하면 되니까!

## my_module_file.py
def my_module():
	...
def your_module():
	...
   
class my_class():
    ...

이렇게 만든 후에 import <모듈이름>.<모듈에서 사용하길 원하는 변수/함수/클래스 이름>으로 불러오면 된다!

import my_module_file

# 함수 실행
my_module_file.my_module()

from은 뭘까??

from은 import보다 큰 개념이라고 생각하면 된다. 위의 예시에서 우리는 my_module()함수를 실행하기 위해 my_module_file.my_module()이라고 길게 써야만 했는데, from을 쓰면 간단히 할 수 있다.

from my_module_file import my_module

# 함수 사용
my_module()

# 함수 사용 x -> 에러
your_module()

from은 모듈의 큰 덩어리를 가져오고, import로 작은 덩어리를 사용한다고 하는 것과 같다. 이렇게 쓰면 함수를 간단히 쓸 수 있지만 문제점이 있다.

2번째 함수인 your_module()은 import로 가져오지 않았기 때문에 사용할 수 없는 단점이 있다. 그럼 해당 모듈의 모든 함수를 사용하기 위해선 어떻게 해야할까?

바로 *를 사용하는 것!

from my_module_file import *

# 함수 사용
my_module()
your_module()

*을 사용하게 되면 모든 함수를 사용하겠다라는 뜻이다. 하지만 기존에 작성하던 함수명, 변수명과 겹쳐서 충돌이 날 수 있기에 선호하지는 않는다.

as로 별칭 사용하기!

더 간단히 구현해 보면 as를 사용하여 별칭으로 내가 기억하고 사용하는데 더 편리하게 할 수 있다.

from my_module_file import my_module as my

# my_module() 사용하는 것과 같음 
my() 

이렇게 as 뒤에 별칭으로 만들어 사용할 수 있다.(완전 간편!!)

진짜 from, import, as만으로도 묵은 체증이 훅 내려간 것 같다!ㅋㅋㅋㅋㅋ🙌

Packages = 더 복잡한 Module일뿐!

Packages는 Module과 같은 개념이지만, Module로 놔두기엔 너무 크거나 비효율적일때 사용한다.

말 그대로 하나의 폴더가 하나의 패키지가 되고, 그 패키지의 이름이 폴더 이름이다.

# 똑같이 사용!
import pkg.mod1
from pkg.mod2 import func2

pkg.mod1.func1()
func2()

참 쉽쥬?👍

Python의 import Search 순서😎

만약에 지금 abc라는 모듈 혹은 패키지를 import해야한다면, 파이썬은 이것을 어떤 순서로 찾을까?

바로 sys.modules -> built-in modules -> sys.path순으로 찾는다!

sys.modules

파이썬이 가장 먼저 확인하는 곳이다. sys.modules는 단순한 폴더이다. 그리고 이미 import된 모듈과 패키지들을 저장하고 있다.

즉, 한번 import된 모듈과 패키지들은 파이썬이 또 다시 찾지 않아도 된다는 뜻! (새롭게 import하는 모듈과 패키지는 찾을 수 없다...😫)

built-in modules

파이썬에서 제공하는 공식 라이브러리들. 이미 포함되어 있으니 파이썬이 쉽게 찾을 수 있다.

sys.path

sys.path는 list 타입으로 string으로 이루어진 경로를 포함하고 있다. 여기서도 찾지 못한다면 ModuleNotFoundError를 리턴한다.

# sys.path의 형태
['',
 '/Users/song-eun-u/anaconda3/bin',
 '/Users/song-eun-u/anaconda3/lib/python36.zip',
 '/Users/song-eun-u/anaconda3/lib/python3.6',
 '/Users/song-eun-u/anaconda3/lib/python3.6/lib-dynload',
 '/Users/song-eun-u/anaconda3/lib/python3.6/site-packages',
 '/Users/song-eun-u/anaconda3/lib/python3.6/site-packages/aeosa',
 '/Users/song-eun-u/anaconda3/lib/python3.6/site-packages/IPython/extensions',
 '/Users/song-eun-u/.ipython']

파이썬이 path와 packages를 찾는 방법!🤣

순서는 대략 알았고... 그렇다면 찾는 방법은 무엇일까??

정말 간.단.히. 말하자면,

절대경로(Absolte path)는 내 프로젝트 명부터 시작해서 트리형태로 이루어진 순서대로 이루어진다!

상대경로(Relative path)는 같은 패키지 안에 있다는 가정하에 .으로 접근할 수 있다!

# 절대경로
# module5의 func1에 접근한다는 가정
# my_app이라는 프로젝트명은 최상단 경로로 바뀌지 않기에 생략가능
from package2.subpackage1.modeuls5 import func1

# 상대경로
# 현재 package2에 있고, module3의 class3에 접근한다는 가정
# ..은 상위 폴더로 이동
from .module3 import class3

오늘은 정말 쉬운것들만 배워봤으니 마지막 정리 하고 끝마치도록 하자!ㅋㅋㅋㅋ
(거절은 거절해.)

---

정리하자!🧑🏻‍💻

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

sys.modules는 이미 import한것들이 있고, 제일 먼저 검색.
sys.path는 list 타입으로 경로가 string으로 이루어져 있고, 제일 마지막에 검색

❓sys도 import 해야하는 모듈인데 파이썬은 어떻게 찾을까?

sys도 파이썬에 포함되어 있는 모듈이기에 때문에 찾을 수 있다.

❓Absolute Path와 Relative Path의 차이점

Absolute path는 최상단에 프로젝트 명으로 시작하여 패키지를 커쳐 파일, 함수 등 여러가지에 접근하는 방식이고,
Relative path는 현재 폴더에서 시작하여 같은 위치에 있다면 .으로 접근, 상위 폴더에 있다면 ..으로 접근하는 방식이다.

❓calculator 만들고 에러 확인하기

# 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))

검정 이미지처럼 폴더구성이 되어 있을때 위 코드를 진행하면 아래의 에러가 난다.

공식 문서에 따르면

Note that relative imports are based on the name of the current module. Since the name of the main module is always "main", modules intended for use as the main module of a Python application must always use absolute imports.

이렇게 나오는데 이 말은 즉,

상대 경로로 import를 시도할 때 현재 module의 이름을 기반으로 한다. main module의 이름은 항상 __main__ 이기 때문에 절대 경로를 사용해야한다.

우리는 상대경로를 사용했기 때문에 나타나는 문제이다.

❓위와 연결해서, add_and_multiply.py에서 multiply 함수를 절대경로와 상대경로로 사용해보면?

# 절대경로
from calculator.multiplication import multiply

# 상대경로
from .multiplication import multiply

결론은 둘 다 사용이 가능하다는 것!
다만, 차이점이라면 상대경로가 같은 packages 안에서라면 훨씬 간단하게 사용이 가능하다는 것이다.

지금까지 열심히 따라온 나와 이글은 보는 당신을 칭찬해...!👍

---

Today, Learned🧑🏻‍💻

배운점😎

• 파이썬이 모듈과 패키지를 찾는 순서
• 파이썬이 모듈과 패키지를 찾는 방법
• from, import, as의 명확한 사용
• __main__에서는 절대경로를 사용하자!!

느낀점🤩

• 이렇게 정리하면 절대 안까먹을듯... 역시 블로깅의 위대함...!
• 오늘은 약간 어려운 개념이었는데 잘 따라갈 수 있는거 보니.. 나 개발자에 소질좀 있는듯?!(곧 부서질 허세ㅋㅋㅋㅋㅋㅋㅋ)

오늘의 한마디🙌

어려운 개념??? 나에겐 그저 밥 말아서 후루룩! 뚝-딱- 하는 일 일뿐...😃🔫