Python Formatting
A better Python formatter?
How to make code formatting work again for Python (Visual Studio Code on Mac)? - Stack Overflow
formatting - How do you format python code in Visual Studio Code? - Stack Overflow
Videos
Or simply install Black Formatter from VSC extension menu:
https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter
:)
Based on the comments by @starball, @jarmod and additional googling I found that you need to follow those steps:
Step 1. Install Python extension from marketplace: https://marketplace.visualstudio.com/items?itemName=ms-python.python
Step 2. Install one of the formatter packages for Python.
The Python extension supports source code formatting using either autopep8 (the default), black, or yapf.
from and More about it here: https://code.visualstudio.com/docs/python/editing#_formatting
Step 3. Select which code formatter you want to use in python.formatting.provider which is in settings>Extensions>Python (this maybe automatically set after step 1 and step 2). Also, in settings>Extensions>Python there are more options to select.
How to use formatting:
The code formatting is available in Visual Studio Code (VSCode) through the following shortcuts or key combinations:
On Windows Shift + Alt + F
On macOS Shift + Option + F
On Linux Ctrl + Shift + I
Format Selection (Ctrl+K Ctrl+F) - Format the selected text.
Or you can use right click menu:
from: https://mkyong.com/vscode/how-to-format-source-code-in-visual-studio-code-vscode/
and from: https://code.visualstudio.com/docs/editor/codebasics#_formatting
Once VSCode Python's format feature came from the python package, VSCode now offers smarter and more customizable extensions.
autopep8 and Black formatter were provided by Microsoft.
Ruff and yapf were provided by community.
Once you install a formatter extension, you can select it as the default formatter for Python files in VS Code by following the steps below:
- Open a Python file in VS Code.
- Right-click on the editor to display the context menu.
- Select Format Document With....
- Select Configure Default Formatter... from the drop-down menu.
- Select your preferred formatter extension from the list.
You could read document about Formatting in vscode-python for more details.
"[python]": {
"editor.codeActionsOnSave": {
"source.fixAll": "explicit"
},
"editor.defaultFormatter": "charliermarsh.ruff",
"editor.formatOnSave": true
}
I use Ruff and those are the settings for python files. For me the editor.codeActionsOnSave did the trick.
Install the below python packages for Python Code Format supporting in Windows
pip install autopep8
pip install pylint
Once you have successfully installed the packages, Open the code in vs code -> Press Ctrl + A and Ctrl + K, it will format the code.
autopep8 is listed as a requirement. On mac, using brew, you can install it as follows:
brew install autopep8