Cara Mengkonfigurasi VSCode untuk Pemformatan Auto dan Linting dalam Python

Kod VSCode Python pemformatan automatik dan panduan konfigurasi pemeriksaan kod

VSCode telah menjadi editor kod pilihan ramai pembangun Python kerana fleksibiliti dan ciri yang berkuasa, tetapi ia hanyalah salah satu daripada banyak alat pengeditan kod dan automasi. Bergantung pada aliran kerja, pembangun mungkin lebih suka IDE atau editor lain seperti PyCharm, Teks Sublime, atau bahkan Vim. Panduan ini memfokuskan pada VSCode, menunjukkan cara menyediakan pemformatan automatik dan pemeriksaan kod, tetapi prinsip yang sama digunakan pada alatan lain.

Pembangun Python berusaha untuk mendapatkan kod yang ringkas dan boleh dibaca, dan alatan seperti VSCode memudahkan proses ini melalui pemformatan automatik dan pemeriksaan kod. Dalam panduan ini, kami akan menunjukkan kepada anda cara mengkonfigurasi VSCode untuk pemformatan Python dan pemeriksaan kod menggunakan fail konfigurasi dan arahan CLI untuk memastikan automasi dan mengelakkan campur tangan manual.

Mengapa anda memerlukan pemformatan automatik dan semakan kod?

• Pemformatan automatik Pastikan gaya kod yang konsisten, pematuhan dengan PEP 8 dan menjimatkan masa pada pelarasan manual.
• Pemeriksaan kod mengenal pasti ralat sintaks, import yang tidak digunakan dan isu lain yang berpotensi lebih awal.

Bersama-sama, kedua-duanya membantu mengekalkan kod berkualiti tinggi dan mengurangkan ralat.

Alat diperlukan untuk pemformatan dan pemeriksaan kod

Untuk memformat dan memeriksa kod Python dengan berkesan, anda memerlukan alatan berikut:

Hitam (alat pemformatan)

• Tujuan: Hitam ialah alat pemformatan kod yang berkuasa yang secara automatik memastikan gaya kod yang konsisten dan pematuhan dengan spesifikasi PEP 8.
• Fungsi utama: Permudahkan pemformatan kod tanpa pelarasan manual.
• Pasang: Jalankan pip install black

pylint (alat semakan kod)

• Tujuan: pylint menganalisis kod Python untuk mengenal pasti ralat, menguatkuasakan piawaian pengekodan dan menyerlahkan isu yang berpotensi seperti import yang tidak digunakan atau pembolehubah tidak ditentukan.
• Ciri Utama: Kesan ralat dan kuatkuasakan amalan terbaik.
• Pasang: Jalankan pip install pylint

Konfigurasi automatik menggunakan Hitam dan pylint

Untuk memperkemas lagi aliran kerja anda, anda boleh mengkonfigurasi VSCode untuk memformat dan menyemak kod secara automatik semasa disimpan. Ini menghapuskan keperluan untuk semakan manual dan memastikan kod anda kekal konsisten tanpa usaha tambahan.

Dayakan pemformatan automatik dan pemeriksaan kod pada simpan

Tambahkan pilihan berikut pada fail settings.json anda:

{
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "source.fixAll": true
  }
}

• "editor.formatOnSave": Formatkan kod secara automatik apabila menyimpan fail.
• "editor.codeActionsOnSave": Menjalankan semua pembetulan pemeriksaan kod yang tersedia semasa menyimpan, memastikan sebarang isu yang dikenal pasti diselesaikan secara automatik.

Anda boleh menggunakan settings.json fail konfigurasi untuk menentukan pilihan pemformatan dan pemeriksaan kod tanpa perlu melaraskan tetapan VSCode secara manual.

Kemas kini tetapan VSCode secara pengaturcaraan

Buat atau kemas kini .vscode fail dalam direktori settings.json anda:

{
  "python.formatting.provider": "black",
  "editor.formatOnSave": true,
  "python.linting.enabled": true,
  "python.linting.pylintEnabled": true,
  "python.formatting.blackArgs": ["--line-length=79"],
  "python.linting.pylintArgs": ["--disable=C0114,C0115,C0116"]
}

Ini akan mendayakan Hitam sebagai pemformat, menetapkan panjang baris kepada 79 aksara, mendayakan pemeriksaan kod pylint dan melumpuhkan amaran docstring tertentu.

Tambah sambungan yang disyorkan

Untuk meningkatkan ketekalan kod seluruh pasukan dan memastikan semua ahli menggunakan alatan yang diperlukan, anda boleh menambah extensions.json fail terus pada projek anda:

{
  "recommendations": [
    "ms-python.python",
    "ms-python.black-formatter",
    "ms-python.pylint"
  ]
}

Simpan fail ini dalam direktori .vscode dan namakannya extensions.json.

Perwakilan visual fail konfigurasi

Berikut ialah pecahan fail dan kegunaannya:

文件	用途
.vscode/settings.json	定义项目特定的格式化和代码检查行为设置。
.vscode/extensions.json	推荐团队范围内的开发 IDE 扩展。

Contoh struktur direktori

<code>.vscode/
├── settings.json   # 配置格式化和代码检查行为
├── extensions.json # 推荐 VSCode 扩展</code>

Uji konfigurasi anda

Contoh pemformatan dan pemeriksaan kod

1. Isu pengekodan:

   import os

   def example_function():
           print ( "Hello World" )
   print(undefined_variable)

2. Selepas berlari Hitam:

   import os

   def example_function():
       print("Hello World")

   print(undefined_variable)

3. Selepas menjalankan pylint: amaran berikut akan ditanda:
   • Import yang tidak digunakan: os
   • Pembolehubah tidak ditentukan: pembolehubah_tidak ditentukan

Gunakan Hitam dan pylint bersama-sama

Mengapa menggunakan Black dan pylint bersama-sama?

• Hitam secara automatik memastikan pemformatan yang konsisten dan pematuhan dengan PEP 8.
• pylint mengenal pasti isu kod (cth. import yang tidak digunakan, pembolehubah tidak ditentukan) dan menguatkuasakan piawaian pengekodan.

Aliran kerja menggunakan dua alatan ini

Kemas kini settings.json:

{
  "python.formatting.provider": "black",
  "editor.formatOnSave": true,
  "python.linting.enabled": true,
  "python.linting.pylintEnabled": true,
  "python.formatting.blackArgs": ["--line-length=79"],
  "python.linting.pylintArgs": ["--disable=C0114,C0115,C0116"]
}

Kesimpulan

Konfigurasikan VSCode untuk pemformatan automatik dan semakan kod menggunakan perintah settings.json dan CLI untuk memastikan aliran kerja pembangunan yang lancar dan konsisten. Dengan mengelakkan langkah manual dan memanfaatkan automasi, anda boleh menumpukan pada menulis kod Python berkualiti tinggi tanpa perlu risau tentang isu pemformatan atau pemeriksaan kod.

Selamat pengaturcaraan!

Atas ialah kandungan terperinci Cara Mengkonfigurasi VSCode untuk Pemformatan Auto dan Linting dalam Python. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!