[Tips] Python스럽게 코드 작성하기

코딩을 하다 보면 다른 사람의 코드를 참고하는 경우도 많고, 다른 사람이 작업하는 코드를 인수인계받아서 관리해야 하는 일도 생깁니다. 또한 오래전에 작성한 코드를 다시 뜯어봐야 하는 일도 종종 생깁니다. 코드 줄 수와는 무관하게 읽기 쉬운 코드가 있는 반면, 직접 하나씩 돌려봐야 이해가 가는 코드도 있습니다. 읽기 쉽고 이해가 잘되는 코드는 대부분 주석을 세밀하게 잘 작성한 경우이며, 주석이 없어도 코드 자체가 깔끔하고 읽기 편한 스타일이 있습니다. 회사에서 코딩을 하는 분이라면 이러한 경험들을 많이 해보셨을 것 같습니다. 코드가 얼마나 이해하기 쉽고 효율적으로 짜였는지에 따라 그날의 야근 여부가 결정되기도 합니다 ㅎㅎ

 

그래서 오늘은 가독성이 좋고 효율적으로 코드를 작성하는 방법에 대해 포스팅을 하기로 했습니다. 

 

PEP 8 

Python Enhancement Proposal (PEP) 8

여러 국가의 언어 간에 관계와 유사성이 있는 것처럼 프로그래밍 언어들은 서로 공통된 특징을 많이 가지고 있습니다. 자료형, 변수 설정, 연산 방식, 제어문 등 많은 부분이 Universal 하게 공유되고 있습니다. 공통된 특징도 있는 만큼, 각 프로그래밍 언어가 가지는 고유의 특징들도 있습니다. Python 또한 Python에서만 가능한 코드 작성법이 있습니다.

 

코드를 작성하고 공유하는 데 있어서 가독성과 효율성을 높이기 위해 Python 커뮤니티에서 제안하고 발전시킨 PEP 8이라는 가이드가 있습니다. PEP 8 가이드에 맞춰 작성한 코드를 Pythonic Code라고 합니다. 변수 이름을 어떻게 정해야 하는지부터 시작해서 띄어쓰기 개수, 함수를 작성할 때 지켜야 할 법칙, 주석을 어떻게 달아야 할지 등 다양한 규칙이 있습니다. 아래는 PEP 8 공식 문서에서 제공한 들여 쓰기(Indentation)에 대한 규칙 예시입니다.

 

# Function안에 들어가는 Argument끼리는 줄바꿈 시 맞춤 정렬을 해줘야 한다 
# 틀린 방식
foo = long_function_name(var_one, var_two,
    var_three, var_four)

# 올바른 방식
foo = long_function_name(var_one, var_two,
                         var_three, var_four)

# 함수를 정의할 때도 Argument인 부분은 구분이 가능하게 들여쓰기를 해줘야 한다(스페이스 4번)
# 틀린 방식
def long_function_name(
    var_one, var_two, var_three,
    var_four):
    print(var_one)

# 올바른 방식
def long_function_name(
        var_one, var_two, var_three,
        var_four):
    print(var_one)

 

이 외에도 많은 규칙이 있지만, PEP 8 가이드대로 완벽하게 코드를 짜는 것은 사실상 어려운 일입니다. 따라서 실천하기 쉽고 간단한 몇 가지 방법만 소개를 해보도록 하겠습니다.

 

1.  들여 쓰기

위의 예시에서도 간단하게 다루었지만, Python에서는 들여 쓰기를 할 때 공백 4개를 사용하는 것을 권장합니다. Tab의 경우에는 editor과 환경에 따라서 넓이가 달라지는 이유가 큽니다. 또한 코딩을 할 때 공백은 필수적으로 들어가지만, Tab은 들여 쓰기를 할 경우에만 사용되는 경우가 많습니다. 따라서 코드 안에 있는 Whitespace를 공백으로 통일하는 것이 다른 장치나 환경에서 해당 코드를 사용할 때도 편리합니다. 많은 분들이 귀찮아서 Tab를 사용하지만 가급적으로 스페이스 바를 누르는 습관을 들이는 것이 좋을 것 같습니다. (공백을 사용하는 프로그래머가 Tab을 사용하는 프로그래머 보다 돈을 더 많이 번다는? 썰도 있습니다 ㅎㅎ)

 

