Visual Studio'da Lint Python kodu

Linting işlemi, Python kaynak kodunuzda dil söz dizimi ve stil sorunlarını vurgular. Küçük programlama hatalarını veya hatalara yol açabilecek geleneksel olmayan kodlama uygulamalarını belirlemek ve düzeltmek için kodunuz üzerinde bir linter çalıştırabilirsiniz. Linting başlatılmamış veya tanımlanmamış bir değişkenin kullanımını, tanımsız işlevlere yapılan çağrıları, eksik parantezleri ve yerleşik türleri veya işlevleri yeniden tanımlama girişimleri gibi ince sorunları algılayabilir. Linting, kodunuzun nasıl çalıştığını analiz ettiğinden ve hataları algıladığı için biçimlendirmeden farklıdır. Biçimlendirme ise yalnızca kodunuzun nasıl görüneceğini yeniden yapılandırıyor.

Lint için iki yaygın seçenek pylint ve mypy'dir. Bu araçlar, Python kodundaki hataları denetlemek ve iyi Python kodlama desenlerini teşvik etmek için yaygın olarak kullanılır. Her iki araç da Python projeleri için Visual Studio ile tümleştirilir.

Önkoşullar

  • Visual Studio. Ürünü yüklemek için Visual Studio'yu Yükleme'deki adımları izleyin.
  • Mevcut kodda lint araçlarını çalıştırmak için bir Python projesine erişim.

Linter çalıştırma

Visual Studio'daki lint araçları Çözüm Gezgini'de kullanılabilir.

Aşağıdaki adımlarda kodunuzu denetlemek için lint aracının nasıl kullanılacağı gösterilmektedir.

  1. Visual Studio'da, Çözüm Gezgini'da bir Python projesine sağ tıklayın ve Python'ı seçin, ardından PyLint'i Çalıştır veya Mypy'yi Çalıştır'ı seçin:

    Çözüm Gezgini'da Python projeleri için kullanılabilir lint komutlarını gösteren ekran görüntüsü.

    Komut, seçtiğiniz linter henüz mevcut değilse etkin ortamınıza yüklemenizi ister.

  2. Lint kodunuz üzerinde çalıştıktan sonra Hata Listesi penceresinde tüm lint uyarılarını ve hatalarını gözden geçirebilirsiniz:

    Visual Studio'daki kod dosyası için pylint hatalarının ve uyarılarının listesini gösteren ekran görüntüsü.

  3. Kaynak kodunda sorunun oluşturulduğu konuma gitmek için bir hataya veya uyarıya çift tıklayın.

Komut satırı seçeneklerini ayarlama

Hem pylint hem de mypy, projeniz için lint ayarlarını yapılandırmak için komut satırı seçenekleri sunar.

Bu bölümde, yapılandırma dosyası aracılığıyla pyLint davranışını denetlemek için pylint komut satırı seçeneklerinin kullanıldığı bir .pylintrc örnek gösterilmektedir. Bu dosya, ayarları ne kadar yaygın uygulamak istediğinize bağlı olarak Visual Studio'daki bir Python projesinin köküne veya başka bir klasöre yerleştirilebilir.

Aşağıdaki adımlar, Python projesinde bir .pylintrc dosya kullanarak "eksik docstring" uyarılarını (önceki görüntüde gösterildiği gibi) gizler.

  1. Komut satırında, dosyanın bulunduğu .pyproj proje kök klasörüne göz atın ve açıklamalı bir yapılandırma dosyası oluşturmak için aşağıdaki komutu çalıştırın:

    pylint --generate-rcfile > .pylintrc
    
  2. Çözüm Gezgini'da projeye sağ tıklayın ve Var Olan ÖğeYi Ekle'yi>seçin.

  3. İletişim kutusunda, yeni .pylintrc dosyanın yer aldığı klasöre göz atın. .pylintrc Dosyayı ve ardından Ekle'yi seçin.

  4. Çözüm Gezgini dosyasını düzenlemek üzere açın.pylintrc.

  5. Dosyada yapılandırabileceğiniz çeşitli ayarlar vardır. Bu örnekte bir uyarının nasıl devre dışı bırakılası gösterilmektedir.

    1. [MESSAGES CONTROL] Bölümünü bulun ve ardından bu bölümün disable içindeki ayarı bulun.

      Visual Studio'da pylintrc dosyasının MESSAGES CONTROL bölümünde devre dışı bırakma ayarını gösteren ekran görüntüsü.

      Bu disable ayar, istediğiniz uyarıları ekleyebileceğiniz uzun bir belirli ileti dizesinden oluşur.

    2. Dizeyi ,missing-docstring (virgül ön eki dahil) disable ayar değerine ekleyin:

      Visual Studio'daki pylintrc dosyasındaki devre dışı bırakma ayarına belirli bir uyarı iletisinin nasıl eklendiğini gösteren ekran görüntüsü.

  6. .pylintrc dosyasını kaydedin.

  7. Pylint'i yeniden çalıştırın. "Eksik docstring" uyarılarının artık gizlendiğini fark edin.

Ağ paylaşımından pylintrc dosyasını kullanma

Bir ağ paylaşımından dosya kullanabilirsiniz .pylintrc .

  1. adlı PYLINTRCbir ortam değişkeni oluşturun.

  2. Evrensel Adlandırma Kuralı (UNC) yolunu veya eşlenmiş bir sürücü harfini kullanarak değişkenine ağ paylaşımındaki dosya adının değerini atayın. Örneğin, PYLINTRC=\\myshare\python\.pylintrc.