Victor Leung

Visual Studio Code with Python auto-formatting

December 08, 2020

I was writing python code and facing issues with formatting. It becomes a problem with code review and toolings to detect these issues. Life is much easier with formatter integrated with your code editor and auto-fix those issues on save. Here is how to do:

  1. First, install yapf from Google as a formatter:
pip install yapf
  1. Next, in your Visual Studio Code editor, press “Command + Shift + P” for mac for “Ctrl + Shift + P” for linux, and type to search “Open settings (JSON) and add this line:
"python.formatting.provider": "yapf"
  1. If you want to auto format on save instead of just tips in editor, add this setting as well:
"editor.formatOnSave": true
  1. Optionally, if you want to use your project .styles.yapf instead of global styles, add this line as well:
"python.formatting.yapfArgs": [
    "--style", ".style.yapf"
]

Now you can test it out, such as not having a new line at the end of the python file, then press saves, it would fix your new line issue automatically for you.


Written by Victor Leung who is a keen traveller to see every country in the world, passionate about cutting edge technologies.
Get in touch | View my porfolio