파이썬 모듈과 패키지의 모든 것

 

 

모듈

모듈은 다른 파일에서 정의한 변수 및 함수들을 불러오는 것을 뜻합니다.

import mod

print(mod.add(3,4))

 

from 모듈_이름 import 모듈_함수 형태로 모듈 이름 없이 함수 이름으로만 호출할 수 있습니다.

from mod import add
add(3,4)    # 모듈 이름 없이 함수 이름으로만 사용

 

from 모듈_이름 import * 형태로 해당 모듈 안의 모든 함수를 호출할 수 있습니다. 하지만 편하다고 import *로는 쓰지 않는 것이 좋습니다.(항상 명시적 호출이 가장 좋은 형태입니다)

from mod import *
add(3,4)    # import *는 mod 파일의 모든 함수를 사용할 수 있음

 

if __name __ = “main”

# mod.py
def add(a, b): 
    return a+b

def sub(a, b): 
    return a-b

print(add(1, 4))
print(sub(4, 2))

# test.py
import mod

pass

5
2      # mod를 import만 하더라도 print가 실행됨

mod 모듈을 import만 하더라도 print가 실행되기 때문에 아래와 같이 수정합니다.

# mod.py
def add(a, b): 
    return a+b

def sub(a, b): 
    return a-b

if __name__ = "__main__":    # mod.py를 실행할 때만 if로 들어옴(import는 안들어옴)
	print(add(1, 4))
	print(sub(4, 2))

 

모듈 include path 추가하기

여태까지는 특정 모듈을 사용하려면 해당 디렉터리로 이동한 후에야 사용할 수 있었습니다. 모듈을 저장한 디렉터리로 이동하지 않고 불러와서 사용하는 방법을 알아보겠습니다.

1. sys.path.append 사용

import sys
sys.path

sys.path로 파이썬 라이브러리가 설치되어 있는 디렉터리를 확인할 수 있습니다.

여기에 현재 디렉터리를 추가하면 어디서든 현재 디렉터리의 모듈을 사용할 수 있습니다.

sys.path.append("/home/groundp/my-module")

1. PYTHONPATH 환경 변수 사용

set PYTHONPATH="/home/groundp/my-module"    # windows
export PYTHONPATH="/home/groundp/my-module"   # Unix, Mac

import mod
print(mod.add(3,4))

sys보다는 PYTHONPATH를 쓰는 것이 좋습니다.

 

패키지

• 파이썬에서 모듈은 하나의 파일입니다.
• 파이썬에서 패키지는 모듈을 모아놓은 디렉토리 구조입니다.
  • __init __.py 파일이 있어야 패키지로 인식합니다.
• 패키지에서 어떤 모듈을 외부에 노출시킬지 결정할 때, 각 모듈에서 all 변수를 설정하여 명시적으로 지정할 수 있습니다.

# __init__.py
__all__ = ['module1', 'module2']

파이썬에서 패키지는 모듈을 포함하는 디렉토리로 구성된 구조입니다. 패키지는 코드의 모듈을 조직화하고 이름 충돌을 방지하며, 코드를 논리적으로 그룹화하여 유지보수성을 향상시키는데 사용됩니다. 간단한 예제로 설명하겠습니다.

 

패키지의 구조

패키지 디렉토리 생성:

# module1.py
def func1():
    print("Function 1 from module1")

# module2.py
def func2():
    print("Function 2 from module2")

각 모듈의 내용:

mypackage/ 
├── __init__.py 
├── module1.py 
└── module2.py

패키지를 사용하는 스크립트:

# main_script.py
from mypackage import module1, module2

module1.func1()
module2.func2()

 

 

패키지는 왜 사용할까?

패키지를 통한 모듈 그룹화: 패키지를 사용하면 관련된 모듈을 논리적으로 그룹화할 수 있습니다. 이렇게 하면 코드의 구조가 향상되어 이해하기 쉬워집니다.

네임스페이스 분리: 패키지는 네임스페이스를 제공하여 모듈 간의 이름 충돌을 방지합니다. 모듈 이름이 겹치더라도 패키지를 사용하면 각 패키지 내에서는 이름 충돌이 발생하지 않습니다.

