본문 바로가기
Program/Language

[Python] 코딩 스타일 가이드 #1

by 소중하루 2021. 2. 10.
반응형

Python 코딩스타일
Python 코딩스타일

 

Python 코딩 스타일 가이드

 

 

코딩도 스타일이 있고 그 가이드를 지키는게 좋습니다.

유튜브나 전자책 등 독학으로 Python 을 공부 하시는 분들이 많아지고 있습니다.

독학으로 하다보니 스타일도 제각각이고 구글링 등으로 복사 및 붙여넣기로 짜집기 하듯히 코딩도 하게 됩니다.

변수명을 정하더라도 편한대로 정해서 막코딩하기 일쑤 입니다.

혼자서 코딩하고 원하는 기능만 되면 된다는 분들은 그냥 하시던데로 하면되겠지만 협업 또는 취업을 위해 공부하시는 분들은 꼭 코딩 스타일 가이드를 참조 해서 하시길 바랍니다.

각 언어마다 코딩 스타일 가이드를 하고 있으니 해당 언어의 가이드를 따라 코딩하시는 습관을 기르신다면 나중에 소스를 보더라도 일관성 있는 스타일에 유지보수도 쉬어 질 수 있습니다.

단순 들여쓰기만 보더라도 개발자의 개발 능력이 평가 되기도 합니다.

소스코드를 다른 누가 보더라도 일관성 있어야 하고 알아보기 쉽게 개발되어야 합니다.

 

 

들여쓰기

 

Python3에서는 들여 쓰기를 위해 탭(Tab)과 공백(Space)을 혼합하는 것을 허용하지 않습니다.

탭(Tab) 은 들여 쓰기로 허용하지 않기 때문에 공백(Space) 4개를 사용을 합니다.

1
2
3
def function_name(var_one, var_two,
                  var_three, var_four):
  print(var_one)
cs

 

 

최대 라인 길이

 

모든 행을 최대 79자로 제한합니다.

긴 택스트 블록의 경우 행 길이는 72자로 제한해야 합니다.

창 너비가 80으로 설정된 편집기에서 줄 바꿈을 방지할 수 있고 일부 웹 기반 도구에서는 자동 줄 바꿈이 제공되지 않을 수 있습니다.

 

이항 연산자

 

이항 연산자의 줄바꿈을 할 경우 가독성 문제를 해결하기 위해 연산자 이전에 줄바꿈을 합니다.

 

1
2
3
4
5
6
7
8
9
# 잘못된 예시
total = (val_one +
         val_two +
         (val_three - val_four))
 
# 잘된 예시
total = (val_one
         + val_two
         + (val_three - val_four))
cs

 

빈줄

 

최상위 함수 및 클래스 정의는 두개의 빈줄을 입력합니다.

1
2
3
4
5
 
 
def function_name(var_one, var_two,
                  var_three, var_four):
  print(var_one)
cs

 

 

Imports

 

임포트는 별도의 행으로 작성합니다.

하위 프로세스는 동일 행으로 작성 가능합니다.

1
2
3
4
5
6
7
# 잘못된 예시
import os, sys
 
# 잘된 예시
import os
import sys
from subprocess import Popen, PIPE
cs

 

 

 

 

 

반응형

댓글