클린 코드의 의미
- 기계나 스크립트가 판단할 수 없고 전문가가 판단할 수 있는 것
- 프로그래밍 언어란 아이디어를 다른 개발에게 전달하는 것이고 여기에 클린 코드의 진정한 본질이 있다
⇒ 클린 코드를 정의하기 보다는 좋은 코드 나쁜 코드의 차이점을 확인하고 훌륭한 코드와 좋은 아키텍쳐를 식별하여 자신만의 정의를 하는 것이 좋음
클린코드의 중요성
- 민첩한 개발과 지속적인 배포가 가능
- 유지보수가 가능한 상태로 가독성이 높아야 기획자가 새롭게 기능을 요구할 때마다 리팩토링을 하고 기술 부채를 해결하느라 시간이 오래 걸리지 않음
- 기술부채 발생
- 잠재적인 문제로 언젠가는 돌발 변수가 될 수 있음
클린 코드에서 코드 포매팅의 역할
PEP (Python Enhancement Proposal)
- PEP 8: Style Guide for Python Code 로 가장 잘 알려진 표준이며 띄어쓰기, 네이밍 컨벤션, 줄 길이 제한 등의 가이드라인을 제공
클린 코드를 위한 보조적인 역할, PEP8을 100% 준수한다고 하더라도 여전히 클린 코드의 요건을 충족하지 못할 수 있음
PEP8 특징
- 검색 효율성
- PEP8: 변수에 값을 할당하는 경우와 함수의 키워드 파라미터에 값을 할당하는 경우를 구분
# core.py
#
#
#
def get_location(location: str = ""):
pass
#변수에 값을 할당할 때 띄어쓰기 사용 O
current_location = get_location()
#키워드 인자에 값을 할당할 때 띄어쓰기사용 X
get_location(location=current_location)
- location이라는 키워드 인자에 값이 할당되는 경우를 찾는 경우
$ grep -nr “location=” ./core.py:13:get_location(location=current_location)
- nr 옵션
- n : line number 표시
- r : 해당 디렉토리에서 recursive 하게 subdirectory도 검색
- location이라는 변수에 값이 할당되는 경우를 찾는 경우
$ grep -nr “location =” ./core.py:10:current_location = get_location()
- 일관성
- 더 나은 오류 처리
- 코드 품질
문서화(Documentation)
코드주석(Code comments)
- 가능한 한 적은 주석을 갖는 것을 목표로 해야 함
- 주석 처리된 코드는 절대 없어야 함
Docstring
- 소스 코드에 포함된 문서 (리터럴 문자열)
- 내가 작성한 컴포넌트를 다른 엔지니어가 사용하려고 할 때 docstring을 보고 동작방식과 입출력 정보등을 확인 할 수 있어야 함
- Python은 동적인 데이터 타입을 갖기 때문에 docstring이 큰 도움이 됨
docstring은 코드에서 분리되거나 독립된 것이 아니라 일부
단점은 지속적으로 수작업을 해야 한다는 것 (코드가 변경되면 업데이트를 해야함)
⇒ 가치 있는 문서를 만들기 위해 모든 팀원이 문서화에 노력해야 함
어노테이션
- PEP-3107에서 어노테이션을 소개
- 코드 사용자에게 함수 인자로 어떤 값이 와야 하는지 힌트를 주자는 것
from dataclasses import dataclass
@dataclass
class Point:
lat: float
long: float
def locate(latitude: float, longitude: float) -> Point:
"""맵에서 좌표에 해당하는 객체를 검색"""
pass
- 함수 사용자에게 힌트를 주지만 파이썬이 타입을 검사하거나 강제하지는 않음
어노테이션으로 타입만 지정할 수 있는 것은 아니고, 인터프리터에서 유효한 어떤 것(변수의 의도를 설명하는 문자열, 콜백이나 유효성 검사 함수로 사용할 수 있는 callable)도 가능
EX) 몇 초 후에 어떤 작업을 실행하는 함수
def launch_task(delay_in_seconds):
pass
- delay_in_seconds 파라미터는 긴 이름을 가지고 있어 많은 정보를 담고 있는 것 같아 보이지만 사실 충분한 정보를 제공하지 못함
- 허용 가능한 지연시간은 몇초?
- 분수를 입력해도 되나?
Seconds = float
def launch_task(delay: Seconds):
pass
- Seconds 어노테이션을 사용하여 시간을 어떻게 해석할지에 대해 작은 추상화 진행
- 나중에 입력 값의 형태를 변경하기로 했다면 이제 한 곳에서만 관련 내용을 변경하면 됨
- Seconds = float
어노테이션을 사용하면 __annotations__ 이라는 특수한 속성이 생김
- 어노테이션의 이름과 값을 매핑한 dictionary
아래 locate함수에 대해 __annotations__ 을 출력해보면,
from dataclasses import dataclass
@dataclass
class Point:
lat: float
long: float
def locate(latitude: float, longitude: float) -> Point:
"""맵에서 좌표에 해당하는 객체를 검색"""
pass
print(locate.__annotations__)
{'latitude': <class 'float'>, 'longitude': <class 'float'>, 'return': <class 'main.Point'>}
타입 힌트는 단순히 데이터 타입을 확인하는 것이 아니라 유의미한 이름을 사용하거나 적절한 데이터 타입 추상화를 하도록 도와줄 수 있음
def process_clients(clients: list):
def process_clients(clients: list[tuple[int, str]]):
...
from typing import Tuple
Client = Tuple[int, str]
def process_clients(clients: list[Client]):어노테이션을 도입하면 클래스를 보다 간결하게 작성하고 작은 컨테이너 객체를 쉽게 정의 가능
- @dataclass 데코레이터를 사용하면 별도의 __init__ 메소드에서 변수를 선언하고 할당하는 작업을 하지 않아도 바로 인스턴스 속성으로 인식
# Before
class Point:
def __init__(self, lat, long):
self.lat = lat
self.long = long
# After
from dataclasses import dataclass
@dataclass
class Point:
lat: float
long: float# After
from dataclasses import dataclass
@dataclass
class Point:
lat: float
long: float
print(Point.__annotations__)
# {'lat': <class 'float'>, 'long': <class 'float'>}
print(Point(1, 2))
# Point(lat=1, long=2)Q. 어노테이션은 docstring을 대체하는 것일까?
- 둘은 상호보완적인 개념
def data_from_response(response: dict) -> dict:
if response["status"] != 200:
raise ValueError
return {"data": response["payload"]}
- input, output 형식에 대해서는 알 수 있지만 상세한 내용은 알 수 없음
- ex) respone 객체의 올바른 instance 형태
상세한 내용에 대해서 docstring으로 보완할 수 있음
def data_from_response(response: dict) -> dict:
"""response의 HTTP status가 200이라면 response의 payload를 반환
- response의 예제::
{
"status": 200, # <int>
"timestamp": "....", # 현재 시간의 ISO 포맷 문자열
"payload": {...} # 반환하려는 dictionary 데이터
}
"""
if response["status"] != 200:
raise ValueError
return {"data": response["payload"]}
- input, output의 예상 형태를 더 잘 이해할 수 있고 단위 테스트에서도 유용한 정보로 사용됨
도구설정
- 반복적인 확인 작업을 줄이기 위해 코드 검사를 자동으로 실행하는 기본도구설정
데이터 타입 일관성 검사
- mypy, pytype 등의 도구를 CI build에 포함시킬 수 있음
$ pip install mypy
from typing import Iterable
import logging
logger = logging.getLogger()
def broadcast_notification(message: str, relevant_user_emails: Iterable[str]):
for email in relevant_user_emails:
logger.warning(f"{message} 메세지를 {email}에게 전달")
broadcast_notification("welcome", "user1@domain.com")# mypy가 오류 내뱉지 않음
$ mypy core.py
Success: no issues found in 1 source file
welcome 메세지를 u에게 전달
welcome 메세지를 s에게 전달
welcome 메세지를 e에게 전달
welcome 메세지를 r에게 전달
welcome 메세지를 1에게 전달
welcome 메세지를 @에게 전달
welcome 메세지를 d에게 전달
welcome 메세지를 o에게 전달
welcome 메세지를 m에게 전달
welcome 메세지를 a에게 전달
welcome 메세지를 i에게 전달
welcome 메세지를 n에게 전달
welcome 메세지를 .에게 전달
welcome 메세지를 c에게 전달
welcome 메세지를 o에게 전달
welcome 메세지를 m에게 전달
- 잘못된 호출. 문자열 또한 iterable 객체이므로 for 문이 정상 동작하지만 유효한 이메일 형식이 아님
리스트나 튜플만 허용하도록 더 강력한 타입 제한을 주면,
from typing import List, Tuple, Union
import logging
logger = logging.getLogger()
def broadcast_notification(
message: str, relevant_user_emails: Union[List[str], Tuple[str]]
):
for email in relevant_user_emails:
logger.warning(f"{message} 메세지를 {email}에게 전달")
broadcast_notification("welcome", "user1@domain.com")
> mypy core.py
core.py:14: error: Argument 2 to "broadcast_notification" has incompatible type "str"; expected "list[str] | tuple[str]" [arg-type]
Found 1 error in 1 file (checked 1 source file)
일반적인 코드 검증
- 데이터 타입 이외에도 일반적인 유형의 품질 검사도 가능
- pycodestyle(pep8), flake8
- 더 엄격한 pylint
자동 포매팅
- black formatter
- PEP-8보다 엄격하게 포매팅하여 문제의 핵심에 보다 집중
- —check 옵션을 사용해 코드를 포맷하지않고 표준을 준수하는지 검사만 하는 것도 가능
- CI 프로세스에 통합하여 유용하게 사용될 수 있음
자동 검사 설정
- 리눅스 개발환경에서 빌드를 자동화하는 가장 일반적인 방법은 Makefile을 사용하는 것
'Programming' 카테고리의 다른 글
| Github Actions 설명 및 Black code formatter 예시 (0) | 2024.01.06 |
|---|---|
| [VS Code & WSL] C/C++ #include 지시문에서 suggestion 항목들 안보이는 문제 (0) | 2021.12.27 |
