Jello's development blog

Jello's development blog

파이참(pycharm)에서 pep8 가이드 검사하기

들어가며

pep8은 Python을 개발 할 때 사용되는 코딩 스타일 가이드이다. 이를 pycharm에서 자동으로 검사해주도록 설정해보자. vim이나 일반 텍스트 편집기를 사용하여 Python 코드를 작성한다면 flake8같은 도구를 사용하여 자신의 코드가 pep8 스타일을 따르고 있는지 검사할 수 있다.

pycharm에서 pep8 검사

먼저 상단 메뉴바의 pycharm > preferences로 들어가거나, + , 을 눌러서 설정으로 들어간다.

pycharm > preferences

설정 창에서, 왼쪽의 탭에서 Editor > Inspections 으로 들어가서 pep8을 검색한다.

preferences

기본적으로 두 가지 항목이 체크되어있을텐데, PEP 8 coding style violation은 pep 8 의 줄 띄어쓰기, 주석, 띄어쓰기 등의 컨벤션을 검사해주는 항목이고, PEP 8 naming convention violationpep 8의 변수 명명법을 검사해주는 항목이다.

체크를 풀면 검사가 실행되지 않고, 체크박스 왼쪽의 색칠되어있는 사각형을 클릭하면 밑줄의 색깔, 검사 범위 등 검사의 엄격함(Severity)을 설정할 수 있다.

pep8 검사

class와 class 사이에 너무 많은 줄 수가 띄어져 있어서 pycharm이 수정을 제안하는 모습이다.

마치며

여러 명이서 프로젝트를 할 때, 누군가가는 =의 양 옆을 띄어쓰고, 누구는 아니다. 이와 같은 코딩 컨벤션을 맞춰주지 않는다면 코드의 잦은 수정이 일어나게 되고, 일관성 없는 코드가 될 것이다. Python 프로젝트에는 pep8, Javascript에는 jshint등이 컨벤션 가이드를 일치시켜서 일관성을 유지할 수 있게 해준다. 모두 읽기 쉽고 예쁜 코드를 작성하도록 하자.