2020.08.31

'오류 줄이고 보기도 좋은' 파이썬 코드 정리 툴 5가지

Serdar Yegulalp | InfoWorld
파이썬 코드는 구문이 올바르고 의도한 대로 실행만 된다면 이론적으로는 문제가 없다. 그러나 실무 측면에서는 프로젝트 전반에 일관된 스타일, 가급적 파이썬의 자체 권장 사항에 따른 스타일을 사용하는 것이 좋다. 다행히 이것을 수작업으로 할 필요는 없다. 파이썬 생태계에는 파이썬 소스 코드를 스타일 규약에 맞춰주는 다양한 툴이 있다.
 
© Getty Images Bank

여기서는 파이썬 코드 스타일을 점검하는 데 많이 사용하는 4가지 툴과 그리고 일관성을 위해 코드를 다시 포맷하는 툴 1개를 살펴본다. 파이참(PyCharm) 또는 비주얼 스튜디오 코드와 같은 파이썬 IDE는 이런 툴을 지원하므로 개발 워크플로우에 바로 통합할 수 있다.
 

파이코드스타일

파이코드스타일(Pycodestyle)은 PEP8 권장 사항을 기준으로 파이썬 코드를 검사하고 분석된 코드에서 규약을 벗어나는 부분을 보고서로 정리해 제공하는 파이썬 모듈이다. PEP 8은 들여쓰기할 때 탭을 사용할지 공백을 사용할지부터(그냥 공백 4개를 사용하는 것이 가장 좋음) 변수와 객체의 이름 지정 방법까지 파이썬의 든 코드 규약을 담은 문서다.

단, 파이코드스타일은 문제를 자동으로 수정하지 않는다. 수정은 개발자의 몫이다. 그러나 파이코드스타일은 구성 범위가 넓어 특정 종류의 오류를 표시하지 않도록 하거나 소스 트리의 특정 파일만 파싱하도록 할 수 있다. 또한 파이썬을 지원하는 거의 모든 IDE는 파이코드스타일을 지원하므로 기능성 외에 폭넓은 호환성을 위해서도 좋은 선택이다. 많은 파이썬 코드 린터가 파이썬에서 모듈로 작동하는데 파이코드스타일도 마찬가지다. 파이코드스타일을 사용해 코드를 프로그램 방식으로, 예를 들어 테스트 모음의 일부로 검사할 수 있다.

적합한 용도: 기본적인 PEP 8 준수 확인
 

오토펩8

오토펩8(Autopep8)은 파이코드스타일의 빈틈을 채우는 툴이다. 파이코드스타일을 사용해 무엇을 변경해야 하는지 확인한 후 제안된 권장안에 맞게 코드의 포맷을 수정한다. 기존 파일의 포맷을 수정해 대체하거나 새 파일로 쓸 수도 있다. 또한 파이썬 2에서 파이썬 3으로 변환된 코드 또는 여러 가지의 줄 끝 표시를 사용하는 파일을 정리하는 등 다른 여러 문제도 수정해준다. 그 외에 오토펜8을 프로그램 방식으로 사용해 문자열로 제공된 코드의 서식을 변경할 수 있다.

적합한 용도: PEP-8에 맞게 파일 변환
 

플레이크8

플레이크8(Flake8)은 여러 파이썬 린팅 및 코드 스타일 툴을 하나의 패키지로 합친다. 구문 검사를 사용해 기본적인 오류를 감지하는 파이플레이크(PyFlakes), 그리고 앞서 살펴본 파이코드스타일과 함께 프로젝트의 '순환 복잡성(프로그램에서 발견되는 독립적인 코드 경로의 수)'을 확인하는 부가적인 툴로 유명하다. 순환 복잡성은 예를 들어 기본적인 모듈이 지나치게 기본을 벗어나지 않도록 하려는 경우 유용한 지표가 될 수 있다.

각 분석이 마무리되면 분석된 코드의 전체적인 품질에 대한 백분위수 지표를 제공하므로, 코드베이스의 어느 부분에 가장 문제가 많은지를 신속하게 파악할 수 있다. 플레이크8은 플러그인 시스템도 사용하므로 린팅을 깃 커밋이나 다른 자동화된 작업과 결합해 사용할 수 있다. 예를 들어 문제가 있는 코드를 리포맷터에자동으로 전달하도록 설정할 수 있다.

