[Python] PEP8에서 권장하는 import 순서와 isort 사용법

Python 코드를 작성할 때 여러 라이브러리를 import 하게 됩니다.

특히 여러 사람이 함께 작업하는 경우, 일관된 import 규칙을 따르면 코드의 가독성과 유지보수성이 높아지고, 불필요한 git 변경 사항도 줄일 수 있습니다.

이 글에서는 Python 스타일 가이드인 PEP 8에서 권장하는 import 규칙을 살펴보고, 이를 자동으로 정리해 주는 도구인 isort에 대해 알아보겠습니다.

Python Import 순서 Best Practice

PEP 8에서는 import 문을 다음과 같은 방식으로 정리할 것을 권장합니다.

# 1. Standard Library(표준 라이브러리)
import os
import sys
import json

# 2. Third-party Library(서드파티 라이브러리)
import boto3
import requests
import pandas as pd

# 3. Local Modules(로컬 모듈)
from my_project.utils import helper_function
from my_project.services import S3Inspector

# 4. 잘못된 import 예시
from .utils import helper_function # ❌ : 상대 경로가 아닌 절대 경로를 사용해야 합니다.
from os, sys       # ❌ : 1줄에 1개의 모듈만 import 해야 합니다.
from math import * # ❌ : import에서 와일드카드는 사용하지 않습니다.

1. Standard Library(표준 라이브러리) Import
   Python에 기본적으로 내장된 라이브러리들을 가장 처음에 import 합니다.
   예를들어 os, sys, json과 같은 모듈이 해당됩니다.

2. Third-party Library(서드파티 라이브러리) Import
   pip 등을 통해 설치한 외부 라이브러리를 두번째로 import 합니다.
   예를 들어 boto3, requests, pandas과 같은 라이브러리가 해당됩니다.

3. Local Modules(로컬 모듈) Import
   프로젝트 내부에서 작성한 모듈이나 패키지를 마지막에 import 합니다.

4. 추가 Best Practices

   • 상대 경로보다 절대 경로를 사용해야 합니다.
   • 1줄에 1개의 모듈만 import 해야 합니다.
   • import에서 와일드 카드는 사용하지 않습니다.
   • import 그룹 내에서는 알파벳으로 정렬하고 각 그룹 간에는 빈 줄을 추가해 시각적으로 구분합니다.

isort 사용법

• isort는 Python 코드의 import 문을 자동으로 정렬해주는 도구로 PEP 8 스타일 가이드에 따라 import 문을 알파벳 순서로 정렬하고 표준 라이브러리, 서드 파티 라이브러리, 로컬 모듈을 구분합니다.

• isort 설치 방법

    # isort 설치
    pip install isort
    pip3 install isort 
    brew install isort

• isort 사용 방법

    # 특정 파일 정렬
    isort mypythonfile.py
    isort mypythonfile_1.py mypythonfile2.py
  
    # 디렉토리 내 모든 Python 파일 정렬
    isort .
  
    # 수정 없이 정렬 확인
    isort mypythonfile.py --check
  
    # 변경 사항 확인
    isort mypythonfile.py --diff