Module

• 파이썬에서 모듈은 변수나 함수 그리고 클래스 등을 모아놓은 파일이다.
• 따로 모듈로 모아놓은 이유
  • 다른 파일에서 재사용이 가능하게 한다.
  • 전체 코드가 한 파일에 넣기에는 너무 커졌을때 여러 파일로 나누어서 정리를 하기 위해서
• 모듈은 다른 사람들이 이미 만들어놓은 모듈을 사용할 수도 있고 우리가 직접 만들어서 사용할 수도 있다.

Module 만들기

## my_module.py
my_module_var = 7

def my_module_func():
    return "Hello!"

class MyModuleClass:
    pass

import my_module

1. 원하는 모듈을 import 키워드를 사용하여 불러온다. 그럼으로 파이썬이 모듈을 해당 파일과 연결시키게 된다.
2. 그 후 연결된 모듈에서 원하는 변수/함수/클래스 를 사용하면 된다. 다만 해당 모듈 이름과 연결해서 호출을 해줘야 파이썬이 어느 파일에서 해당 변수/함수/클래스 를 찾을 수 있는지 알 수 있게된다.

Alternative ways to import modules

• import 키워드 외에 from ... import ... 키워드를 사용해서 모듈을 불러들일수 있다.

from <모듈 이름> import <함수/변수/클래스1>, <함수/변수/클래스2>, ..., <함수/변수/클래스N>

from my_module import my_module_func, my_module_var

print(my_module_var)
my_module_func()

• my_module 모듈에서 my_module_func 함수와 my_module_var 변수를 import 한다.
• from ... import ... 키워드를 사용하여 모듈을 불러들이는 경우 모듈 이름을 붙이지 않고 곧바로 원하는 함수나 변수 그리고 클래스를 호출할 수 있습니다.
• 모듈에서 사용하는 것이 명확할때 from ... import ... 를 사용하면 편리합니다.

from my_module import *

print(my_module_var)
my_module_func()

• 별표 * 를 사용하면 해당 모듈의 모든 요소가 곧바로 import 된다.
• 하지만 이렇게 하는 것은 권장되지 않는다.
  • 왜냐하면 local scope를 가지고 있는 다른 변수/함수/클래스 들과 이름 충돌이 날 수 있는데, 만일 이름 충돌이 일어났을 경우 알기가 쉽지 않을수 있기 때문이다.

Import As

from my_module  import my_func as f1
from my_module2 import my_func as f2
from my_module3 import function_with_name_too_long as f3

f1()
f2()
f3()

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

import my_module as m1

m1.my_module_func()

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

Packages

• Package는 module과 마찬가지로 다른 파일에서 불러와서 사용하는 개념이다.
• 차이점은 module보다 더 크고 복잡한 코드라는 점이다.
  • module은 단순한 파이썬 파일이다.
  • 어떠한 module들은 코드의 양이 너무 커서 한 파일에 다 넣기에 비효율적일수 있다.
  • 그러할 경우 여러 파일에 나누어서 코드를 관리하는것이 효과적일 것이다.
  • 이렇게 여러 파일에 나누어져 있는 코드들도 다른 곳에서 하나의 module로 불러와서 사용할 수 있도록 해주는것이 package 이다.
• Package는 파이썬 파일들로 이루어져 있는 디렉토리(directory)가 하나의 package가 된다.
  • 그리고 디렉토리 이름이 package 이름이 된다.
    

import pkg.mod1
from pkg.mod2 import func2
 
pkg.mod1.func2()
func2()

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

Package Initialization

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

• Package 안에 __init__.py 파일이 있으면 package가 import 될때 __init__.py 파일의 코드들이 자동으로 실행된다.
• __init__.py 파일을 통하여 정확히 무엇을 할 수 있는걸까?
  • Import 할때 경로의 총 길이 줄여주기
  • Package에서 import 할 수 있는 변수/함수/클래스 제한하기
  • 그 외 package가 import될때 꼭 먼저 실행되어야 하는 코드들

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

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

