[VSCode] Setting for Python Autoformatting

먼저 Command Palette > Preferences: Open User Settings (JSON) 에 아래에 있는 것을 추가한다.

"editor.formatOnType": true,
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
    "source.fixAll": true,
    "source.fixAll.eslint": true
},

그리고 python script 파일 아무거나 열어서 save(ctrl + s)를 하면 Formatter autopep8 is not installed. Install? 이라는 에러가 뜬다.

 

Formatter로는 에러창에 뜬 것처럼 autopep8을 사용할 수도 있지만 나는 black을 사용하기 때문에 에러창에 있는 Use black을 클릭하여 black을 설치한다.

 

그리고 열어놓았던 python script를 다시 save하면 black에 의해 reformatting이 자동적으로 된다.

 

하지만 기본값으로 reformatting을 하게되면 줄바꿈이 너무 많이 되는데 다음과 같이 max_length를 지정해주면 조금 더 나아보일 것이다.

"python.formatting.blackArgs": [
        "--line-length",
        "119"
    ]

 

추가로 함수같이 인자를 주어야할 경우 끝에 ,를 꼭 추가해주어야 줄바꿈이 된다.

# 줄바꿈이 안될때
def func(a, b, c):
    return a + b + c

# 줄바꿈이 될때
def func(
    a,
    b,
    c,
):
    return a + b + c

---

Update 2024.11.09

• vscode extension > Black Formatter 설치
• Preferences: Open User Settings (JSON)에 다음 설정 추가

    "[python]": {
        "editor.defaultFormatter": "ms-python.black-formatter",
        "editor.formatOnSave": true
    },

• 줄바꿈이 적용될 최대 길이 설정

"black-formatter.args": ["--line-length", "119"]