적합한 용도: 전체적인 코드 품질 검사와 구체적인 권장 사항 확인
 

파이린트

파이린트(Pylint)는 가장 폭넓게 쓰이는 파이썬 린터다. 다른 툴과 마찬가지로 파이썬 코드에서 오류, 코딩 표준과 맞지 않는 부분을 찾고 이를 수정하는 변경을 제안한다. 파이린트는 많은 코드 문제에 대해 알려주는데, 무엇보다 특정 컨텍스트에서 관련성이 없는 문제까지 포함한다는 면에서 가장 완전한 코드 검사기로 평가받고 있다. 결과가 장황할 수 있지만 프로젝트의 특성에 따라 맞춤 설정할 수 있다.

구체적으로 살펴보면 파이린트는 점진적으로 문제가 누적되는 5가지 종류의 문제를 찾는다. 먼저 '규약(Conventions)'은 PEP 8 또는 다른 파이썬 일관성 규칙 위반이다. '리팩터(Refactors)'는 일반적인 실수가 의심되는 코드, 또는 더 효율적으로 또는 덜 혼란스럽게 재작업이 가능한 코드를 가리킨다. 예를 들어 순환 가져오기 또는 하나의 공통 함수로 응축이 가능한 비슷한 라인이 너무 많은 파일 등이 해당한다.

'경고(Warnings)'는 도달할 수 없는 코드(함수에서 return 뒤의 모든 코드) 또는 __init__ 메소드가 누락된 클래스와 같은 파이썬 특유의 문제를 가리킨다. '오류(Error)'는 정의되지 않은 변수와 같은 실제 코드 버그이며, 마지막 '치명적(Fatal)' 문제는 파이린트의 실행 자체를 불가능하게 만드는 문제다.

파이린트를 꽤 유용하지만, 동시에 가장 부담스러운 툴이기도 하다. 이 툴이 제공하는 피드백의 양이 상당하기 때문이다. 다행히 튜닝을 원하는 사람은 파이린트의 상세 수준과 세분성을 프로젝트별로 또는 파일별로 수정할 수 있다. 또한 긴 if 체인 등 지나치게 복잡한 코드나 지원이 중단된 내장 함수에 대한 린팅과 같은 특정 종류의 검사를 추가하는 다양한 파이린트 플러그인도 활용할 수 있다.

적합한 용도: 포괄적인 코드 품질 관리(과부하를 피하기 위한 설정을 조정해야 할 수 있음)
 

블랙

블랙(Black)은 린터나 코드 분석 툴은 아니지만, 더 좋은 코드 품질을 보장하기 위해 스타일을 적용하는 툴이다. 많은 기본적인 스타일 오류를 선제적으로 피하기 위한 수단이므로 앞서 살펴본 다른 툴과 함께 사용할 수 있다.

블랙은 자칭 '타협 없는 코드 포맷터'다. 타협이 없는 것은 라인 길이 외에는 설정 가능한 옵션이 없기 때문이다. 블랙은 파이썬 코드의 포맷을 일관적이고 읽기 편한 한 가지 스타일로 변경하며, 이 과정에서 내부 규칙을 사용해 여러 줄로 된 식과 같은 까다로운 부분도 일관되게 수정한다.

블랙의 장점 중 하나는 포맷에 관한 모든 논쟁을 해결한다는 것이다. 따라서 '바이크쉐딩(bikeshedding)'을 없애고 린터 출력의 노이즈도 줄여준다. 프로젝트의 코드 포맷 방법에 관해 논쟁하지 않아도 되고 수동으로 포맷할 필요도 거의 없다. 그저 블랙을 사용하면 끝이다. 많은 IDE는 구성을 통해 블랙을 사용해 자동으로 코드를 포맷할 수 있다. 또 다른 이점은 파일에 적용되는 변경의 수를 줄여주므로 git 커밋을 더 깔끔하게 해준다는 점이다.

적합한 용도: 코드 베이스를 기본 스타일에 부합하도록 유도

editor@itworld.co.kr


