본문 바로가기

카테고리 없음

python 스타일 가이드 정리

- shebang line을 제일 위에 적기

 

- shebang 다음줄에 encoding 적기

 

-  import 할때는 한줄에 여러개를 콤마로 묶지 않고 따로 쓰기 

- 약어는 (as) 는 표준어 처럼 쓰이는 것만 사용 ex numpy as np

- import * 은 사용 금지

- import 할때는 base 가 되는것 부터 먼저 적기

- import 사이는 줄을 띄우지 않지만 너무 많은 경우 섹션을 나누고 섹션 사이는 1줄로 나누기 

 

- 전역 변수는 최대한 사용 금지

 

- string 을 사용할때는 string + string 연산은 금지 (시간이 너무 오래 걸리는 연산)

대신 f-strings 연산을 사용한다. 버전이 3.6보다 낮으면 formatter 사용

f."The Velocity is {vel}."

=>"The Velocity is 500.

- 한줄 길이는 88이하가 되도록 설정

vscode 에서 setting.json 에다가 아래처럼 설정

"python.linting.flake8Args": ["--max-line-length=88"],

- 단 url 은 아무리 길어도 한줄로 적고 url 만 적는다.

 

- 들여쓰기는 스페이스 4개로

 

- class definition 과 최상위 functions 사이는 2줄 띄우기

- class 내부의 method definitions 사이에는 1줄만 띄우기 

- 모든 클래스의 선언 부분에 한문장으로된 짧은 설명 적기

 

- 괄호들 내부에서는 띄어 쓰기 금기

 

- 작명법!!

class 이름, exception 은  CapWords (띄여쓰기 없이)

나머지는 lower_with_under (대문자 없이)

 

 

 

출처 : https://google.github.io/styleguide/pyguide.html#316-naming