• __init.py__ 파일을 사용해서 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를 설치를 해야 한다.
• 예를 들어, Django 라는 package를 사용하기 위해서는 먼저 설치를 해야한다.
• 파이썬에서 package를 설치하는 일은 매우 간단하다 (일반적으로. 간단하지 않은 package도 있다).
  • pip 라는 툴을 사용하면 된다. pip는 파이썬의 package manager다.
  • 파이썬을 설치하면 같이 설치가 되며 pip는 터미널에서 다음 명령어를 사용하면 된다.

pip install Django 

How import statement finds modules and packages

• 파이썬이 module과 package를 찾는 방법
  • 파이썬은 다음 3가지 장소를 순서대로 보면서 찾습니다.
    1. sys.modules
    2. built-in modules
    3. sys.path

sys.modules

• 파이썬이 모듈이나 package를 찾기위해 가장 먼저 확인하는 곳이다.
• sys.modules는 단순한 dictionary다.
  • 이미 import된 모듈과 package들을 저장하고 있습니다.
  • 즉, 한번 import된 모듈과 package들은 파이썬이 또 다시 찾지 않아도 되도록 하는 기능을 가지고 있다.
  • 그러므로 새로 import 하는 모듈은 sys.modules 에서 찾을 수 없습니다.

built-in modules

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

sys.path

• 마지막으로 보는 장소가 바로 sys.path 이다.
• sys.path는 기본적으로 list이며 string 요소들을 가지고 있는 list다.

['',
 '/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']

• 각 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 에러를 리턴합니다.

Absolute Path & Relative Path

• 프로젝트 내에서 어느 파일, 어느 위치에서 import 하던지 경로가 항상 같이 동일하게 되므로 absolute path 라고 하는 것이다.
• 일반적으로 local package를 import 할때는 absolute path를 사용하면 된다.
• absolute path의 단점
  경로가 길어질 수 있다는 점
• relative path
  absolute path의 단점을 보완
• Relative path 는 absolute path와 다르게 프로젝트의 최상단 디렉토리를 기준으로 경로를 잡는게 아니라 import 하는 위치를 기준으로 경로를 정의한다.
  • 그래서 일반적으로 relative path는 local package 안에서 다른 local package를 import 할때 사용됩니다.
    예를 들어, package2의 module3에서 package2의 class1과 package2의 하위 package인 subpackage1의 module5의 function2 함수를 import 하려고 하면 다음 처럼 할 수 있습니다.

# package2/module3.py

from . import class1
from .subpackage1.module5 import function2

• 여기서 dot .은 import 가 선언되는 파일의 현재 위치를 이야기 한다.
• 현재위치는 package2/module3.py 이므로 현재 위치에서부터 원하는 모듈의 경로만 선언해주면 되는 것이다.
• 또한 dot 2개를 사용할 수도 있다. dot 2개 .. 는 현재위치에서 상위 디렉토리로 가는 경로다.

# subpackage1/module5.py
from ..module4 import class4

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

sys.modules 와 sys.path의 차이점

• sys.modules는 파이썬이 모듈이나 패키지를 찾기 위해 제일 먼저 확인하는 곳이고 sys.path는 가장 마지막으로 보는 장소이다.
• sys.modules은 단순한 dictionary이고 sys.path는 string 요소를 가지고 있는 list이다.

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

import sys

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

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

• 파이썬의 built-in 모듈과 pip 을 통해 설치한 외부 모듈 및 package는 일반적으로 import 하는데 큰 문제가 되지 않습니다.

Abosolute path & relative path

• 절대 경로와 상대 경로
• 둘 다 local package를 import하는 경로이다.
• absolute path는 어느 경로에서 import하던지 최상위 디렉토리를 기준으로 경로를 잡는다.
• absolute path의 단점이 경로가 길어진다는 것인데 그 단점을 보완한 것이 relative path이다.
• relative path는 absolute path와 다르게 프로젝트의 최상단 디렉토리를 기준으로 경로를 잡는게 아니라 import라는 위치를 기준으로 경로를 정의한다.

