Python 이해하기 쉬운 코드 이름 짓기

혹시 이런 통계를 본 적 있는가?

아무래도 내가 이해하기 쉽기 위해, 그리고 남들도 이해하기 쉽게 하기 위해

함수명, 파일명, 변수명 등등 이름 짓는 것이 가장 귀찮은 일들중 하나일 것이다.

그렇다면, 변수명을 잘 짓는 방법도 배워두면 어떨까

여기서는 파이썬에 특화된, 변수명 잘 짓는 방법을 알려주고 있다.

해당 포스팅은 [클린코드, 이제는 파이썬이다] 저서의 일부입니다.

대소문자 표기법

파이썬은 대소문자가 구분되는 언어이며, 공백이 포함될 수 없는 특징이 있다.
널리 알려진 몇 가지 표기법에 대해 알아보자.

• 스네이크 표기법 : this_is_snake_case 이와 같이 언더바 _ 와 영문 소문자를 사용한다.
• 카멜 표기법 : thisIsCamelCase 이와 같이 단어를 언더바가 아닌 대문자로 구분한다. 첫 문자는 소문자이다.
  • 파스칼 표기법 : 위와 조금 다르게 첫 문자도 대문자이다. ThisIsNotCamelCase

PEP8에 따른 명명 규약

• 모듈 이름은 가능한 짧아야하며, 모두 소문자로 구성되어야 한다.
• 클래스 이름은 파스칼 표기법
• 상수 변수는 대문자 스네이크 표기법
• 함수, 메서드, 변수 이름은 소문자 스네이크 표기법
• class에서 private 속성은 _private 같이 언더바 하나로 시작한다.
• class에서 public 속성은 절대 언더바로 시작할 수 없다.

헝가리식 표기법은 굳이?

• 에전에는 IDE 기능의 한계로 변수 타입을 나타내는 헝가리식 표기법을 자주 사용했다
  • int_this_is_val, str_this_is_name 등과 같이 맨 앞에 변수 타입을 적어주는 것
• 하지만 최근에는 IDE 기능 발전으로 굳이 필요없게 됨
• 단, bool 값을 나타내는 변수는 is 혹은 has를 앞에 붙여주는 것이 좋다.