본문 바로가기

Programming

Python Coding Convention

반응형

이 글을 쓰기 전에 이 글을 참고하였음을 알려드립니다.

https://spoqa.github.io/2012/08/03/about-python-coding-convention.html


사실 badware.info 를 처음 개발할 때는 약간 시간이 모자란 감도 있었고, 평소 파이썬보단 다른 언어를 사용하던 나에겐

코딩 컨벤션이고 뭐고 다 때려쳐야 했다. (사실 협업을 많이 요하는 작업도 아니였ㄱ.. ㅈㅅ합니다.)


근데 badware.info - v2 (Project Mulgari) 를 하면서 내부 규정이나 그런걸 정하면서 코딩 컨벤션에 대해서 찾아보게 되었다.


사실 코딩 컨벤션과는 크게 관련되어 있지 않지만, Microsoft 의 공식 지정 학습서인 "CODE COMPLETE" 라는 책을 읽어보면 도움이 된다.

(Special Thanks to @rootnix)


제가 처음으로 코딩 컨벤션을 알게 된 것은 CODE COMPLETE라는 책을 통해서이지만, 처음으로 직접 적용해본 건 Best of the Best 3기 경연단계 프로그램을 통해서였다. 기존에는 이론적으로만 알고 있었지만 그냥 귀찮다는 이유나 어짜피 혼자 코딩하는데..라는 생각때문에 이러한 Guideline을 거의 지키지 않았다. (에휴)


근데 경연단계에 오면서 엄청나게(?) 많은 협업을 요하는 작업이 있었고 거의 매일매일이 코드리뷰이자 기능개선, 설계개선등 작업을 하면서 Guideline이 없으면 내 멘탈이 나노입자 형태로 분열될 것이 뻔해서 처음 적용하게 되었다.

(Special Thanks to @PM님)


엥.. 처음에는 복잡할 줄 알았는데 이 파이썬 코딩 컨벤션이 익숙해지면서.. 점점 코드짜는 것이 편해졌다.

흔히 말하는 변수명 정하기도 그렇게 어렵지 않아졌고, 이 규칙을 지킨 다른 사람 코드 보는것도 편해졌다. (이득)


사실 이러한 파이썬 코딩 컨벤션은 PEP라는 제안서에 나와있다.

(PEP : Python Enhance Proposal, 직역하면 파이썬 개선 제안서? 자세한 내용은 PEP 1을 참고할 것)


PEP 제안서에는 번호가 붙게 되는데 그 중 파이썬 언어에 대한 코딩 컨벤션은 PEP 8에 제안서 형태로 나타나 있다.

(https://www.python.org/dev/peps/pep-0008/)

 

일단 지금 여행계획 세워야되서 일단 나중에 쓰도록 하겠다.


저 PEP 8에 대한 번역을 할 계획이다.

- 그냥 읽어보세요 영어 왠만한건 해석 됩니다..


그리고 나는 후쿠오카로 도주한다. 개이득



반응형