main.py에서 상대경로로 add_and_mutiply 를 임포트 했을 때 발생하는 에러를 확인하고, main module 에서는 패키지의 모듈을 어떻게 임포트 해야하는지 적어보자.

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

hyerim@hyerim-15U340-LT2CK:~$ python3 main.py
Traceback (most recent call last):
  File "main.py", line 6, in <module>
    from .calculator.add_and_multiply import add_and_multiply
ImportError: attempted relative import with no known parent package

• 위는 main.py에서 상대경로로 add_and_mutiply를 임포트 했을 때 발생하는 에러이다.
  • ImportError: attempted relative import with no known parent package
    • 파이썬 상대경로 에러
• 원인?
  • python interpreter는 relative import의 module 위치를 정할 때 즉, 기준이 되는 모듈의 위치를 정할
    name속성에 의해 결정된다.
  • main 모듈에서 상대경로를 사용할경우 파이썬이 상대경로의 출발점, 즉 main 모듈의 위치를 찾지 못한다.
  • 터미널에서 직접 python 파일을 실행시킬 때 name == 'main' 이 된다. 그러면 당연히 main이라는 모듈의 위치를 파이썬 interpreter는 알 수가 없기 때문에 에러가 발생한다.
• 해결방안?
  • python 의 -m 옵션을 이용한다.
    • m mod : run library module as a script (terminates option list)
    • m 옵션은 모듈을 스크립트로 수행할 때 쓰는 옵션이다.(즉, 모듈이야 라고 말해주는 것이다.)
  • 절대경로를 이용한다.
    - 모듈실행 뒤 상대경로를 통해 다른 모듈을 import 할때,
    파이썬은 모듈의 이름( name )에 기반을 두고 현재모듈의 위치를 찾는다.
  • 메인 모듈의 이름이 항상 "main"이므로 파이썬 애플리케이션의 메인 모듈로 사용되는 모듈은 항상 절대 가져오기를 사용해야 한다.
  • 이름이 main으로 바껴버린 모듈은 파이썬이 위치를 찾을 수 가 없다. 상대경로의 출발점이 되는 위치를 못찾아 위와 같은 에러가 발생하는 것이다.

from calculator.add_and_multiply import add_and_multiply 

if __name__ == '__main__':
    print(add_and_multiply(1,2))

• 위처럼 경로를 절대 경로로 바꿔주면

hyerim@hyerim-15U340-LT2CK:~$ python3 main.py
5

• main.py를 실행했을 때 잘 실행된다.

add_and_multiply.py에서 multiply함수를 절대경로와 상대경로도 각각 임포트 해보고 main 모듈과 차이점을 생각해보고 결과를 출력해 보세요.

절대경로

#!/usr/bin/python3
from multiplication import multiply
# from calculator.multiplication import multiply

def add_and_multiply(a,b):
    return multiply(a,b) + (a+b)
print(add_and_multiply(1, 2))
~                                

hyerim@hyerim-15U340-LT2CK:~/calculator$ python3 add_and_multiply.py
5

• 절대 경로 정상적으로 작동됨

상대경로

#!/usr/bin/python3
from .multiplication import multiply
# from calculator.multiplication import multiply

def add_and_multiply(a,b):
    return multiply(a,b) + (a+b)
print(add_and_multiply(1, 2))
~                                   

hyerim@hyerim-15U340-LT2CK:~/calculator$ python3 add_and_multiply.py
Traceback (most recent call last):
  File "add_and_multiply.py", line 2, in <module>
    from .multiplication import multiply
ImportError: attempted relative import with no known parent package

• ImportError: attempted relative import with no known parent package
  • 에러발생

init.py 파일의 역할

• 파일 안에 아무 코드도 없지만 파일이 속해있는 디렉토리가 패키지임을 알려주는 역할을 한다.

<참고>

• https://blog.doosikbae.com/52