파이썬에서 클래스와 함수의 이름 짓는 법 (가독성 높이기)

오늘은 파이썬에서 클래스와 함수의 작명법에 대해 깊이 생각해보는 시간을 가졌다. 코드의 가독성을 높이고 유지보수를 쉽게 하기 위해서 올바른 작명법을 사용하는 것이 정말 중요하다는 것을 다시금 깨달았다. 그래서 몇 가지 예시 코드와 함께 이 내용을 정리해보려고 한다.

함수 작명법

먼저, 함수 이름을 짓는 방법에 대해 고민하였다. 함수는 보통 소문자로 작성하며, 여러 단어가 연결될 경우 언더스코어(_)로 구분한다. 예를 들어, 사각형의 면적을 계산하는 함수를 만들 때 다음과 같이 이름을 지을 수 있다.

def calculate_area(width, height):
    return width * height

이 함수는 calculate_area라는 이름으로, 무엇을 하는 함수인지 명확하게 알려준다. 또, 함수 이름은 주로 동사로 시작하는 것이 좋다. 데이터베이스에서 사용자 정보를 가져오는 함수는 다음과 같이 지을 수 있다.

def fetch_user_data(user_id):
    # 데이터베이스에서 사용자 정보를 가져오는 코드
    return user_info

이렇게 함으로써, 함수를 호출하는 사람은 그 함수가 어떤 작업을 수행하는지 쉽게 이해할 수 있다.

클래스 작명법

다음으로, 클래스 이름에 대해 생각해보았다. 클래스는 각 단어의 첫 글자를 대문자로 하고, 공백 없이 연결하여 작성하는 것이 좋다. 예를 들어, 사람을 나타내는 클래스를 다음과 같이 만들 수 있다.

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

여기서 Person은 객체의 속성을 명확하게 설명하는 명사로 되어 있다. 또한, 클래스 이름은 무엇을 나타내는지를 명확히 해야 한다. 예를 들어, 고객 주문을 나타내는 클래스는 이렇게 지을 수 있다.

class CustomerOrder:
    def __init__(self, order_id, customer_name):
        self.order_id = order_id
        self.customer_name = customer_name

이름이 CustomerOrder로, 이 클래스가 고객의 주문 정보를 다루는 것임을 분명히 알 수 있다.

오늘 정리한 작명법을 통해 코드의 가독성을 높이는 데 큰 도움이 될 것 같다. 길이와 의미, 일관성에 주의하면서 작명법을 지켜야 한다면, 코드를 읽는 사람뿐만 아니라 자신에게도 유익할 것이다. 앞으로 이 원칙을 잘 지켜서 좋은 코드를 작성해봐야겠다.