Python kodunu PEP8 uyumlu olacak şekilde dönüştürmek için araç

Ben PEP8, örneğin her ikisi de vardır ile Python kodu uyumlu olup olmadığını doğrulamak araçlar vardır biliyor çevrimiçi bir hizmet ve bir piton modülü .

Bununla birlikte, Python dosyamı kendi kendine yeten, PEP8 geçerli bir Python dosyasına dönüştürebilecek bir servis veya modül bulamıyorum . Varsa bilen var mı?
PEP8'in tamamen kodun görünümü ile ilgili olduğunu varsayıyorum, değil mi?

Ne yazık ki "pep8 fırtınasının" (tüm proje) birkaç olumsuz yan etkisi vardır:

• çok sayıda birleştirme çatışması
• git suçu kır
• kod incelemesini zorlaştırmak

Alternatif olarak (ve fikir için @yp sayesinde ), yalnızca son commit / dallanmadan beri üzerinde çalıştığınız satırları autopep8s eden küçük bir paket yazdım:

Temel olarak projeyi bulduğunuzdan biraz daha iyi bırakmak :

pip install pep8radius

İşinizi tamamladığınızı masterve taahhüt etmeye hazır olduğunuzu varsayalım :

# be somewhere in your project directory
# see the diff with pep, see the changes you've made since master
pep8radius master --diff
# make those changes
pep8radius master --diff --in-place

Veya son işlemden bu yana taahhüt ettiğiniz yeni satırları temizlemek için:

pep8radius --diff
pep8radius --diff --in-place

# the lines which changed since a specific commit `git diff 98f51f`
pep8radius 98f51f --diff

Temel pep8radiusolarak git / hg diff çıktısındaki satırlara autopep8 uygulamaktır ( son paylaşılan kaydetmeden ).

Bu komut dosyası şu anda git ve hg ile çalışıyor, eğer başka bir şey kullanıyorsanız ve bunun çalışmasını istiyorsanız lütfen bir yorum / sayı / PR gönderin!

Autopep8'i kullanabilirsiniz ! Kendinize bir fincan kahve hazırlarken, bu araç kodun anlamını değiştirmeyen tüm sinir bozucu PEP8 ihlallerini mutlu bir şekilde ortadan kaldırır .

Pip ile kurun:

pip install autopep8

Bunu belirli bir dosyaya uygulayın:

autopep8 py_file --in-place

veya projenize (özyinelemeli olarak), ayrıntılı seçeneği size nasıl gittiğine dair bazı geri bildirimler verir :

autopep8 project_dir --recursive --in-place --pep8-passes 2000 --verbose

Not: Bazen 100 geçişin varsayılan değeri yeterli değildir, makul derecede yüksek olduğu için 2000 olarak ayarlıyorum ve en zahmetli dosyalar hariç hepsini yakalayacağım (çözülebilir bir pep8 ihlali bulamadığında geçmeyi durdurur) ...

Bu noktada yeniden test etmenizi ve bir taahhütte bulunmanızı öneririm!

"Tam" PEP8 uyumluluğu istiyorsanız : Kullandığım taktiklerden biri, autopep8'i yukarıdaki gibi çalıştırmak, ardından kalan ihlalleri (dosya, satır numarası ve ne) yazdıran PEP8'i çalıştırmaktır:

pep8 project_dir --ignore=E501

ve bunları ayrı ayrı manuel olarak değiştirin (örn. E712s - boole ile karşılaştırma).

Not: autopep8 bir --aggressiveargüman sunar (bu anlam değiştiren ihlalleri acımasızca "düzeltmek" için), ancak agresif kullanırsanız, hata ayıklamanız gerekebilir ... (örn. Numpy / pandalarda True == np.bool_(True)ama değil True is np.bool_(True)!)

Her türden kaç ihlal olduğunu kontrol edebilirsiniz (önce ve sonra):

pep8 --quiet --statistics .

Not: E501'lerin (satır çok uzun) özel bir durum olduğunu düşünüyorum çünkü kodunuzda bunlardan birçoğu olacaktır ve bazen bunlar autopep8 tarafından düzeltilmez.

Örnek olarak, bu tekniği pandaların kod tabanına uyguladım .

@Andy Hayden, autopep8 hakkında iyi bir genel bakış verdi. Buna ek olarak pep8ify adında aynı şeyi yapan bir paket daha var .

Ancak her iki paket de yalnızca tüy bırakma hatalarını kaldırabilir ancak kodu biçimlendiremezler.

little = more[3:   5]

Yukarıdaki kod pep8ifikasyondan sonra da aynı kalır. Ancak kod henüz iyi görünmüyor. Kod PEP8 uyumlu olsa bile kodu biçimlendirecek yapf gibi biçimlendiricileri kullanabilirsiniz . Yukarıdaki kod şu şekilde biçimlendirilecek:

little = more[3:5]

Bazen bu, manuel biçimlendirmenizi bile yok eder. Örneğin

BAZ = {
    [1, 2, 3, 4],
    [5, 6, 7, 8],
    [9, 10, 11, 12]
}

dönüştürülecek

BAZ = {[1, 2, 3, 4], [5, 6, 7, 8], [9, 10, 11, 12]}

Ama ona bazı kısımları görmezden gelmesini söyleyebilirsiniz.

