파이썬으로 코드를 작성하다보면 길어지는 코드를 보다 간결하고 직관적이게
작성할 필요성이 생긴다.
그래서 파이썬은 스타일 가이드를 제시하고 있는데 몇가지 중요한 항목을 정리했다.
1. 탭을 사용하지 말고, 들여 쓰기 4 스페이스를 사용하라.
4개의 스페이스는 작은 들여 쓰기와 큰 들여쓰기를 하기에 좋은 방법으로 제시된다.
그리고, 탭과 스페이스를 섞어서 사용되는 것은 권장하지 않는다.
2. 한줄에 최대 79자 이상을 늘여서 쓰는 것은 자제하라.
코드가 길어질 경우 가급적 줄넘김을 해 주시는 것이 좋다.
3. 함수, 클래스 등의 코드블록 사이에 2개의 blank line을 넣어서 가독성을 높여 준다.
4. 주석은 코드와 같은 줄로 사용하는 것보다는 별도의 줄에 작성하라.
다른 줄에 주석을 작성하는 것이 가독성에 더 좋다.
5.DocString을 사용하라.
DocString은 소스 코드에 포함된 document 이다.
Docstring은 주석이 아니고 코드의 특정 컴포넌트에 대한 문서라고 할 수 있다.
def func_print():
"""이것은 바로
프린터 함수를 사용하는 방법을 담은 DocString 입니다.
"""
return None
print(func_print.__doc__)
-----------------------------
이것은 바로
프린터 함수를 사용하는 방법을 담은 DocString 입니다.
6. Imports 는 한줄로 사용되기 보단 각기 다른 행에 사용되어져야 한다.
# Correct:
import os
import sys
# Wrong:
import os, sys
7. 클래스와 함수의 이름은 일관성이 있어야 한다.
클래스의 경우는 UpperCamelCase 를 사용하고, 함수와 메서드는 lowercase_with_underscores 를 사용한다.
UpperCamelCase 는 식별자의 첫단어는 대문자로 표기하는 것이다. 예를 들어, CallMyClass 와 같이 표기한다.
lowercase_with_underscores 의 예는, file_name 과 같이 사용한다.
8. Binary Operator 앞 또는 뒤로 줄바꿈은 어떻게?
아래 연산자 이후의 줄바꿈은 코드의 길이가 달라 가독성이 떨어짐을 확인할 수 있다.
# Wrong:
# operators sit far away from their operands
income = (gross_wages +
taxable_interest +
(dividends - qualified_dividends) -
ira_deduction -
student_loan_interest)
아래 줄바꿈의 연산자를 작성할 경우에는 한눈에 연산자를 확인할 수 있다.
# Correct:
# easy to match operators with operands
income = (gross_wages
+ taxable_interest
+ (dividends - qualified_dividends)
- ira_deduction
- student_loan_interest)