PEP8
PEP8이란 파이썬 코드를 작성할 때 개발자들이 공통적으로 지키자고 약속한 룰이다.
최근 파이썬으로 코드를 짜다가 내 코드를 나만 보니 너무 막짠다는 생각이 들어서 프로젝트가 끝난 겸 코드를 조금 다듬기로 했다.
코드 작성할 때 간과하고 넘어갔거나 몰랐던 부분 위주로 포스팅할 계획이다.
1. 모듈, 함수에 주석 달기
팀원과 코드를 공유할 때 위주로 주석을 달아왔었는데 시간이 지나니 내 코드를 나도 못 알아보기 시작했다.
갈수록 모듈화의 중요성을 알아가면서 모듈과 함수에 둘 다 주석 다는 습관을 들여야겠다.
2. 함수작성시 hint 활용
파이썬은 동적 프로그래밍 언어이므로 변수의 타입이 고정되어 있지 않다.
덕분에 간단명료한 코드를 작성할 수 있지만 프로그램 규모가 커질수록 이 점이 위험 요소가 될 수 있다.
따라서 타입 힌팅(type hinting)을 해주면 이 부분이 보완된다.
사실 내가 타입 힌팅을 해야겠다고 생각한 이유는 팀원이 이렇게 작성한 코드를 봤는데 편하게 읽혀서 나도 해야겠다고 다짐했다.
"""
모듈명: Test 모듈
모듈 description: oo 테스트를 위한 모듈
"""
import os
import pandas as pd
import numpy as np
def sum(a,b: int) -> int:
"""
기능: 덧셈 함수
설명: 인자 a,b를 더하는 함수
Args:
arg1(int): oo 인자
arg2(int): oo 인자
Returns:
int
"""
result = a+b
return result
1,2번을 보완해 대충 이런 식으로 짤 것이다 하는 예시임
3. 띄어쓰기
이 부분은 애매하게 알고 있던 부분이었는데 이번에 찾아보면서 확실하게 알게되었다.
파라미터 값을 나타낼 때는 '='주변에 띄어쓰기를 하지 말자
def sum(a=1,b=1):
result = a+b
return result내가 짠 코드를 보니깐 띄어쓰기가 제 멋대로였는데 앞으로는 표준에 맞춰서 작성해야겠다.
4. 코드 최대길이는 79자로
한 줄의 코드 최대길이는 79자로 맞춰야한다. 팀마다 100자로 늘리는 경우가 있다고는 한다.
79자가 넘어갈경우 백슬래시('\')를 활용하면 된다.
파이썬 개발자라면 PEP8을 쭉 훑어보는 것도 괜찮을 것 같다. 개발하면서 자연스레 알고 있었던 것도 있지만 '아 이게 표준이구나' 하던 것도 꽤 있었다.