2020.08.31

'오류 줄이고 보기도 좋은' 파이썬 코드 정리 툴 5가지

Serdar Yegulalp | InfoWorld
파이썬 코드는 구문이 올바르고 의도한 대로 실행만 된다면 이론적으로는 문제가 없다. 그러나 실무 측면에서는 프로젝트 전반에 일관된 스타일, 가급적 파이썬의 자체 권장 사항에 따른 스타일을 사용하는 것이 좋다. 다행히 이것을 수작업으로 할 필요는 없다. 파이썬 생태계에는 파이썬 소스 코드를 스타일 규약에 맞춰주는 다양한 툴이 있다.
 
© Getty Images Bank

여기서는 파이썬 코드 스타일을 점검하는 데 많이 사용하는 4가지 툴과 그리고 일관성을 위해 코드를 다시 포맷하는 툴 1개를 살펴본다. 파이참(PyCharm) 또는 비주얼 스튜디오 코드와 같은 파이썬 IDE는 이런 툴을 지원하므로 개발 워크플로우에 바로 통합할 수 있다.
 

파이코드스타일

파이코드스타일(Pycodestyle)은 PEP8 권장 사항을 기준으로 파이썬 코드를 검사하고 분석된 코드에서 규약을 벗어나는 부분을 보고서로 정리해 제공하는 파이썬 모듈이다. PEP 8은 들여쓰기할 때 탭을 사용할지 공백을 사용할지부터(그냥 공백 4개를 사용하는 것이 가장 좋음) 변수와 객체의 이름 지정 방법까지 파이썬의 든 코드 규약을 담은 문서다.

단, 파이코드스타일은 문제를 자동으로 수정하지 않는다. 수정은 개발자의 몫이다. 그러나 파이코드스타일은 구성 범위가 넓어 특정 종류의 오류를 표시하지 않도록 하거나 소스 트리의 특정 파일만 파싱하도록 할 수 있다. 또한 파이썬을 지원하는 거의 모든 IDE는 파이코드스타일을 지원하므로 기능성 외에 폭넓은 호환성을 위해서도 좋은 선택이다. 많은 파이썬 코드 린터가 파이썬에서 모듈로 작동하는데 파이코드스타일도 마찬가지다. 파이코드스타일을 사용해 코드를 프로그램 방식으로, 예를 들어 테스트 모음의 일부로 검사할 수 있다.

적합한 용도: 기본적인 PEP 8 준수 확인
 

오토펩8

오토펩8(Autopep8)은 파이코드스타일의 빈틈을 채우는 툴이다. 파이코드스타일을 사용해 무엇을 변경해야 하는지 확인한 후 제안된 권장안에 맞게 코드의 포맷을 수정한다. 기존 파일의 포맷을 수정해 대체하거나 새 파일로 쓸 수도 있다. 또한 파이썬 2에서 파이썬 3으로 변환된 코드 또는 여러 가지의 줄 끝 표시를 사용하는 파일을 정리하는 등 다른 여러 문제도 수정해준다. 그 외에 오토펜8을 프로그램 방식으로 사용해 문자열로 제공된 코드의 서식을 변경할 수 있다.

적합한 용도: PEP-8에 맞게 파일 변환
 

플레이크8

플레이크8(Flake8)은 여러 파이썬 린팅 및 코드 스타일 툴을 하나의 패키지로 합친다. 구문 검사를 사용해 기본적인 오류를 감지하는 파이플레이크(PyFlakes), 그리고 앞서 살펴본 파이코드스타일과 함께 프로젝트의 '순환 복잡성(프로그램에서 발견되는 독립적인 코드 경로의 수)'을 확인하는 부가적인 툴로 유명하다. 순환 복잡성은 예를 들어 기본적인 모듈이 지나치게 기본을 벗어나지 않도록 하려는 경우 유용한 지표가 될 수 있다.

각 분석이 마무리되면 분석된 코드의 전체적인 품질에 대한 백분위수 지표를 제공하므로, 코드베이스의 어느 부분에 가장 문제가 많은지를 신속하게 파악할 수 있다. 플레이크8은 플러그인 시스템도 사용하므로 린팅을 깃 커밋이나 다른 자동화된 작업과 결합해 사용할 수 있다. 예를 들어 문제가 있는 코드를 리포맷터에자동으로 전달하도록 설정할 수 있다.

