[PYTHON]Module & Package(모듈 & 패키지)

  파이썬에서 모듈은 변수나 함수 그리고 클래스 등을 모아놓은 파일이다. 이렇게 따로 모듈로 모아놓은 이유는 다음과 같다.

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

  예를 들어, List의 총 요소 개수를 알고 싶으면 len 함수를 사용하면 되는걸 이미 알고있을것이다.

my_list = [1, 2, 3, 4, 5]
my_list_length = len(my_list)
print(my_list_length)

  이 len 함수는 우리가 직접 함수를 구현하지는 않았지만, 파이썬에서 이미 모듈로 구현해놓았음으로 그냥 가져다 쓰면 되는 것이다. 이렇게 모듈은 다른 사람들이 이미 만들어놓은 모듈을 사용할 수도 있고 우리가 직접 만들어서 사용할 수도 있다.

Module 만들기

  Module은 python 파일을 만든후 그 안에 재사용 하고 싶은 함수나 클래스 혹은 변수등을 구현하면 만들어진다. 그 후에 단순히 다른 파일에서 불러와 사용하면 된다.

## 파일 이름 : my_module.py
my_module_var = 7

def my_module_func():    #함수를 만들었다.
    return "Hello!"

class MyModuleClass:    #클래스를 만들었다.
    pass

Module 불러오기

  모듈을 불러와 사용하기 위해서는 import라는 키워드를 사용하면 된다.

import 모듈이름

  주의할점은 모듈을 import 할때 파일 확장자인 .py 는 제외하고 파일 이름만 사용해서 import 해야 한다.

import my_module

1. 일부 불러오기

  모듈을 import 하는 방법 중에서 모듈 안에 있는 함수나 변수 또는 클래스 중 일부만 선택해서 불러오는 방법이 있다.

import 모듈명.함수명(또는 변수명, 클래스명)

from 모듈명 import 함수명1, 함수명2, ...

  예를 들어, my_module 모듈의 my_module_func 함수를 호출하고 싶으면 다음 처럼 할 수 있다.

my_module.my_module_func()

from my_module import my_module_func, my_module_var

  모듈 이름을 앞에 붙여줘야 해당 함수의 위치를 알 수 있다. 만일 모듈 이름을 안붙어주면 파이썬은 모듈의 파일을 보지 않고 해당 파일에서만 함수를 찾을려고 하고, 결국 error 가 발생한다. 이러한 구조를 namespace 라고 한다. 이름의 공간 혹은 영역을 알려주기 때문이다.

2. 전체 불러오기

  모듈 안에 있는 모든 함수나 변수 또는 클래스를 불러오는 방법은 아래와 같다.

import 모듈명

import 모듈명 import *

  하지만 이렇게 하는 것은 권장되지 않는다. 왜냐하면 local scope를 가지고 있는 다른 변수/함수/클래스 들과 이름 충돌이 날 수 있는데, 만일 이름 충돌이 일어났을 경우 알기가 쉽지 않을수 있기 때문이다.

# Import As

  만일 여러 모듈을 import 하게 되면 이름 충돌이 날 수도 있다. 예를 들어 서로 다른 모듈에서 동일한 이름의 함수가 있을 수 있거나, 혹은 원하는 모듈의 요소의 이름이 너무 길수도 있다. 이러한 경우 import as 키워드를 사용해서 새로운 이름을 주어서 사용할 수 있다.

from my_module  import my_func as f1
from my_module3 import function_with_name_too_long as f3
f1()    # import my_func 의 이름을 f1로 바꾸면서 간결해짐!
f3()    # function_with_name_too_long 의 이름을 f3로 바꾸면서 간결해짐!

  물론 module 이름도 as 를 사용하여 새로운 이름을 줄 수 있다.

import my_module as m1
m1.my_module_func()

