Python style Guide

파이썬을 4년간 만졌지만 완벽한 스타일 가이드를 따라 패셔니스타가 되지는 못했지만 다른사람의 코드를 보면서, 직접 작성해 보면서, 앞서 간 개발자의 조언으로 서서히 완성시켜갔다.

아래의 설명은 완벽하지 않다. 어떻게 보면 습관일 수 있다. 더 좋은 방법이 있거나 빠져 있는 정보는 댓글로 남겨주면 다른 사람을 위해 큰 도움이 될 것 같다.

만약 정석이 궁금하다면 Python style Guide를 방문하여 확인해보자.

왜 따라야 하는가?

코드는 글과 같이 쉽게 잃혀야 하고 데이터 분석과 같이 해석의 오류가 없어야 한다.
내 동료가 코드를 보고 의도한 대로 이해해야하고 잘 못 해석하는 일은 없어야 한다.

1. 함수명이 길어지면 '_'를 활용하자

def get_user_data(data):
	return data

함수명은 Snake Case(스네이크 케이스)를 따르며 최대한 기능을 표현 할 수 있게 이름을 붙여준다.
그리고 '_'는 3개 이상은 활용하지 않는다. (3개 이상이 되는 순간 너무 길어 보인다.)

2. Class 명은 첫글자에 대문자를 넣어주자.

class ClassName:
	def function1(data):
    	return 

class명은 Camel Case(카멜 케이스)를 따르며 함수와 같이 클래스의 특징이 잘 나타다는 이름을 붙여준다.
Camel Case는 첫글자에 대문자로 넣어주고 함수와 다르게 그 다음 단어 또한 대문자로 시작하며 '_' 없이 붙여준다. (get_user_data -> GetUserData)

3. 상수(변하지 않는 값)은 대문자와 Snake Case를 활용하자.

Maximum_User_Count = 10000

딥러닝 모델링을 할 때나 개발을 하다보면 상수(변하지 않는 값)을 설정할 필요성이 있을 때가 있다.
일반 변수와 구분해서 표현하면 개발하는데 생각보다 큰 도움이 됐다.

4. 기타

그 외에도 내장, 외장 라이브러리를 호출할 때 한줄에 하나의 라이브러리만 호출하는게 좋다.

import os
import time # O

import os, time # X

변수, 함수, 클래스 이름은 기본적으로 특징이나 기능이 유추되게 이름을 붙여주는 것이 좋고 누가 봐도 이해하기 쉽게 개발 하는게 필요하다.

ps. 그외 꿀팁이 있다면 공유 부탁드립니다. :)