csWiki

the wiki of cscosine

---

Project maintained by cscosine Hosted on GitHub Pages — Theme by mattgraham

Table Of Contents

• ← Back : python
• Setup VS Code to Use Python Efficiently

Setup VS Code to Use Python Efficiently

How to configure a project configured for a smooth VS Code experience with pytest-based testing and debugging.

---

📦 Recommended Extensions

VS Code will prompt you to install recommended extensions automatically.

They are defined in:

.vscode/extensions.json

🔹 extensions.json

{
  "recommendations": [
    "ms-python.python",
    "ms-python.debugpy"
  ]
}

What these do:

• Python extension Python extension for VS Code → Provides:

  • IntelliSense
  • Test Explorer
  • Virtual environment support
  • Debugging integration

• debugpy debugpy → Powers the debugging engine used by VS Code

---

⚙️ Project Configuration

All configuration lives in:

.vscode/

---

🔹 settings.json

{
  "python.testing.pytestEnabled": true,
  "python.testing.unittestEnabled": false
}

• Enables pytest test discovery
• Disables unittest to avoid conflicts

---

🔹 launch.json

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "▶ Debug all tests",
      "type": "debugpy",
      "request": "launch",
      "module": "pytest",
      "args": ["-s", "--run-all"],
      "justMyCode": false
    }
  ]
}

• Used for full test-suite debugging
• Appears in Run & Debug dropdown

---

🔹 tasks.json

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Create venv",
      "type": "shell",
      "command": "python -m venv .venv",
      "problemMatcher": []
    },
    {
      "label": "Install deps",
      "type": "shell",
      "command": "${command:python.interpreterPath} -m pip install -e .[dev]",
      "problemMatcher": []
    },
    {
      "label": "Pre-commit install",
      "type": "shell",
      "command": "pre-commit install",
      "problemMatcher": []
    },
    {
      "label": "Pre-commit run (all files)",
      "type": "shell",
      "command": "pre-commit run --all-files",
      "problemMatcher": []
    },
    {
      "label": "Setup Project",
      "dependsOn": [
        "Create venv",
        "Install deps",
        "Pre-commit install",
        "Pre-commit run (all files)"
      ],
      "dependsOrder": "sequence",
      "problemMatcher": []
    }
  ]
}

• Used for full project bootstrap (virtual environment setup, dependency installation, and pre-commit initialization)
• Includes automated code quality checks via pre-commit hooks
• Cross-platform (Windows, Linux, macOS)
• Supports a single “Setup Project” task to run the entire environment setup in sequence

---

🐍 Environment Setup

Recommended workflow:

python -m venv .venv
source .venv/bin/activate   # Linux/macOS
.venv\Scripts\activate      # Windows

pip install -e .[dev]
code .

---

🧪 Running Tests

▶ Run all tests (debug)

• Open Run & Debug

• Select:

  ▶ Debug all tests
  

• Press F5

---

🧪 Run individual tests

Option 1 — Test Explorer (recommended)

• Open Testing panel (flask icon)

• Click:

  • ▶ run
  • 🐞 debug

Option 2 — Terminal

pytest tests/test_file.py::test_name

---

🏁 Summary

• Install recommended extensions (one-click)
• Activate venv before opening VS Code
• Use Test Explorer for daily workflow
• Use Debug config for full-suite debugging

---