python_note 3. PyCharm의 잔소리에 귀 기울이면

Taekyung Kim·2022년 6월 14일
0

python note

목록 보기
3/4
post-thumbnail

최근에 python을 공부하면서 대부분의 코드 작성을 PyCharm 프로그램으로 진행하고 있는데요.

오류에 크게 여러 종류가 있는 걸 확인할 수 있었습니다.

빨간색 화살표가 나올 때 마다 "또 이번엔 뭐가 틀린거야?"라면서 다시 코드를 확인하는게 이제는 익숙한데요.

회색으로 된 error message의 경우, 동작에 문제가 없으면 알려만 주되 그대로 돌아가더라구요.

그래도 무엇이 불편하길래 경고를 하나 하고 확인하니, 생각보다 다양한 stlye에 대한 조언이 많았습니다.


case 1 : 코드 마지막에 줄바꿈이 없을 때


마지막까지 코드 작성 후 다음 줄바꿈하여 공백 1행이 없는 경우, 위와 같은 메시지가 나왔습니다. 처음에는 당황했었는데, 마지막에 한 줄을 더 추가해 주니 사라졌었네요.

case 2 : 함수 정의 후 간격


def 키워드를 사용해 함수를 정의한 다음, 항상 습관적으로 한 줄을 띄운 다음 코드를 작성했는데요. 규칙 상 두 줄을 띄워야 한다고 하네요. 실제로 두 줄 간격을 맞추고 난 후 거짓말 처럼 error message가 사라졌습니다.

case 3 : 주석 표현


가끔 주석으로 전체 코드에서 어떤 점을 나타내는 지 표시하곤 했는데요.

#주석표현

이렇게 # 기호와 글자 사이에 빈 칸이 없는 경우 위와 같은 메시지가 나왔습니다.

# 주석표현

이런 식으로 수정하면 해당 기호가 사라지더라구요.

PEP 8? PEP 20?


저런 메시지를 자주 접하다보니 드는 의문이 앞에 PEP 8이 무엇을 뜻하는가? 였는데요. PEP는 Python Enterprise Proposal의 약자로, python 코드 작성 시 모두가 편하게 읽고 쓸 수 있도록 하는 일종의 규칙(문법)에 대한 가이드라인이라고 할 수 있겠습니다.

python 창시자 귀도 반 로섬은 "코드는 쓰인 것 보다 훨씬 더 많은 걸 의미한다." 라고 했다는 데요. 아마, 처음 작성 뿐만 아니라 여러 사람이 그것을 읽고 수정하는 것도 매우 중요하기 때문에, 통일성 있게 작성하는 것을 강조하는 말이 아닌가 싶습니다.

PEP 8이 일반적인 코드 작성 규칙이라면, PEP 20은 'python의 선(zen)'에 대해서 서술하는 문서인데요.

Simple is better than complex.
Beautiful is better than ugly.

와 같은 유명 의류 브랜드나 디자인 회사의 슬로건과 비슷한 문장들이 깨알같이 들어 있습니다. 사실 일반적으로 느끼는 형식의 아름다움은 장르 구분 없이 비슷하지 않을까 생각됩니다.




앞으로는 모두가 읽기에 부끄럽지 않은 기본을 지키는 코드 작성을 하겠다고 초보 코더는 다짐합니다. >_<

Appendix


PEP 8 : https://peps.python.org/pep-0008/
PEP 20 : https://peps.python.org/pep-0020/
what is the purpose of PEP 8 in Python?
https://www.javatpoint.com/pep-8-in-python


profile
computer science의 세계에 막 발을 딛고 있는 중입니다.

0개의 댓글