Python vs. JS

English

简体中文

English

简体中文

Appearance

Setting Up an Efficient Python Development Environment in VS Code ​

Visual Studio Code (VS Code), with its lightweight, powerful, and highly extensible features, has become one of the most popular Python development tools worldwide. This guide will walk you through setting up a full-featured and highly efficient Python environment in VS Code from scratch.

Step 1: Prerequisites ​

Before you start configuring VS Code, ensure you have the following software correctly installed on your system.

1. Install Python ​

If you haven't installed Python yet, please visit the official website python.org to download the latest version.

Important Note: When installing on Windows, be sure to check the "Add Python to PATH" option on the first page of the installation wizard. This adds Python to your system's environment variables, allowing you to access it directly from the terminal.

After installation, you can verify it by entering the following command in your terminal (Command Prompt or PowerShell):

bash
python --version
# or
python3 --version

2. Install Visual Studio Code ​

Download and install the version of VS Code suitable for your operating system from the official website code.visualstudio.com.

Step 2: Core Configuration ​

With the basic software installed, we need to install the core extension in VS Code to enable it to understand and run Python code.

1. Install the Official Python Extension ​

This is the most crucial step. The official Python extension from Microsoft provides comprehensive Python support for VS Code, including code completion (IntelliSense), code linting, debugging, Jupyter Notebook support, and more.

  1. Open VS Code.
  2. Click the Extensions icon in the sidebar (or use the shortcut Ctrl+Shift+X or Cmd+Shift+X).
  3. Type Python in the search box.
  4. Select the extension published by Microsoft and click Install.

Install Python Extension

2. Select a Python Interpreter ​

After installing the Python extension, you need to tell VS Code which Python interpreter to use (especially if you have multiple versions installed on your system).

  1. Open the Command Palette using the shortcut Ctrl+Shift+P (or Cmd+Shift+P).
  2. Type Python: Select Interpreter and select it.
  3. Choose the Python interpreter you want to use for your current project from the list.

Select Interpreter

In addition to the core Python extension, the following popular community extensions can significantly enhance your coding experience, code quality, and development efficiency.

Core Language Support ​

  • Pylance (ms-python.vscode-pylance): The official recommended Python language server. It brings extremely fast and powerful language support to VS Code, including intelligent code completion, type checking, code navigation, and detailed function signature hints. It is the cornerstone of a modern Python development environment.

Code Readability and Style ​

  • Black Formatter (ms-python.black-formatter): Black is an "uncompromising" code formatter that automatically formats your code to a consistent style compliant with PEP 8, ending all debates about code style.
    • Configuration: After installation, open your settings (settings.json) and add the following code to automatically format on save:
      json
      "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter",
    "editor.formatOnSave": true
}
  • Better Comments (aaron-bond.better-comments): This extension renders comments in different colors based on their type (e.g., !, ?, TODO), making important notes stand out in your code and greatly improving readability.
  • Python Indent (kevinrose.vsc-python-indent): Although VS Code's native Python indentation is good, this extension provides smarter and more precise indentation management, which is especially helpful for complex code blocks and line breaks, effectively preventing annoying indentation errors.
  • Indent Rainbow (oderwat.indent-rainbow): It adds rainbow colors to each level of indentation, making the hierarchical structure of your code clear at a glance.

Development Productivity Tools ​

  • Python Docstring Generator (njpwerner.autodocstring): Quickly generates docstring templates for functions that conform to various standards (like Google, Sphinx, NumPy). Simply type triple quotes (""") below a function definition to trigger it. Writing standard documentation has never been easier.
  • Python Test Explorer (LittleFoxTeam.vscode-python-test-adapter): Provides a clean graphical user interface for your unittest or Pytest tests. You can easily view, run, and debug all your test cases in the VS Code test sidebar.
  • Python PyPI Assistant (twixes.pypi-assistant): This extension allows you to instantly see the latest version, description, license, and other information from PyPI just by hovering over a package name in your requirements.txt or pyproject.toml file. It greatly simplifies the process of checking and managing dependency information.
  • GitLens (eamodio.gitlens): Supercharges the built-in Git capabilities of VS Code. It provides inline git blame annotations (to see who changed each line of code and when), code history visualization, and other powerful features. It is an essential tool for team collaboration.

UI Enhancement ​

  • Bracket Pair Colorizer (Built-in): This was a very popular extension, but now it is natively supported by VS Code. It colors matching bracket pairs ((), [], {}), helping you to quickly identify code blocks.
    • How to enable: Go to Settings (File > Preferences > Settings), search for bracketPairColorization, and ensure the Editor: Bracket Pair Colorization option is checked.

Step 4: Basic Workflow ​

With the environment set up, let's walk through a simple example.

  1. Create a file: Create a new file named hello.py.
  2. Write some code: Enter the following code into the file:
    python
    def greet(name):
    """A simple greeting function"""
    print(f"Hello, {name}! Welcome to VS Code.")

greet("Python Developer")
  3. Run the code: Click the green "Run Python File" play button in the top-right corner of the editor to see the output in the terminal panel below.
  4. Debug the code:
    • Click to the left of a line number to set a red dot, which is a breakpoint.
    • Press F5 to start debugging mode.
    • The code will pause at the breakpoint, where you can inspect variable values, step through the code, and more.

Conclusion ​

By following these steps, you have successfully set up a modern and efficient Python development environment in VS Code. This setup will not only help you write cleaner, higher-quality code but also save a significant amount of time with its various smart tools.

The world of programming is vast. We encourage you to continue exploring the rich ecosystem of VS Code extensions and customize your development setup to best suit your personal workflow and preferences.