Packages

  Package는 module을 모아둔 파일이다. 파이썬 파일들로 이루어져 있는 디렉토리(directory)가 하나의 package가 되며, 디렉토리 이름이 package 이름이 된다.

  Package는 일반 모듈 처럼 import 하여 사용할 수 있습니다. 다만 차이점은 클래스 객체를 사용할때 처럼 "dot notation" 으로 해당 package의 원하는 모듈을 import 하면 된다.

import pkg.mod1
from pkg.mod2 import func2

pkg.mod1.func2()
func2()

Package Initialization

  가끔은 package가 import 될때 초기 설정을 해줘야 할때가 있다. 파이썬은 __init__.py 파일을 통해 package 초기 설정을 가능하게 해준다.

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

  그렇다면 __init__.py 파일을 통하여 정확히 무엇을 할 수 있을까?

• Import 할때 경로의 총 길이 줄여주기
• Package에서 import 할 수 있는 변수/함수/클래스 제한하기
• 그 외 package가 import될때 꼭 먼저 실행되어야 하는 코드들

1. import 할때 경로의 총 길이 줄여주기

  현재 pkg에서 mod1의 func2 라는 함수를 import 하여 사용하기 위해서는 다음과 같이 해야한다.

import pkg.mod1

pkg.mod1.func2()

  func2 함수를 호출 할때마다 매번 모든 경로를 다 타입해줘야 하기때문에 번거롭다. 다행히도 __init__.py 파일을 통해 함수의 경로를 줄여줄 수 있다.

  __init__.py 파일에 먼저 한번 import 해주면된다.

# `__init__.py`
from .mod1 import func2

# main.py
from pkg import func2

func2()

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

  모듈의 모든 함수가 다 외부로 노출될 수 있는건 아닐수 있다. 내부적으로만 사용되어야 하는 함수도 있을수 있는데, 이러한 함수가 package 외부에서 import되어 사용되는 것을 막기 위해서는 __all__ 변수를 지정해 줄 수 있다.

• package를 통해 import 될 수 있는 요소들은 모두 __all__ 변수를 통해 정의 된다.
• __all__ 변수의 default 값은 모든 함수/변수/클래스 다.
• 그러므로 __all__ 변수를 따로 정의해줌으로 import 될 수 있는 요소들을 제한할 수 있다.

  __all__ 변수는 string 값의 요소를 가지고 있는 list다(list of strings). 그러므로 import 되길 원하는 요소들을 string으로 list에 선언해주면 된다.

# `__init__.py`
from .mod1 import func2
from .mod2 import func3

`__all__` = ['func2', 'func3']

# main.py
from pkg import *

func2()
func3()
func4() ## <== Error. func4 함수는 `__all__` 에 정의되지 않았으므로 import 될 수 없음.

다른 사람의 package 사용하기

  다른 사람이 만들 package를 import 하여 사용하기 위해서는 먼저 package를 설치를 해야 한다. pip 라는 툴을 사용하면 되는데, pip는 파이썬의 package manager다.

  파이썬을 설치하면 같이 설치가 되며, pip는 터미널에서 다음 명령어를 사용하면 된다.

pip install Django

if __name__ == "__main__"

  어디선가 자주 본 선언이지만 무슨 의미인지 이해하기는 어렵다. 하나씩 차근차근 풀어가보자.

 __name__ 은 모듈의 이름을 가지고 있는 변수다. 현재 python 파일에서 __name__ 를 출력하면 이렇게 나올것이다.

print(__name__)
> __main__

  현재 python 파일, 즉 모듈의 이름은 __main__이라는 의미이다.

  그럼 __name__ == "__main__" 의 의미는 무엇일까?

• 프로그램의 시작점(entry point)을 확인하는 코드
• 메인 파일에서만 실행하라는 뜻

  즉, 현재 파일에서만 사용되고, 다른 파일에서 import 한 경우에는 실행되지 않게 하라는 뜻이다.

• 메인 python 에서 직접 실행된 경우에는 __name__ == "__main__" 이다.
• import 되어 모듈로 사용된 경우 __name__ == "모듈이름(python 파일명)" 이다.