기본 콘텐츠로 건너뛰기

[git] pylint, pep8를 사용하여 코드스타일 검사





프로젝트의 규모가 커질수록 코드 스타일 통일이 매우 중요합니다.

python에서는 pylint와 pep8을 사용하여 스타일 검사가 다릅니다.
엄밀히 따지면 이둘은 약간 성격이 다릅니다.

우선 pylint에 대해서 먼저 알아보도록 하겠습니다.


$ vim app.py

import requests as rq

def test():
        print('test')

if __name__ == "__main__":
    test()


$ pylint app.py
************* Module app
W:  4, 0: Found indentation with tabs instead of spaces (mixed-indentation)
W:  7, 0: Found indentation with tabs instead of spaces (mixed-indentation)
C:  1, 0: Missing module docstring (missing-docstring)
C:  3, 0: Missing function docstring (missing-docstring)
W:  1, 0: Unused requests imported as rq (unused-import) ... 중략

3종류의 메시지가 출력이 됩니다.

1. 탭을 사용하지 않고 스페이스를 사용
2. docstring을 사용하지 않음
3. 사용하지 않는 모듈을 import

docstring이란?
docstring은 modlue, class, function의 설명을 작성하는 부분입니다. python에서는 
'''
설명...
:parameter {type} : 설명
:return {type} : 설명
'''
의 형태로 작성이 됩니다.


그럼 위의 메시지를 바탕으로 수정을 해보도록 하겠습니다.

$ vim app.py

'''
'''
def test():
    '''
    '''
    print('test')

if __name__ == "__main__":
    test()

$ pylint app.py
************* Module app
C:  1, 0: Empty module docstring (missing-docstring)
C:  3, 0: Empty function docstring (missing-docstring)
... 중략

이번에는 docstring이 비었다고 합니다.(참 까다로운 녀석입니다 ㅋㅋㅋ)

$ vim app.py

'''
2017.03.04
'''
def test():
    '''
    test function입니다.
    '''
    print('test')

if __name__ == "__main__":
    test()

$ pylint app.py
... 중략

이번에는 깨끗하게 출력이 됩니다.


이번에는 작명 표기법에 대한 테스트를 해보겠습니다
카멜 표기법과 스네이크 표기법을 구별을 해서 검사를 해줄지 궁금하네요


$ vim app.py

'''
2017.03.04
'''

class a_test:

    def __init__(self):
        self.aTest = 'asd'

def test():
    '''
    test function 입니다.
    '''
    print('test')

if__name__ == '__main__':
    test()
$ pylint app.py
************* Module app
C:  6, 0: Trailing whitespace (trailing-whitespace)
C:  5, 0: Invalid class name "a_test" (invalid-name)
C:  8, 8: Invalid attribute name "aTest" (invalid-name)
C:  5, 0: Missing class docstring (missing-docstring)
R:  5, 0: Too few public methods (0/2) (too-few-public-methods)
... 중략


클래스 이름과 속성에서 잘못된 이름을 사용했다고 나옵니다. 
클래스 내부에 public methods 적다고 나오네요 2개를 채워야 하나봅니다 

$ vim app.py

'''
2017.03.04
'''

class ATest:

    def __init__(self):
        self.a_test = 'te'

    def test(self):
        print('ATest test method')


def test():
    '''
    test function
    '''
    print('test')

if __name__ == '__main__':
    test():
$ pylint app.py
************* Module app
C:  6, 0: Trailing whitespace (trailing-whitespace)
C:  9, 0: Trailing whitespace (trailing-whitespace)
C:  5, 0: Missing class docstring (missing-docstring)
C: 10, 4: Missing method docstring (missing-docstring)
R: 10, 4: Method could be a function (no-self-use)
R:  5, 0: Too few public methods (1/2) (too-few-public-methods)
... 중략


카멜 케이스와 스네이크 케이스를 적절히 사용을 하니 작명에 대한 이수는 사라졌습니다. 
trailing whitespace는 라인 마지막에 스페이스를 의미 합니다. 

참고로 클래스 이름을 제외한 모든 이름은 스네이크 케이스를  pep8에서 권장을 하고 있습니다.


$ vim app.py

'''
2017.03.04
'''