2. 변수/함수/상수 이름 짓기

변수와 함수명은 소문자, 상수는 대문자로 작성하고, 단어와 단어 사이에는 언더스코어 ( _ )를 사용합니다. 또한 함수 명은 동사로 시작하게 작성하여 어떤 기능을 하는지 명시하는 것이 좋습니다.

 

# 변수명
x = ['a', 'b', 'c']
y = ['d', 'e']
z = ['f']

# 함수명
def calculate_total_length(x,y,z):
    return len(x) + len(y) + len(z)

# 상수
MAX_LENGTH = 1000

 

3. 띄어쓰기

괄호, 쉼표, 콜론 등 주요 구분자 주변에는 공백을 사용해야 합니다. 함수 정의나 클래스 정의를 할 때 함수 위아래로 빈 줄을 하나씩 추가해야 합니다.

 

my_list = [1, 2, 3] # 쉼표 주변에 공백 사용

if x == 0: # 콜론 주변에 공백 사용
    print("x is zero.")

# 함수나 클래스 정의할 때도 위 아래로 빈줄 하나씩 추가
class MyClass:

    def __init__(self):
        pass

    def my_method(self, arg):
        pass

def my_function(arg1, arg2):
    pass

 

4. 주석

사실 가장 중요한 부분은 개인적으로 주석이라고 생각합니다. 너무 많아도 도움이 안 되고, 너무 적어도 설명의 완성도가 떨어지는 게 주석입니다. 적재적소에 적당하게 작성하는 것이 매우 어려운데, 다음과 같은 원칙을 세우면 주석을 잘 쓸 수 있을 것 같습니다:

 

1. 코드의 기능을 설명할 때

코드의 기능을 설명하는 주석은 코드 위쪽에 작성하고, 함수나 메서드, 리턴 값, 예외 처리 등을 설명하는 docstring으로 작성하는 것이 좋습니다. docstring은 작은따옴표 혹은 큰따옴표 세 개로 감싸진 문자열로 아래와 같이 작성하면 됩니다:

 

def calculate_area(base, height):
    """Calculate the area of a triangle.

    Args:
        base (float): The base length of the triangle.
        height (float): The height of the triangle.

    Returns:
        float: The area of the triangle.
    """
    area = 0.5 * base * height
    return area

 

2. 코드의 복잡도 줄이기

코드 블록의 동작과 필요성에 대한 설명이 필요하거나 코드에서 주의해야 할 사항에 대해 알릴 때 사용합니다. 코드 자체로서 설명이 되는 경우에는 과감하게 생략해도 됩니다. 

 

name = name.upper()   # 이렇게 메소드 자체로 설명이 되면 주석을 생략해도 됩니다.

# list에서 중복 element 제거
unique_list = list(set(my_list))

# condition이 True일 때만 실행
while condition:
    do_something()

 

3.  To Do 등 특정 Action이 필요할 때

코드 수정이 필요하거나 주의사항이 필요할 때 작성합니다. 

 

# TODO: 네트워크 요청을 보낼 때 에러가 나는 경우에 대해서 해결 필요
response = requests.get(url)

 

5. Import 문 정리하기

import를 하는 모듈, 패키지, 라이브러리는 파일의 맨 위에서 작성하고 표준 라이브러리, 서드파티, 로컬 모듈 순으로 그룹을 나눠서 순서대로 정리합니다.

 

# built-in function부터 작성
import os
import sys

# 써드파티 모듈 불러오기
import requests
import numpy
import pandas as pd

# 로컬 모듈 불러오기
from my_module import my_function

 

정리하기

오늘 다룬 다섯가지 핵심적인 내용 외에도 PEP8 가이드는 구체적인 상황에서 어떤 코드를 작성해야 하는지에 대해 상세하게 알려줍니다. 줄 바꿈이 필요할 때 쉼표나 연산자를 어떻게 넣을지,  = 주변에 공백을 어떨 때 넣어야 하는지 등 다양한 내용을 다루고 있습니다. 해당 가이드 안에 있는 내용을 100% 실천할 수는 없지만, 위에 언급한 5가지 내용만 지켜도 코드를 읽을 때 큰 도움이 될 것 같습니다.