파이썬 네이밍 규칙

핑계를 대자면..

파이썬을 자주 사용하지 않다보니 네이밍하다보면 어떤 컨벤션이 있었는지 매번 헷갈린다. 어떤 컨벤션들이 있는지 많이 모르지만.. 그래도 아는 것은 웬만하면 지키자 주의이기 때문에 네이밍 중에 헷갈리면 매번 찾아보게 된다. 벌써 네다섯번은 찾아본 것 같다.(멍청) 다음에는 찾아보지 않으려고 내가 헷갈려 했던 것들 위주로 정리하는 글.

헷갈렸던 부분들

• 예약 키워드와 동일한 변수명을 사용할 경우
  • 언더스코어를 어딘가 붙였던거 같은데 그게 앞인지 뒤인지.. 한개인지 두개인지..
• 파일명 규칙
  • 클래스는 자바랑 동일하게 PascalCase였는데.. 파일명은 class 명 따라 PascalCase 인지.. snake_case 인지..

1. 예약 키워드와 동일한 변수명을 사용할 경우

• 변수명 뒤에 언더스코어(_) 하나 추가

PEP8 - Prescriptive: Naming Conventions - Function and Method Arguments 항목에 따르면 변수명 뒤에 언더스코어를 붙이는 것이 단어의 약어을 사용하거나 변형하여 사용하는 것보다 낫다고 한다.

Pycharm에서는 예약어를 변수명으로 사용할 경우 밑줄로 알려준다.

다음과 같이 예약어 뒤에 언더스코어(_)를 붙여 사용하자.

2. 모듈(파일)명 규칙

• 전부 소문자
• 짧은 단어
• 가독성을 위해 언더스코어(_) 사용 가능

PEP8 - Prescriptive: Naming Conventions - Package and Module Names
항목에 따르면 모듈 이름은 모두 소문자로 된 짧은 단어를 사용해야 하고 만약 가독성을 향상시킬 수 있다면 언더스코어를 사용할 수 있다.

e.g.
- velog.py
- linked_list.py
- chrome.py

패키지명

• 전부 소문자
• 짧은 단어
• 언더스코어 권장 X

PEP 동일 항목에 패키지 이름 규칙에 대한 내용도 있어서 같이 정리해보자면, 파이썬 패키지의 이름도 모두 소문자로 된 짧은 이름을 사용해야 하지만 밑줄을 사용하는 것은 권장하지 않는다고 한다.

마치며

이번에 PEP 문서에 대해 알게 됐다. PEP 8번 문서가 파이썬 스타일 가이드 문서인데 글 쓰면서 필요한 부분만 읽었는데도 몰랐던 내용을 많이 알게 됐다. 한번 읽어보면 코드의 가독성을 높이는데 도움이 많이 될 것 같다!

참조

• Prescriptive: Naming Conventions