Python 네이밍 컨밴션과 변수 이름 잘 짓는 TIP

네이밍 컨밴션

PEP8이란 python enhance proposal로 python을 개선하는 제안서 중에서 코딩 규칙에 대한 제안서라는 뜻이다. 한마디로 파이썬 코딩 스타일 가이드이다. 다음은 내가 주목해야할 가이드 몇가지를 적어보았다.

1. 함수, 변수, attribute : 소문자로 적어줄 것. 두 단어 이상일 경우에는 _ 로 이어줄것 (snake 형식)

   current_date
   count

2. 클래스 : 단어의 첫글자는 대문자로 이루어져야하고 단어가 이어질 경우 항상 단어의 첫글자는 대문자를 지킬 것 (PasCal 형식 혹은 파이썬에서는 CapWords 컨벤션 이라고도 불림)

   def Calculator()

3. 상수 : 모두 대문자 ( 2단어 이상일 경우 단어 사이에 _ 붙이기 )

   PI = 3.14
   MAX = 100000

4. 값이 비어있는지 아닌지를 검사하기 위해 길이를 체크하는 방식을 사용하지 말 것.

   if len(mylist) <= 0 :
       print("비어있음")
   
   if not mylist :
       print("비어있음")

5. 쉼표 앞에는 띄어쓰기를 하지 않음

   (a , n) → (a, n)

참고 자료
예제로 배우는 파이썬 프로그래밍 - 파이썬 코딩 스타일
[python] PEP 8(코딩 스타일 가이드) -- Style Guide for Python Code & 파이썬의 변수 이름 규칙

이름 짓기

1. 가능한 구체적으로 이름 짓기

   '현재 날짜' 
   
   # 나쁜 예
   current
   
   # 좋은 예
   current_date

2. 적당한 길이의 변수 이름

   # 너무 긴 변수 
   maximumNumberOfPointsInModernOlympics
   
   # 너무 짧은 변수
   m, mp, max, points
   
   # 적당한 변수
   team_points_max , points_record

3. 복수형
   -s 를 이용하기보다는 복수의 의미를 나타내는 ‘array’, ‘list_of’ 단어를 붙여서 표현

4. 순서
   중요한 단어를 앞에 쓸 것

참고 자료
네이밍 컨벤션과 변수이름 짓기
좋은 변수 이름 정하기 : 좋은 변수 이름과 변수 이름의 길이 정하기
파이썬 코딩의 스킬 리뷰 2 · lostcatbox