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

  2. 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 lin

    “python.formatting.provider”: “yapf”

  3. If you want to auto format on save instead of just tips in editor, add this setting as well:

    “editor.formatOnSave”: true

  4. 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.

Profile picture

Experience in software development, application architecture, and deploying cloud solutions for enterprise customers. Strong hands-on skills with a Master's degree in Computer Science and business acumen with a master of business administration (MBA) in Finance. Certified in Amazon Web Services (AWS), Google Cloud Platform (GCP), Microsoft Azure, Kubernetes (CKA, CKAD, CKS, KCNA) and Scrum (PSM, PSPO) with experience in building banking products from scratch. Connect on Linkedin

© 2022, @victorleungtw