[파이썬] 코드 리뷰 시의 코드 스타일 검토 방법

05 Sep 2023

python

잘 정리된 코드는 가독성이 좋고 유지보수가 용이합니다. 따라서 코드 리뷰 시에는 코드 스타일도 검토해야 합니다. 이 글에서는 코드 스타일을 검토하는 방법과 특히 파이썬에서 코드 스타일을 준수하는 방법에 대해 알아보겠습니다.

1. 코드 스타일 검토의 중요성

코드 스타일은 코드의 가독성과 명확성을 결정합니다. 팀 내에서 일관된 코드 스타일을 유지하면 코드를 이해하기 쉽고, 버그를 예방하고, 협업을 용이하게 할 수 있습니다. 또한 코드 스타일 가이드를 준수하는 것은 좋은 개발 습관을 형성하는 데도 도움이 됩니다.

2. 코드 스타일 검토 방법

2.1. Linter 도구 사용

Linter 도구를 사용하면 코드 스타일을 자동으로 검사할 수 있습니다. 파이썬에서는 flake8이라는 인기있는 Linter 도구가 있습니다. 이 도구는 PEP 8 스타일 가이드를 기반으로 코드를 검사합니다.

2.2. PEP 8 스타일 가이드 준수

파이썬에서는 PEP 8이라는 공식적인 스타일 가이드가 있습니다. 이 가이드를 준수하면 일관된 코드 스타일을 유지할 수 있습니다. PEP 8 가이드에는 들여쓰기, 변수명, 함수명, 클래스명 등의 규칙이 포함되어 있습니다.

2.3. Naming Convention 준수

파이썬에서 변수, 함수, 클래스 등의 이름을 짓는 데에는 네이밍 컨벤션을 따라야 합니다. PEP 8 가이드에서는 다음과 같은 네이밍 컨벤션을 제안합니다:

변수와 함수: 소문자와 언더스코어(_)를 사용 (my_variable, calculate_sum)
클래스: 대문자로 시작하는 단어들을 연결하여 사용 (MyClass, EmployeeData)

3. 예시 코드

아래는 파이썬으로 작성된 예시 코드입니다. 이 코드를 코드 스타일 검토의 대상으로 삼아보겠습니다.

def calculate_sum(a, b):
  result = a+b
  return result

def print_sum(a, b):
  sum_result = calculate_sum(a,b)
  print(f"The sum of {a} and {b} is {sum_result}")

위 코드의 스타일을 검토해보면 다음과 같은 문제가 있습니다:

들여쓰기: 네 칸 들여쓰기 대신에 두 칸 들여쓰기를 사용하고 있습니다.
함수명과 변수명: 공백이 없는 스네이크 케이스 대신에 공백이 있는 네이밍을 사용하고 있습니다.

이를 수정하여 올바른 스타일로 변환하면 다음과 같습니다:

def calculate_sum(a, b):
    result = a + b
    return result

def print_sum(a, b):
    sum_result = calculate_sum(a, b)
    print(f"The sum of {a} and {b} is {sum_result}")

4. 결론

코드 스타일은 코드를 이해하기 쉽고 협업을 원활하게 하기 위해 중요합니다. 이를 위해 Linter 도구를 활용하거나 PEP 8 스타일 가이드를 준수하는 것이 좋습니다. 코드 스타일을 검토하여 일관된 스타일을 적용하면 코드의 가독성과 유지보수성을 향상시킬 수 있습니다.