파이썬 PEP-8 Naming Convention

PEP 8 -- Style Guide for Python Code

위 영상을 보면서 PEP-8 Naming convention을 정리해본다

1.regular_variables

• 변수 이름은 소문자, 분리는 밑줄로

a_tango_artist = 'Astor Piazzolla'

2.CONSTANTS

• 파이썬에서는 모든 변수는 바뀔 수 있다. 따라서 실제로 상수는 존재하지 않는다.
• 하지만, 유저가 바꾸는 것을 원치 않을 경우 모두 대문자, 분리는 밑줄로

TANGO_ARTISTS = [
    'Astor Piazzolla',
    'Hugo Díaz',
    'Aníbal Troilo'
]

3.function_names()

• 소문자, 분리는 밑줄로

import random
def random_tango_artist():
    return random.choice(TANGO_ARTISTS)
print(random_tango_artist())

4.ClassNames

• 첫글자 대문자, 분리시에도 대문자

class TangoArtist:
    
    def __init__(self, name):
        
        self.name = name
        
    def __str__(self):
        
        return self.name
    
    
anibal_troilo = TangoArtist(name='Aníbal Troilo')
print(anibal_troilo)

5.FactoryFunctionNames()

• FactoryFunction은 오브젝트를 반환한다
• 그래서 클래스와 똑같은 네이밍 컨밴션을 사용
• 첫글자 대문자, 분리시 대문자

def AstorPiazzolla():
    
    return TangoArtist(name='Astor Piazzolla')


astor_piazzolla = AstorPiazzolla()
print(astor_piazzolla)

6._non_public_properties

• 파이썬은언제나 접근가능하지만, 엔드유저가 사용하기 원치 않는 경우에 주로 사용한다.
• 주로 첫글자 밑줄을 사용

class HugoDiaz(TangoArtist):
    
    def __init__(self):
        
        TangoArtist.__init__(self, name='Hugo Díaz')
        self._instrument = 'Harmonica'
        
    @property
    def instrument(self):
        
        return self._instrument
    
    
hugo_diaz = HugoDiaz()
print(hugo_diaz.instrument)

7.conflicting_names_

• 만약 이름이 사용되고 있다면, 맨 뒤에 밑줄을 붙여준다.

in_ = 'Tango'