패키지와 __init__파일

 

패키지(Package)

 

파이썬에서 패키지는 자바와 동일하게 파일의 계층구조를 나타낸다. 그리고 다른 파일에 정의되어 있는 클래스를 활용할 때는 모듈형태로 불러온다.

 

다음과 같이 디렉토리 구조가 있다고 가정하자.

person/
      __init__.py
      male/
      	  __init__.py
          run.py
      female/
      	    __init__.py
            run.py

 

Female/run.py의 test_run 함수를 실행해보자. 다음과 같이 실행할 수 있다.

import person.female.run
person.female.run.test_run()

 

Person.Female.run의 형태로 모듈을 불러와서 모듈의 메소드를 호출할 수 있다.

 

from person.female import run
run.test_run()

from과 import로 실행할 수도 있다.

 

from person.female.run import test_run
test_run()

이번에는 test_run함수만 import해서 단독으로 실행했다.

 

 

__init__.py

__init__.py 파일은 해당 디렉터리가 패키지의 일부임을 알려주는 역할을 한다. 만약 Person, Male, Female 등 패키지에 포함된 디렉터리에 __init__.py 파일이 없다면 패키지로 인식되지 않는다.

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

 

또한, __init__.py 파일은 패키지와 관련된 설정이나 초기화 코드를 포함할 수 있다. 다양한 방법으로 활용할 수 있는데, 아래에 몇 가지 예를 들어 살펴보자.

 

 

패키지 변수 및 함수 정의

패키지 수준에서 변수와 함수를 정의할 수 있다. 예를 들어, game 패키지의 __init__.py에서 공통 변수나 함수를 정의할 수 있다.

# person.py
AGE = 35

def print_age_info():
    print(f"My age is {AGE}.")

이렇게 패키지의 __init__.py 파일에 정의된 변수와 함수는 다음과 같이 사용할수 있다.

>>> import person
>>> print(person.age)
35
>>> person.print_age_info()
My age is 35.

 

 

패키지 내 모듈을 미리 import

__init__.py에서 패키지 내의 다른 모듈을 미리 import하여 패키지를 사용하는 코드에서 간편하게 접근할 수 있게 한다.

# person.py
from .male.run import test_run

AGE = 35

def print_age_info():
    print(f"My age is {AGE}.")

 

이제 패키지를 사용하는 코드에서는 다음과 같이 간편하게 Male 패키지를 통해 test_run 함수를 사용할 수 있다.

>>> import male
>>> male.test_run()

 

 

패키지 초기화

__init__.py에서 패키지가 처음 불러와질 때 실행되어야 하는 코드를 작성할 수 있다. 예를 들어, 데이터베이스 연결이나 설정 파일 로드와 같은 작업을 수행할 수 있다.

# person.py
from .male.run import test_run

AGE = 35

def print_age_info():
    print(f"My age is {AGE}.")
    
# Package Initialize
print("init!!!")

이렇게 하면 패키지가 처음 import 될 때 초기화 코드가 실행된다.

>>> import person
init!!!

 

person 패키지의 초기화 코드는 person 패키지의 하위 모듈의 함수를 사용할 경우에도 실행된다.

>>> from person.male.run import test_run
init!!!

단, 초기화 코드는 한번 실행된 후에는 다시 import를 수행하더라도 다시 실행되지 않는다. 예를 들어 다음과 같이 person 패키지를 import한 후에 하위 모듈을 다시 import 하더라도 초기화 코드는 처음 한번만 실행된다.

 

>>> import person
init!!!
>>> from person.male.run import test_run
>>>

 

 

__all__

이번에는 다음을 따라 해 보자.

>>> from person.female import *
init!!!
>>> run.test_run()
Traceback (most recent call last):
    File "<stdin>", line 1, in <module>
NameError: name 'run' is not defined

 

분명 person.female 패키지에서 모든 것(*)을 import하였으므로 run 모듈을 사용할 수 있어야 할 것 같은데 run 이라는 이름이 정의되지 않았다는 이름 오류(NameError)가 발생했다.

이렇게 특정 디렉터리의 모듈을 *를 사용하여 import할 때에는 다음과 같이 해당 디렉터리의 __init__.py 파일에 __all__ 변수를 설정하고 import할 수 있는 모듈을 정의해 주어야 한다.

# female/__init__.py
__all__ = ['run']

여기에서 __all__이 의미하는 것은 female 디렉터리에서 * 기호를 사용하여 import할 경우 이곳에 정의된 run 모듈만 import된다는 의미이다.

착각하기 쉬운데 from person.female.run import * 는 __all__과 상관없이 무조건 import된다. 이렇게 __all__과 상관없이 무조건 import되는 경우는 from a.b.c import * 에서 from의 마지막 항목인 c가 모듈인 경우이다.

 

위와 같이 __init__.py 파일을 변경한 후 위 다시 실행시키면 정상 작동한다.

>>> from person.female import *
init!!!
>>> run.test_run()

 

절대 경로가 아닌 상대 경로로도 당연히 import 가능하다.

# female/run.py

from ..male.run import echo_run

def gogo():
	print("female run")
    echo_run()
    
>>>> female run
>>>> run

 

 

출처: 점프 투 파이썬(https://wikidocs.net/1418)