class ATest:
    '''
    해당 클래스는 어쩌구 저쩌구
    '''

    def __init__(self):
        self.a_test = 'asd'

    def test(self):
        '''
        self.a_test를 어쩌구 저쩌구 함
        '''
        return self.a_test

    def test1(self):
        '''
        해당 메소드는 어쩌구 저쩌구
        '''
        return False

    def _test2(self):
        '''
        해당 메소든는 private입니다
        '''
        return True

def test():
    '''
    test function
    ''''
    print('test')

if __name__ == '__main__':
    test()


$ pylint app.py
... 중략


잘 됩니다. 

그리고 결과를 보면 중략이라고 해놓았는데 

Report
======
13 statements analysed.
Statistics by type
------------------
+---------+-------+-----------+-----------+------------+---------+
|type     |number |old number |difference |%documented |%badname |
+=========+=======+===========+===========+============+=========+
|module   |1      |1          |=          |100.00      |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|class    |1      |1          |=          |100.00      |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|method   |4      |4          |=          |100.00      |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|function |1      |1          |=          |100.00      |0.00     |
+---------+-------+-----------+-----------+------------+---------+
Raw metrics
-----------
+----------+-------+------+---------+-----------+
|type      |number |%     |previous |difference |
+==========+=======+======+=========+===========+
|code      |15     |45.45 |15       |=          |
+----------+-------+------+---------+-----------+
|docstring |18     |54.55 |18       |=          |
+----------+-------+------+---------+-----------+
|comment   |0      |0.00  |0        |=          |
+----------+-------+------+---------+-----------+
|empty     |0      |0.00  |8        |-8.00      |
+----------+-------+------+---------+-----------+
Duplication
-----------
+-------------------------+------+---------+-----------+
|                         |now   |previous |difference |
+=========================+======+=========+===========+
|nb duplicated lines      |0     |0        |=          |
+-------------------------+------+---------+-----------+
|percent duplicated lines |0.000 |0.000    |=          |
+-------------------------+------+---------+-----------+
Messages by category
--------------------
+-----------+-------+---------+-----------+
|type       |number |previous |difference |
+===========+=======+=========+===========+
|convention |0      |0        |=          |
+-----------+-------+---------+-----------+
|refactor   |0      |0        |=          |
+-----------+-------+---------+-----------+
|warning    |0      |0        |=          |
+-----------+-------+---------+-----------+
|error      |0      |0        |=          |
+-----------+-------+---------+-----------+

아래에는 추가적이로 이러한 정보를 나타납니다.

단순하게 pep만 검사를 해보고 싶다. 그리고 new line에 대해서 좀더 엄격하게 검사를 하고 싶다면 . pylint가 아닌 pep8을 사용하시는 것을 권장합니다.

$ pep8 app.py
app.py:4:1: E302 expected 2 blank lines, found 0
app.py:10:5: E301 expected 1 blank line, found 0
app.py:15:5: E301 expected 1 blank line, found 0
app.py:20:5: E301 expected 1 blank line, found 0
app.py:25:1: E302 expected 2 blank lines, found 0

이것이 pep8의 결과입니다.

근데 pep8에서는 카멜 케이스, 스네이크 케이스에 대해서 검사가 엄격하지가 않네요

아무래도 이 두가지를 같이 쓰는것이 좋아보입니다.


댓글

이 블로그의 인기 게시물

[git] git log 확인하기

