파이썬(Python) 프로그래밍 가이드라인

import black을 이용하면 PEP8에 맞는 기준 관례 코드로 수정해줌

 

1. 기본적인 관례

 

함수는 프로그램의 공통적인 부분이나 복잡한 부분을 함수화시켜 사용하는 것

 

가능하면 함수 내부는 짧게 작성

 

함수 이름은 함수 역할을 명시하게 작성

 

함수와 함수사이는 두줄 띄어씀

 

함수는 프로그램 맨 위에 작성

 

대소문자 I,O,i,o는 자제하는게 좋음, 0이랑 1, l과 헷갈림

 

불필요하게 많은 공백을 작성하는 것은 자제

 

연산자 안밖으로는 1칸만 띄어쓰는거( 1 + 2 = 3 vs. 1   +     2 =     3)

 

들여쓰기는 tab보다는 4칸 띄어쓰기(space)

 

함수명은 되도록 소문자

 

for문의 순회문자는 i,j,k...가 관례

 

iteration은 0부터 시작하는 것이 관례

 

사람이 이해할 수 있는 변수명을 사용하는 것이 중요함

 

 

2. function type hint

 

함수 인자의 타입을 명시해줌

 

다른 사람들이 알아보기 쉽게 도와줌

 

그림1. function type hint의 예시

 

x에 int, y에 int라고 명시해주었다

 

 

3. function docstring

 

다른 사람들이 함수를 이해하기 쉽게 정의한 함수의 스펙(파라미터, 함수 목적 등)을 구체적으로 명시함

 

“ 3개를 사용하여 함수 맨 위에 작성

 

그림2. docstring 예시

 

위 그림에서 초록색 “”” ~~”””부분이 정의한 함수의 docstring