파이썬 PEF 8 변수명 규칙

개인적으로 PyCharm을 사용중인데, 

노란 밑줄이 계속 나와서 짜증 중 

스팰링 옵션은 끄긴했는데, 

파이썬 코팅 규칙관련된 옵션은 그냥 끌까 하다. 

지켜보기로 함

 

파이썬 PEF 8 코딩 스티일 규약에 나의 규약을 요약 합니다. (이텔릭체는 저의 의견입니다.) 

참고 : https://www.python.org/dev/peps/pep-0008/

---

클래스 이름: 

클래스 이름은 일반적으로 CapWords 규칙을 사용해야합니다.  Class names should normally use the CapWords convention. 

exception은 클래스이므로, class와 동일하게 적용 / 맨 뒤는 "Error"로 끝나야 합니다. 

 

패키지와 모듈의 이름 : 

모듈 이름은 짧아야 하고, 전부 소문자 여야 합니다. 가독성을 위해서라면 밑줄(_)을 쓸 수 있습니다. 

패키지 이름 또한 짧아야 하고, 전부 소문자 여야 합니다. 밑줄은 권장하지 않습니다 

숫자가 앞에 오면 안됩니다.

 

함수의 이름 : 

함수의 이름은 원칙적으로 소문자여야 하고, 가독성을 위해서 밑줄(_)로 단어를 나눌 수 있습니다. 

간혹 threading.py같이 이미 대/소문자를 혼용하는 경우는 대/소문자를 같이 쓰는 경우도 있습니다. 

클래스 내부에서 사용되는 함수의 경우 함수명 앞에 밑줄을 추가

 

상수의 이름 : 

상수 이름은 전부 대문자와 밑줄로 쓰는 것을 원칙으로 합니다. 

 

변수의 이름 : 

중복되지 많으면 됨 

소문자가 원칙이며, 밑줄 사용에 주위 

 

Type 변수의 이름 : Type variable names 

타입 변수 이름은 짧은 CapWords 방식을 사용한다 

기본 int, string, list, dic 객체외 다른 객체변수라고 보면 됨 

 

따라서, 

 

#클래스명은 CapWords 

class NoteMsg:



# 상수명은 대문자와 밑줄로 

INTEN_NO = 1 



    def __init__(self):

        # 변수명은 소문자로, 가능한 밑줄이 없는 

        self.note = ''



    # 함수명은 언더바가 있는 소문자로 

    def save_msg(self, text):

        self.note += text + '\n'
        

    # 클래스 내부에서만 사용하는 함수명은 언더바가 앞에 

    def _save_clear(self):

        self.note = ''



if __name__ == "__main__":

    # 타입변수는  짧은 CapWords 방식으로 

    eMsg = NoteMsg()

    eMsg.save_msg('1')

    eMsg.save_msg('2')

    eMsg.save_msg('3')



    print(eMsg.note)