이 튜토리얼에서는 파이썬(Python) 프로그램을 체계적으로 구조화하기 위한 모범 사례들을 살펴봅니다. 잘 정리된 코드는 협업과 유지보수에 큰 도움이 되며, 대부분의 내용은 공식 스타일 가이드인 PEP 8에서 권장하는 사항들입니다. 하나씩 자세히 알아보겠습니다.
1. 탭(Tab)으로 들여쓰기 통일하기
파이썬에서는 들여쓰기가 문법의 일부이므로 일관성이 매우 중요합니다. 여러 함수와 메서드를 작성할 때 임의의 공백 개수를 섞어 사용하는 것보다 탭으로 들여쓰기를 통일하면 코드의 가독성이 크게 향상됩니다.
대부분의 코드 편집기(VS Code, PyCharm 등) 설정에서 탭 한 번에 해당하는 공백 개수(일반적으로 4칸)를 지정할 수 있으니, 프로젝트 시작 전에 미리 맞춰두는 것이 좋습니다.
예제
# 예제
def sample(random):
# statement 1
# statement 2
# ...
return random2. 한 줄은 79자 이내로 유지하기
파이썬에서는 한 줄에 79자를 넘지 않도록 권장합니다. 너무 긴 줄은 화면에 다 담기지 않아 코드를 읽고 리뷰하기 어렵게 만듭니다.
긴 수식이나 조건문은 줄바꿈 문자(\)를 사용해 여러 줄로 나누면 됩니다. 아래 예제를 참고하세요.
예제
# 예제
def evaluate(a, b, c, d):
return (2 ** (a + b) / (c // d) ** d + a - d * b) \
- (3 ** (a + b) / (c // d) ** d + a - d * b)if문에서 여러 조건을 검사해야 하는 경우에도 한 줄이 79자를 초과하기 쉽습니다. 이럴 때는 아래 두 가지 방법 중 하나를 활용하면 됩니다.
예제
# 방법 1: 괄호로 묶기
if (
a + b > c + d and
c + d > e + f and
f + g > a + b
):
print('Hello')
# 방법 2: 역슬래시(\)로 줄바꿈
if a + b > c + d and \
c + d > e + f and \
f + g > a + b:
print('Hello')3. 독스트링(Docstring) 활용하기
함수와 클래스에는 반드시 독스트링(docstring)을 작성하는 습관을 들이세요. 독스트링은 코드가 무엇을 하는지 설명하는 공식 문서 문자열로, help() 함수나 각종 문서화 도구에서 자동으로 활용됩니다.
독스트링은 세 개의 따옴표(""")로 감싸서 작성하며, 한 줄 요약 또는 여러 줄 설명 형태로 사용할 수 있습니다.
예제
def sample():
"""This is a function"""
"""
This
is
a function
"""
class Sample:
"""This is a class"""
"""
This
is
a class
"""마무리
지금까지 파이썬 프로그램을 깔끔하게 구조화하는 세 가지 핵심 원칙, 즉 탭 기반의 일관된 들여쓰기, 79자 이내의 줄 길이 유지, 그리고 독스트링 작성을 살펴보았습니다. 이러한 규칙은 단순히 보기 좋은 코드를 만드는 것을 넘어, 팀원 간의 소통과 장기적인 유지보수 효율을 높여줍니다. 더 나아가 PEP 8 전체 문서와 린터 도구(flake8, black 등)를 함께 활용하면 코드 품질 관리를 자동화할 수 있습니다.
튜토리얼에 대해 궁금한 점이 있다면 댓글로 남겨주세요!