BAZ = {
   [1, 2, 3, 4],
   [5, 6, 7, 8],
   [9, 10, 11, 12]
}  # yapf: disable

Eski blog yazımdan alınmıştır : Otomatik Olarak PEP8 & Python Kodunuzu Biçimlendirin!

Eclipse + PyDev kullanıyorsanız, autopep8'i PyDev'in ayarlarından etkinleştirebilirsiniz: Windows -> Tercihler -> arama filtresine 'autopep8' yazın.

'Kod biçimlendirmesi için autopep8.py kullanılsın mı?' -> Tamam

Şimdi eclipse'in CTRL-SHIFT-F kod biçimlendirmesi, kodunuzu autopep8 kullanarak biçimlendirmelidir :)

Python ve kod stili için farklı araçlar hakkında geniş araştırmalar yaptım. İki tür araç vardır: linterler - kodunuzu analiz etmek ve kötü kullanılan kod stilleri hakkında bazı uyarılar vermek ve nasıl düzeltileceğini gösteren öneriler ve kod biçimlendiriciler - dosyanızı kaydettiğinizde, belgenizi PEP stilini kullanarak yeniden biçimlendirmek.

Yeniden biçimlendirmenin daha doğru olması gerektiğinden - istemediğiniz bir şeyi yeniden biçimlendirirse, işe yaramaz hale gelirse - PEP'in daha az kısmını kaplarlar, linterler çok daha fazlasını gösterir.

Hepsinin yapılandırma için farklı izinleri vardır - örneğin, tüm kurallarında yapılandırılabilen pylinter (her türden uyarıyı açıp kapatabilirsiniz), hiç yapılandırılamayan siyah.

İşte bazı yararlı bağlantılar ve öğreticiler:

Belgeler:

• PEP-257 Docstring Kuralları: https://www.python.org/dev/peps/pep-0257/
• PEP-484 Tip İpucu: https://www.python.org/dev/peps/pep-0484
• Chromium Stil Kılavuzu https://chromium.googlesource.com/chromiumos/docs/+/master/styleguide/python.md
• Otomatik test için Kod Stili https://chromium.googlesource.com/chromiumos/third_party/autotest/+/master/docs/coding-style.md
• Khan Academy Kodlama Stil Kılavuzu https://github.com/Khan/style-guides/blob/master/style/python.md
• Otostopçunun Python Rehberi https://docs.python-guide.org/
• EdX Python Stil Kılavuzu https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/python-guidelines.html
• RealPython'da Kod Stili Makalesi https://realpython.com/python-pep8/

Linters (popülerlik sırasına göre):

• tür kontrolleri için mypy https://github.com/python/mypy linter (PEP-484)
• pycodestyle https://github.com/PyCQA/pycodestyle - PEP-8 kullanan iyi, çok popüler. Genellikle pilint ve pul ile birlikte kullanılır8 (aynı anda)
• pylint https://github.com/PyCQA/pylint çok yapılandırılabilir, aktif olarak destekleniyor
• haydut https://github.com/PyCQA/bandit линтер по безопасности
• prospector https://github.com/PyCQA/prospector pylint + kod zorluk kontrolü
• Eklentileri açma yeteneğine sahip flake8 https://github.com/PyCQA/flake8 pycodestyle sarmalayıcı. Farklı yapılandırılabilir eklentilerin çok büyük listesi. İşte harika flake8 deposu: https://github.com/DmytroLitvinov/awesome-flake8-extensions
• wemake https://github.com/wemake-services/wemake-python-styleguide - bir projede çok sayıda farklı linterleri birleştirmeye çalışmak (gerçekten bu, diğer birkaç linterden stilleri birleştiren bir flake8 eklentisidir)
• pylama https://github.com/klen/pylama 10 başka linteri bir arada birleştirmeye çalışıyor (mypy, pylint, pycodeestyle, pydocstyle ve др.). Buradaki tek sorunu görebiliyorum - eski sürüm (yaklaşık 10 aydır github deposunda güncelleme yok.)
• pydocstyle https://github.com/PyCQA/pydocstyle docstrings linter (PEP-257)

Kod biçimlendiricileri (popülerlik sırasına göre):

• siyah https://github.com/psf/black en populat formatlayıcı, birkaç büyük şirkette kullanılmaktadır. Yapf'tan sonra oluşturuldu, ancak GitHub'da zaten daha fazla başlangıcı var
• yapf https://github.com/google/yapf Google kod biçimlendiricisi
• autopep8 https://github.com/hhatto/autopep8 pycodestyle üzerine inşa edin

Çok var.

IDE'lerde genellikle bazı biçimlendirme yetenekleri bulunur. IntelliJ Idea / PyCharm yapar, aynısı Eclipse için Python eklentisi için de geçerlidir, vb.

Birden çok dili hedefleyebilen biçimlendiriciler / linterler vardır. https://coala.io bunlara güzel bir örnek.

Sonra, diğer cevaplarda birçoğundan söz edilen tek amaçlı araçlar var.

Otomatik yeniden biçimlendirmenin belirli bir yöntemi, dosyayı AST ağacına ayrıştırmak (yorumları düşürmeden) ve ardından metne geri dökmektir (orijinal biçimlendirmeden hiçbir şey korunmaz). Bunun örneği https://github.com/python/black olacaktır .