적합한 용도: 전체적인 코드 품질 검사와 구체적인 권장 사항 확인
 

파이린트

파이린트(Pylint)는 가장 폭넓게 쓰이는 파이썬 린터다. 다른 툴과 마찬가지로 파이썬 코드에서 오류, 코딩 표준과 맞지 않는 부분을 찾고 이를 수정하는 변경을 제안한다. 파이린트는 많은 코드 문제에 대해 알려주는데, 무엇보다 특정 컨텍스트에서 관련성이 없는 문제까지 포함한다는 면에서 가장 완전한 코드 검사기로 평가받고 있다. 결과가 장황할 수 있지만 프로젝트의 특성에 따라 맞춤 설정할 수 있다.

구체적으로 살펴보면 파이린트는 점진적으로 문제가 누적되는 5가지 종류의 문제를 찾는다. 먼저 '규약(Conventions)'은 PEP 8 또는 다른 파이썬 일관성 규칙 위반이다. '리팩터(Refactors)'는 일반적인 실수가 의심되는 코드, 또는 더 효율적으로 또는 덜 혼란스럽게 재작업이 가능한 코드를 가리킨다. 예를 들어 순환 가져오기 또는 하나의 공통 함수로 응축이 가능한 비슷한 라인이 너무 많은 파일 등이 해당한다.

'경고(Warnings)'는 도달할 수 없는 코드(함수에서 return 뒤의 모든 코드) 또는 __init__ 메소드가 누락된 클래스와 같은 파이썬 특유의 문제를 가리킨다. '오류(Error)'는 정의되지 않은 변수와 같은 실제 코드 버그이며, 마지막 '치명적(Fatal)' 문제는 파이린트의 실행 자체를 불가능하게 만드는 문제다.

파이린트를 꽤 유용하지만, 동시에 가장 부담스러운 툴이기도 하다. 이 툴이 제공하는 피드백의 양이 상당하기 때문이다. 다행히 튜닝을 원하는 사람은 파이린트의 상세 수준과 세분성을 프로젝트별로 또는 파일별로 수정할 수 있다. 또한 긴 if 체인 등 지나치게 복잡한 코드나 지원이 중단된 내장 함수에 대한 린팅과 같은 특정 종류의 검사를 추가하는 다양한 파이린트 플러그인도 활용할 수 있다.

적합한 용도: 포괄적인 코드 품질 관리(과부하를 피하기 위한 설정을 조정해야 할 수 있음)
 

블랙

블랙(Black)은 린터나 코드 분석 툴은 아니지만, 더 좋은 코드 품질을 보장하기 위해 스타일을 적용하는 툴이다. 많은 기본적인 스타일 오류를 선제적으로 피하기 위한 수단이므로 앞서 살펴본 다른 툴과 함께 사용할 수 있다.

블랙은 자칭 '타협 없는 코드 포맷터'다. 타협이 없는 것은 라인 길이 외에는 설정 가능한 옵션이 없기 때문이다. 블랙은 파이썬 코드의 포맷을 일관적이고 읽기 편한 한 가지 스타일로 변경하며, 이 과정에서 내부 규칙을 사용해 여러 줄로 된 식과 같은 까다로운 부분도 일관되게 수정한다.

블랙의 장점 중 하나는 포맷에 관한 모든 논쟁을 해결한다는 것이다. 따라서 '바이크쉐딩(bikeshedding)'을 없애고 린터 출력의 노이즈도 줄여준다. 프로젝트의 코드 포맷 방법에 관해 논쟁하지 않아도 되고 수동으로 포맷할 필요도 거의 없다. 그저 블랙을 사용하면 끝이다. 많은 IDE는 구성을 통해 블랙을 사용해 자동으로 코드를 포맷할 수 있다. 또 다른 이점은 파일에 적용되는 변경의 수를 줄여주므로 git 커밋을 더 깔끔하게 해준다는 점이다.

적합한 용도: 코드 베이스를 기본 스타일에 부합하도록 유도

editor@itworld.co.kr


X