[python] 파이썬 클린 코드 작성 꿀팁 8가지 : 더 깔끔하고 가독성 높은 코드 작성하기!

오늘은 파이썬 개발을 할 때 클린 코드를 작성하는 방법에 대해 알아보려고 해요. 클린 코드는 가독성이 좋고 유지보수가 쉬운 코드를 의미한답니다. 지금부터 몇 가지 유용한 팁을 소개할게요! 😊

---

1. 명확하고 의미 있는 변수명 사용하기

변수명은 코드의 가독성을 크게 좌우해요. 변수명은 그 목적을 분명하게 나타내야 합니다. 예를 들어, a보다는 age, n보다는 number_of_items와 같이 구체적인 이름을 사용해 보세요.

# 나쁜 예
a = 10
b = 20

# 좋은 예
width = 10
height = 20

 

 

2. 함수는 하나의 작업만 수행하게 하기

하나의 함수가 여러 작업을 수행하면 이해하기 어렵고, 유지보수가 힘들어져요. 함수는 가능한 한 하나의 작업만 수행하도록 작성하는 것이 좋습니다.

# 나쁜 예
def process_data(data):
    clean_data = clean(data)
    transformed_data = transform(clean_data)
    save_to_database(transformed_data)

# 좋은 예
def clean_data(data):
    # 데이터 정리 코드
    pass

def transform_data(clean_data):
    # 데이터 변환 코드
    pass

def save_data_to_database(transformed_data):
    # 데이터 저장 코드
    pass

 

 

3. 주석으로 코드 설명하기

주석은 코드를 설명하는 중요한 도구에요. 주석을 적절히 사용하면 다른 사람들이 코드를 이해하는 데 큰 도움이 됩니다. 다만, 너무 과도한 주석은 피하는 것이 좋아요. 코드는 자체적으로도 이해 가능해야 합니다.

# 나쁜 예
a = 10  # a에 10을 할당

# 좋은 예
# 사용자 입력 나이를 저장
age = 10

 

 

4. 일관된 코딩 스타일 유지하기

일관된 코딩 스타일을 유지하는 것은 매우 중요해요. PEP 8 가이드라인을 따르는 것이 일반적입니다. 코딩 스타일을 통일하면 코드의 가독성이 크게 향상돼요.

# 나쁜 예
def myFunction(): print("Hello")

# 좋은 예
def my_function():
    print("Hello")

 

 

5. 리스트 컴프리헨션 사용하기

리스트 컴프리헨션은 리스트를 생성하는 간결하고 효율적인 방법이에요. 코드의 길이를 줄이고 가독성을 높이는 데 도움이 됩니다.

# 나쁜 예
squares = []
for x in range(10):
    squares.append(x ** 2)

# 좋은 예
squares = [x ** 2 for x in range(10)]

 

 

6. 예외 처리하기

예외 처리는 코드의 안정성을 높이는 중요한 부분이에요. 예외 상황을 적절히 처리하면 프로그램이 예기치 않게 종료되는 것을 방지할 수 있어요.

# 나쁜 예
data = {'key': 'value'}
print(data['nonexistent_key'])

# 좋은 예
data = {'key': 'value'}
try:
    print(data['nonexistent_key'])
except KeyError:
    print('Key does not exist')

 

 

7. 불필요한 코드는 제거하기

코드를 작성한 후에는 불필요한 코드를 제거하는 것이 좋아요. 코드가 단순할수록 이해하기 쉽고 유지보수하기도 쉬워요.

# 나쁜 예
def add_numbers(a, b):
    result = a + b
    return result

# 좋은 예
def add_numbers(a, b):
    return a + b

 

 

8. Docstring으로 함수 설명하기

함수나 클래스에 대한 설명을 Docstring으로 작성하면, 다른 사람들이 코드의 목적과 사용법을 쉽게 이해할 수 있어요.

 

def add_numbers(a, b):
    """
    두 수를 더하여 반환합니다.

    Args:
    a (int): 첫 번째 숫자
    b (int): 두 번째 숫자

    Returns:
    int: 두 수의 합
    """
    return a + b

 

---

 

이러한 팁들을 활용하면 파이썬 코드가 더 깔끔해지고 가독성이 높아질 거예요. 클린 코드를 작성하는 습관을 들이면, 개발 속도가 빨라지고 협업도 더 원활해진답니다. 😊