Python: Naming conventions

xsldihsl·2024년 2월 28일

Python

목록 보기
4/5

오늘은 간단히 Python 에서 쓰이는 naming conventions 에 대해 소개해보고자 한다. 평소에 마음대로 class 나 variables 등의 이름을 정해왔다면 참고하면 좋을 것 같다.

Contents

  1. Camel case
  2. Pascal case
  3. Snake case
  4. Kebab case
  5. Constants
  6. Lists

1. Camel case

먼저 camel case 는 space 나 특수문자 (e.g., underscore, dash) 가 없도록 단어들을 붙여쓰지만, 첫 단어는 소문자로 시작해 그 이후에는 대문자로 구별해주는 것이다. 이렇듯 camel case 라는 이름은 대문자들이 낙타 등의 혹과 비슷하여 붙여졌다고 한다. 예로 들자면 thisIsCamelCase 가 있다. 나는 Java 를 이용할 때 이 표기법을 썼는데, python 에서는 잘 쓰이지 않는다고 한다.

좀 더 구체적으로 들어간다면, 앞서 설명한 방법은 lower camel case 라고 하며, 첫 단어 또한 대문자로 시작하는 표기법은 upper camel case 라고 한다.


2. Pascal case

Pascal case 는 upper camel case 와 동일한 표기법으로, space 나 underscore(_) 같은 특수문자 없이 붙여쓰되, 각 단어의 시작을 대문자로 하는 것이다. 예로 들어 ThisIsPascalCase 로 쓸 수 있다. Python 에서 pascal case 는 주로 class names 에 쓰인다고 한다.

class GameHistory():
	...

3. Snake case

Snake case 는 python 에서 제일 많이, 그리고 널리 쓰이는 표기법으로, 모든 단어를 underscore(_) 를 이용해 구분한다. Snake case 라는 이름은 underscore 로 연결된 모양이 뱀과 같다 하여 붙여진 것이다. 이는 variables 나 functions (or methods) 를 이름짓는데 사용한다. 또한, 파일명을 저장할 때도 자주 쓰이는 것을 볼 수 있다. 예로는 this_is_snake_case 를 들 수 있다.


4. Kebab case

참고로 kebab case 라는 것도 존재하는데, 이는 모든 단어를 소문자와 dash(-) 로 구분하는 것이다. 예로 들어 this-is-kebab-case 가 있다. 이와 같은 kebab case 는 url 주소를 만들거나, css file 등에 주로 사용된다고 한다. Kebab case 는 kebab 의 꼬챙이로 꽂아진 모양같다고 하여 붙여진 이름이다.


5. Constants

예외적으로 constants 를 표현할 때는 모든 문자를 대문자로 표현한다. 예로 들어 PIE = 3.14 가 있다.


6. Lists

마지막으로 list 를 효율적으로 이름 짓기 위해서는 주로 numbers = [1, 2, 3, 4] 와 같이 복수로 표현하거나 number_list 로 specify 해준다. 이처럼 복수로 표현하는 것의 장점은 for 문을 이용함에 있다. 다음을 참고해보자.

for number in numbers:
	...

이처럼 numbers 라는 list 안에 있는 elements 를 number 로 명명하면 가독성을 높일 수 있다.

0개의 댓글