코드 네이밍은 서로 몇가지 규칙을 개발자들 사이에서 코드 가독성과 공유시 보다 이해가 쉽도록 하는데 있다.
필수도 지킬 필요는 없지만, 동일한 규칙을 사용하게 되면, 서로 다른 개발자가 개발한 코드라도 이해도가 높아지고 코드의 완성도가 높아지기 때문에 되도록이면 규칙을 정해서 사용하는 것이 좋다.
오늘은 Python 의 Linting highlights syntactical and stylistic problems와 Code Quality 로 활용할 수 있는 Linting 기능을 이용하면 Snake_case Name 경고를 볼 수 있는데, Python에서 추천하는 Code Naming인 Snake Case와 그외 많이 사용하는 Camel Case, 그리고 Upper Case에 대해서 정리해 보겠다.
Snake Case 란
가장 쉽게는 소문자와 언더바를 이용한 변수 네이밍 기법이라고 할 수 있다.
단어 단위로 작성하고 단어와 단어의 연결을 언더바를 통해서 진행하는 것이다.
Python은 대다수의 경우 Snake Case로 할 것을 권고한다.
Upper Case란
모두 대문자로 단어를 작성하고 단어와 단어는 언더바를 통해서 연결하는 방식이다.
Python에서는 값이 변하지 않는 상수에 사용하기를 권고한다.
Camel Case란
소문자로 시작하여 다음 단어에 대문자를 기입하는 방식이다. Python에서는 추천하지 않지만, 과거 많이 사용하던 방식이였다.
Camel Case를 소문자로 시작하는 Lower Camel과 대문자로 시작하는 Upper Camel이 있는데,
Python에서는 Upper Camel 방식을 클래스나 예외 처리에 사용하기를 권고 한다.
아래는 Python에서 추천하는 Code Naming이다.
대부분의 개발자들은 따로 정의된 표준이 없는 경우 일반적인 표준을 따르기 때문에 아래 Code Naming으로 작성한다면 크게 무리가 없을 것으로 판단된다.
https://github.com/naming-convention/naming-convention-guides/tree/master/python
'Python' 카테고리의 다른 글
| VSCode - Pylint로 Python 코드 퀄리티 올리기 (0) | 2024.03.03 |
|---|---|
| Python - Boto3 S3 대량 데이터 가져오기, paginator (0) | 2024.03.03 |
| Python - reverse/reversed 리스트 역순으로 뒤집기 (0) | 2024.03.03 |
| Python - Pylint Error Code 테이블 전체 (0) | 2024.03.03 |
| Python - Pylint Error Code 테이블 전체 (0) | 2024.03.03 |
