python - auto formatter - autopep8, yapf

1 분 소요

PROBLEM: autopep8 not install.

  • 저는 vscode를 주 IDE로 쓰고 있습니다. 특별한 이유는 없고요 그냥 쓰다보니 쓰고있네요.
  • 아무튼, python을 주로 쓰고 있는데, python을 확장 프로그램으로 설치를 해야, 각 클래스들의 주요 method들을 preview해주는 기능이 지원되는 것 같아요. 모든 함수를 다 정확하게 외우고 있지는 못하니까, 이 기능이 없으면 코딩을 하기가 매우 어려워지거든요.
  • 여기까지는 좋은데, python을 확장프로그램으로 설치하고 나면, 다음의 메세지가 반복으로 뜹니다. autopep8을 직접 설치한 적은 없는데, 아마 python을 설치할 때 자동으로 설치되는 것이 아닐까 싶습니다.
Formatter autopep8 is not installed.
  • autopep8이 문제가 있나 싶어서, yapf를 설치해도 같은 결과가 나옵니다.
Formatter yapf is not installed.

BACKGROUND:

What is YAPF?

  • 우선 yapf가 무엇인지를 정리해봅니다. 해당 링크에 작성된 내용에 따르면,
    • 현재 python formatter들인 autopep8이나, pep9ify의 경우 PEP에 따라서, 코드를 코드에 대한 가이드라인을 주는데, 이게 반드시 코드를 더 예쁘게 마드는 것은 아니다.
    • 따라서, YAPF는 다른 접근법으로서, Daniel Jasper가 개발한 clang-format에 기반한다. 즉, “기존 코드가 스타일 가이드를 위반하지 않았더라도, 가장 스타일 가이드를 잘 따를 수 있는 방식으로 코드를 수정한다”.
    • 이러한 아이디어는 Go programming language의 gofmt과 유사하다.
  • 라는 것이죠.

What is autopep8

  • autopep8 또한 유사하며, PEP8 style guide에 맞도록 자동으로 코드를 수정합니다.

SOLUTION:

  • 뭐, 그래서, 저는 yapf를 설치해보기로 합니다.
  • 그냥 pip로 설치합니다.
pip install yapf
  • 그리고, 커맨드라인에서 yapf aaa.py를 치면, 해당 파이썬 파일에서 무엇을 고치면 되는지 말해줍니다.

wrap-up

  • 여담이지만, yapf에서 제공하는 방식이 미묘하게 마음에 들지 않아서, 지우고 autopep8을 설치해보기도 했습니다. 그러나, autopep8도 딱히 yapf와 큰 차이가 있지는 않더군요. 그래서 다시 yapf로 돌아왔습니다.
  • 다만, pip install autopep8이후 커맨드라인에서 각 파일별로 pep8을 어떻게 위배하는지 확인할 수 있다고 하는데, 다음과 같은 에러코드가 뜨고 더 진행되지 않았습니다.
Traceback (most recent call last):
  File "/Users/frhyme/anaconda3/bin/autopep8", line 6, in <module>
    from autopep8 import main
  File "/Users/frhyme/anaconda3/lib/python3.6/site-packages/autopep8.py", line 61, in <module>
    import pycodestyle
ModuleNotFoundError: No module named 'pycodestyle'
  • 이는 pip로 설치했기 때문에 발생한 것으로 보이며, conda로 재설치하여 문제없이 진행되었습니다.
conda install pycodestyle
  • 하여간 python 내에서 이런 library의 version으로 발생하는 문제는 매우 성가신데도, 아직도 그대로 인것 같아요.

댓글남기기