'Better way 2. PEP 8 스타일 가이드를 따르라' 정리
Series -
Contents
들어가며
Effective Python 2nd 파이썬 코딩의 기술 (교보문고 링크)을 제대로 이해하고자 블로그에 정리합니다. 혹 누군가에게도 도움이 되기를 바랍니다.
현재 위치
Note
<1. Pythonic Thinking>
Item 2: Follow the PEP 8 Style Guide
Item 2: Follow the PEP 8 Style Guide
기억해야 할 내용
책에서 챕터 마지막 부분에 적혀있는 내용입니다.
Tip
Always follow the Python Enhancement Proposal #8 (PEP 8) style guide when writing Python code.
파이썬 코드를 작성할 때는 항상 파이썬 개선 제안 #8(PEP 8) 스타일 가이드를 따르라.
파이썬 코드를 작성할 때는 항상 파이썬 개선 제안 #8(PEP 8) 스타일 가이드를 따르라.
Tip
Sharing a common style with the larger Python community facilitates collaboration with others.
큰 파이썬 커뮤니티와 공통된 스타일을 공유하면 다른 사람과 협력할 때 도움이 된다.
큰 파이썬 커뮤니티와 공통된 스타일을 공유하면 다른 사람과 협력할 때 도움이 된다.
Tip
Using a consistent style makes it easier to modify your own code later.
일관성 있는 스타일을 사용하면 나중에 자신이 작성한 코드를 직접 수정할 때도 더 수월해진다.
일관성 있는 스타일을 사용하면 나중에 자신이 작성한 코드를 직접 수정할 때도 더 수월해진다.
나의 생각
어떤 프로젝트를 참여하던지 코딩 컨벤션을 확인하고 거기에 따라야 합니다.
개발자는 코드 작성하는 데 쓰는 시간보다, 이미 작성된 코드를 보는데 훨씬 더 많은 시간을 보낸다고 합니다.
고로, 읽기 좋은 코드가 바로 좋은 코드입니다. 일관성 있는 코드라야 읽기가 쉽습니다.
읽는 사람을 편하게 해주려고 노력해야 합니다. 물론, 읽는 사람에는 미래의 자기 자신도 포함됩니다. ㅎ
일관성 있는 코드 작성을 위해 노력하고, 뭔가 찜찜하다면 스타일 가이드를 확인합시다.
- PEP 8 https://www.python.org/dev/peps/pep-0008/
- PEP 8 한글 요약 https://codechacha.com/ko/pythonic-and-pep8/
- 구글 파이썬 스타일 가이드 https://google.github.io/styleguide/pyguide.html
스타일 가이드를 꼼꼼히 읽어보면 좋겠지만, 저는 영어도 짧고 시간도 많지 않습니다. (저 글들이 재미 있지도 않습니다 ㅠㅜㅋ)
기본적인 스타일 가이드를 따랐는지는 IDE에서 쉽게 확인해주고 고쳐줍니다.
여러 IDE가 있겠지만 저는 PyCharm 을 추천 합니다. IDE의 경고는 바로 바로 수정하고, 틈나는 데로 Ctrl+Alt+L (Reformat Code)을 눌러주도록 합시다.
처음부터 모든 코딩 컨벤션을 숙지할 수는 없습니다. 일단 만들고자 하는 걸 만들기 시작하는 게 먼저입니다.
코딩 컨벤션을 지켜야 한다는 걸 마음 한 켠에 남겨두기는 합시다.
덧. 이름 짓는 건 언제나 어렵습니다.