git log를 통해서 커밋 이력과 해당 커밋에서 어떤 작업이 있었는지에 대해 조회를 할 수 있다. 우선 git에서의 주요 명령어부터 알아보겠다. $ git push [branch name] $ git pull [branch name] 여기서 branch name은 로컬일 경우 해당 브런치 이름만 적으면 되지만 깃허브 원격 저장소로 연결을 원할 경우는 해당 브런치 이름 앞에 꼭 origin을 붙이도록 한다. $ git brnch [branch name] $ git checkout [branch name] branch일경우 해당 브런치를 생성을 한다. 여기서 현재의 브런치를 기준으로 브런치를 따는것이다. checkout은 브런치를 바꾸는 것이다.(HEAD~[숫자]를 이용하면 해당 커밋으로 움직일수 있다.. 아니면 해당 커밋 번호를 통해 직접 옮기는것도 가능하다.) -> 해당 커밋으로 옮기는 것일뿐 실질적으로 바뀌는 것은 없다. 해당 커밋으로 완전히 되돌리려면 reset이라는 명령어를 써야한다. 처음 checkout을 쓰면 매우 신기하게 느껴진다. 막 폴더가 생겼다가 지워졌다가 ㅋㅋㅋㅋㅋ  master 브런치에서는 ht.html파일이 존재하지만 a브런치에서는 존재하지않는다. checkout 으로 변경을 하면 D 로 명시를 해준다.  $ git log 해당 브런치의 커밋 내역을 보여준다. a 브런치의 커밋 내역들이다. (머지 테스트를 하느라 커밋 내용이 거의 비슷하다 ㅋㅋ) master 브런치의 커밋 내역들이다. 커밋 번호, 사용자, 날짜, 내용순으로 등장을 한다. 이건 단순히 지금까지의 내역을 훑어보기 좋다. 좀더 세밀한 내용을 봐보자. $ git log --stat --stat을 붙이면 기존의 로그에서 간략하게 어떤 파일에서

[git] pull을 하여 최신코드를 내려받자

보면 먼가 로고가 다르게 뜨는것을 확인을 할 수가있다. C:\Users\mung\Desktop\etc\study\python-gene>git checkout remotes/origin/master Note: checking out 'remotes/origin/master'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example:   git checkout -b HEAD is now at 29e282a... fetch test C:\Users\mung\Desktop\etc\study\python-gene>git branch * (HEAD detached at origin/master)   master   test1   test2 깃이 잘 쓰면 참 좋은놈인데 어지간히 쓰기가 까다롭다. 처음에 깃을 푸시 성공하는데만 한달정도 걸렸던걸로 기억이 난다.. ㅋㅋㅋ 여담으로  깃 프로필을 가면 아래사진 처럼 보인다. 기여도에 따라서 초록색으로 작은 박스가 채워지는데 저걸 잔디라고 표현을 한다고 합니다 ㅎ 저 사진은 제 깃 기여도 사진입니당 ㅋㅋㅋㅋ 다시 본론으로 돌아와서 ㅋㅋ pull을 하면 깃에 최신 소

[db] mac에서 mysql환경설정 셋팅하기 1편 - 설치 및 접속, ERROR 2002 (HY000) : Can't connect to local MySQL server through socket '/tmp/mysql.sock' (2) 해결방법

mac에서 mysql을 환경설정하는 방법에 대해서 다뤄보도록 하겠습니다. 그동안 aws에서 제공하는 rds를 사용했기 때문에 로컬 디비를 거의 안썼는데 테스트 하고 싶은것이 있어 로컬에 디비설치를 하려고 했더니 몇몇 문제가 발생하여 공유하기 위해 정리를 해봅니다. 크게 설치 및 접속, 보안 및 chatset에 대해서 알아보겠습니다. 우선 아래의 설명은 homebrew가 설치가 되어있어 brew를 사용할 수 있다는 가정하에 설명을 진행을 하도록 하겠습니다. $ brew install mysql brew를 이용하여 mysql을 설치를 해줍니다. 리눅스 같은 경우는 mysql-server를 설치를 하는데 mac에서는 mysql을 설치를 하네요 $ mysql -u root -p Enter password: ERROR 2002 (HY000): Can't connect to local MySQL server through socket '/tmp/mysql.sock' (2) 접속을 시도해 보았더니 로컬 서버에 접속을 할 수 없다고 뜹니다. 에러발생 원인: 디비서버 열려있지 않음. 해결방법: 디비서버 실행 디비를 설치를 했지만 실행을 하지 않았기 때문에 위와같은 에러가 발생을 하게 됩니다. 만약 linux사용자라면 service를 이용하여 서버를 실행시키겠지만 맥에서는 service를 지원을 하지 않는것 같아 다른 방법으로 시도를 해보았습니다. $ mysql.server start Starting MySQL . SUCCESS! mysql.server 명령어를 실행을 시켜주게 되면 /usr/local/bin/mysql.server 가 실행이 됩니다.