가독성 및 유지보수성 향상: 코드를 패키지로 구성하면 코드의 일부를 더 작은 부분으로 나누어 가독성을 향상시키고, 유지보수성을 높일 수 있습니다.

 

사용 팁

1. __init__.py 파일:
2. 패키지 디렉토리에 __init__.py 파일을 만들어야 합니다. 이 파일은 패키지를 파이썬에서 패키지로 인식하게 만듭니다. 이 파일은 비어 있어도 되지만, 패키지 초기화 코드를 포함할 수도 있습니다.
3. 상대 경로 임포트 사용:

   # module2.py에서 module1.py를 임포트할 때
   from . import module1
   
   

4. 상대 경로 임포트를 사용하여 모듈 간의 관계를 명시적으로 나타낼 수 있습니다. 이는 코드 이동 및 유지보수를 더 쉽게 만듭니다.
5. __all__ 활용:

   # __init__.py
   __all__ = ['module1', 'module2']
   
   

   이렇게 하면 패키지를 임포트할 때 명시한 모듈만 사용할 수 있습니다.
6. 패키지에서 어떤 모듈을 외부에 노출시킬지 결정할 때, 각 모듈에서 __all__ 변수를 설정하여 명시적으로 지정할 수 있습니다.

이러한 구조를 사용하면 코드를 체계적으로 구성하고 유지보수하기 쉽게 만들 수 있습니다.

 

실전 예제 맛보기

다음은 플라스크 웹 애플리케이션 구조 예시입니다.

mywebapp/
├── __init__.py
├── core/
│   ├── __init__.py
│   ├── authentication.py
│   ├── database.py
│   └── utils.py
├── web/
│   ├── __init__.py
│   ├── routes.py
│   └── templates/
│       └── index.html
└── main.py

 

1. mywebapp/__init__.py:

# mywebapp/__init__.py
from .core import *
from .web import *

 

2. mywebapp/core/__init__.py:

# mywebapp/core/__init__.py
from .authentication import authenticate_user
from .database import connect_to_database
from .utils import *

 

3. mywebapp/core/authentication.py:

# mywebapp/core/authentication.py
def authenticate_user(username, password):
    # Authentication logic
    return True  # For simplicity, always return True

 

4. mywebapp/core/database.py:

# mywebapp/core/database.py
def connect_to_database():
    # Database connection logic
    return "Connected to database"  # For simplicity, return a string

 

5. mywebapp/core/utils.py:

# mywebapp/core/utils.py
def generate_random_key():
    # Utility function to generate a random key
    pass

 

6. mywebapp/web/__init__.py:

# mywebapp/web/__init__.py
from .routes import *

 

7. mywebapp/web/routes.py:

# mywebapp/web/routes.py
from flask import Flask, render_template
from ..core import authenticate_user, connect_to_database, generate_random_key

app = Flask(__name__)

@app.route('/')
def index():
    # Web route logic
    user_authenticated = authenticate_user("user", "password")
    db_connection = connect_to_database()
    random_key = generate_random_key()
    return render_template('index.html', auth=user_authenticated, db=db_connection, key=random_key)

 

8. mywebapp/web/templates/index.html:

<!-- mywebapp/web/templates/index.html -->
<!DOCTYPE html>
<html>
<head>
    <title>Web App</title>
</head>
<body>
    <h1>Welcome to my web app</h1>
    <p>Authentication: {{ auth }}</p>
    <p>Database Connection: {{ db }}</p>
    <p>Random Key: {{ key }}</p>
</body>
</html>

 

9. mywebapp/main.py:

# mywebapp/main.py
from mywebapp.web.routes import app

if __name__ == '__main__':
    app.run(debug=True)

 

이 프로젝트에서는 core 패키지에는 데이터베이스 연결, 사용자 인증 및 유틸리티와 같은 핵심 기능이 들어 있습니다. web 패키지에는 Flask 웹 애플리케이션의 라우트가 정의되어 있습니다. 이 구조를 사용하면 프로젝트의 다양한 부분을 모듈화하고 분리하여 관리할 수 있습니다. 또한 각 모듈은 독립적으로 테스트하거나 재사용할 수 있습니다.

 

 

참고: 점프 투 파이썬