파이썬(Python) 하위 패키지: 완벽 가이드 (+코드)

≣ 목차

파이썬에서 패키지를 사용하면 코드를 논리적으로 구성하고 모듈화하여 대규모 프로젝트를 더 효율적으로 관리할 수 있습니다. 패키지 내에서 하위 패키지(subpackage)를 사용하는 것은 특히 복잡한 프로젝트에서 코드의 유지 보수성을 크게 향상시킵니다. 이번 글에서는 파이썬 하위 패키지를 정의하고 사용하는 방법, 그리고 그 활용 전략에 대해 자세히 알아보겠습니다.

♛ 공지

본 포스팅의 무단도용 및 배포를 금지합니다.

1. 패키지와 하위 패키지란?

반응형

 

• 패키지는 파이썬 모듈을 담고 있는 디렉토리입니다. __init__.py 파일이 포함되어 있어 패키지로 인식됩니다.
• 하위 패키지는 패키지 내부에 포함된 또 다른 패키지로, 대규모 프로젝트에서 계층적으로 코드를 구성하는 데 유용합니다.

패키지와 하위 패키지를 사용하면 논리적으로 관련된 모듈들을 그룹화하여 관리할 수 있으며, 이를 통해 프로젝트를 더 깔끔하게 유지할 수 있습니다.

2. 하위 패키지 구조 예시

하위 패키지를 사용하기 위해 먼저 디렉토리 구조를 만들어야 합니다. 예를 들어, 다음과 같은 디렉토리 구조를 가진 패키지를 생각해봅시다.

my_project/
    my_package/
        __init__.py
        module1.py
        subpackage/
            __init__.py
            submodule1.py
            submodule2.py

• my_package는 최상위 패키지입니다.
• subpackage는 my_package 내에 있는 하위 패키지입니다.
• 각 디렉토리에는 __init__.py 파일이 있어 패키지로 인식됩니다.

3. 하위 패키지 사용하기

 

이제 my_package와 그 하위 패키지 subpackage를 사용하는 방법을 살펴보겠습니다.

3.1 하위 패키지에서 모듈 가져오기

하위 패키지 내의 모듈을 가져오려면 다음과 같이 할 수 있습니다.

# my_package/module1.py에서 하위 패키지의 모듈을 가져오기
from .subpackage import submodule1

submodule1.some_function()

위 예제에서는 my_package/module1.py에서 subpackage에 있는 submodule1을 가져옵니다. .은 현재 패키지를 나타내며, 이를 통해 같은 패키지 내에서 하위 패키지를 가져올 수 있습니다.

3.2 최상위 패키지에서 하위 패키지의 모듈 가져오기

최상위 패키지 외부에서 하위 패키지의 모듈을 가져오려면 전체 경로를 사용해야 합니다.

# my_project 디렉토리에서 실행되는 스크립트
from my_package.subpackage import submodule2

submodule2.another_function()

위와 같이 최상위 패키지(my_package)부터 시작하여 하위 패키지(subpackage)의 모듈을 명시적으로 가져올 수 있습니다.

4. __init__.py 파일의 역할

패키지와 하위 패키지 디렉토리에는 __init__.py 파일이 있어야 합니다. 이 파일은 해당 디렉토리가 패키지임을 나타내며, 초기화 코드나 기본적으로 가져올 모듈을 정의하는 데 사용됩니다.

예를 들어, my_package/subpackage/__init__.py 파일에서 특정 모듈을 기본으로 가져오도록 설정할 수 있습니다.

# subpackage/__init__.py
from .submodule1 import some_function

이렇게 설정하면 하위 패키지를 가져올 때 some_function을 직접 사용할 수 있습니다.

from my_package import subpackage

subpackage.some_function()

위와 같이 하위 패키지를 가져올 때 __init__.py에 정의된 내용에 따라 함수나 클래스에 바로 접근할 수 있습니다.

 

5.  상대 경로와 절대 경로의 사용

절대 경로 가져오기: 전체 경로를 명시적으로 사용해 모듈을 가져옵니다.

from my_package.subpackage import submodule1

 

상대 경로 가져오기: 현재 패키지를 기준으로 .(현재) 또는 ..(상위)를 사용해 모듈을 가져옵니다.

from .subpackage import submodule1

 

상대 경로는 패키지 내에서 모듈을 가져올 때 유용하며, 절대 경로는 코드가 다른 위치로 이동하더라도 경로가 변하지 않는다는 장점이 있습니다.

6. 대규모 프로젝트에서의 하위 패키지 활용

하위 패키지를 사용하면 다음과 같은 장점이 있습니다.

• 코드 관리 용이성: 모듈을 기능별로 나누고 관련된 모듈을 하위 패키지로 묶어 관리할 수 있어 유지보수가 용이합니다.
• 네임스페이스 충돌 방지: 패키지와 하위 패키지를 사용해 네임스페이스를 분리함으로써 동일한 이름의 함수나 클래스가 충돌하는 것을 방지할 수 있습니다.
• 코드 가독성 향상: 프로젝트를 계층 구조로 나누어 각 모듈의 역할을 명확하게 할 수 있어, 가독성이 높아집니다.

7. 사람들이 자주 묻는 질문들

7.1 __init__.py 파일이 꼭 필요한가요?

파이썬 3.3 이후로는 __init__.py 파일 없이도 디렉토리가 패키지로 인식됩니다. 하지만 여전히 __init__.py 파일을 사용하는 것이 일반적이며, 패키지 초기화 코드나 기본 가져올 항목을 정의하는 데 유용합니다.

7.2 상대 경로와 절대 경로 중 어떤 것을 사용해야 하나요?

상대 경로는 패키지 내에서 모듈을 가져올 때 간편하게 사용할 수 있지만, 절대 경로는 코드가 다른 위치로 이동해도 경로가 바뀌지 않아 더 안정적입니다. 따라서 대규모 프로젝트에서는 절대 경로를 사용하는 것이 권장됩니다.

7.3 하위 패키지를 사용하면 어떤 장점이 있나요?

하위 패키지를 사용하면 대규모 프로젝트를 논리적으로 나눌 수 있어 관리가 쉽고, 네임스페이스 충돌을 방지하며, 코드의 가독성과 재사용성을 높일 수 있습니다.

 

---

파이썬의 하위 패키지는 대규모 프로젝트에서 코드의 가독성과 유지보수성을 향상시키는 중요한 도구입니다. 패키지 구조를 잘 활용하면 코드의 재사용성을 높이고, 프로젝트를 체계적으로 구성할 수 있습니다. 이번 글이 하위 패키지 사용에 대한 이해를 돕는 계기가 되었길 바랍니다. 추가로 궁금한 점이 있다면 언제든지 문의해주세요.