pylint

Pylint

Apa itu Pylint?

Pylint adalah penganalisa kode statis untuk Python 2 atau 3. Versi terbaru mendukung Python 3.9.0 dan di atasnya.

Pylint menganalisis kode Anda tanpa benar -benar menjalankannya. Ini memeriksa kesalahan, menegakkan standar pengkodean, mencari bau kode, dan dapat membuat saran tentang bagaimana kode dapat direfaktor.

Memasang

Untuk penggunaan baris perintah, Pylint diinstal dengan:

 Pip Instal Pylint

Atau jika Anda juga ingin memeriksa ejaan dengan enchant (Anda mungkin perlu menginstal perpustakaan Enchant C):

pip install pylint[spelling]

Ini juga dapat diintegrasikan di sebagian besar editor atau IDE. Informasi lebih lanjut dapat ditemukan dalam dokumentasi.

Apa yang membedakan Pylint?

Pylint tidak mempercayai pengetikan Anda dan menyimpulkan nilai -nilai node yang sebenarnya (untuk permulaan karena tidak ada pengetikan ketika Pylint dimulai) menggunakan representasi kode internalnya (astroid). Jika kode Anda import logging as argparse , Pylint dapat memeriksa dan mengetahui bahwa argparse.error(...) sebenarnya adalah panggilan logging dan bukan panggilan argparse. Ini membuat Pylint lebih lambat, tetapi juga memungkinkan Pylint menemukan lebih banyak masalah jika kode Anda tidak sepenuhnya diketik.

[Inference] adalah fitur pembunuh yang membuat kita menggunakan [pylint] dalam proyek kita meskipun betapa lambatnya itu. - Pengguna Pylint Realis, 2022

Pylint, tidak takut menjadi sedikit lebih lambat dari yang sudah ada, juga jauh lebih teliti daripada linter lainnya. Ada lebih banyak cek, termasuk beberapa yang bertele -tele yang dinonaktifkan secara default tetapi dapat diaktifkan menggunakan konfigurasi.

Cara menggunakan pylint

Pylint tidak lebih pintar dari Anda: Ini mungkin memperingatkan Anda tentang hal -hal yang telah Anda lakukan dengan hati -hati atau memeriksa beberapa hal yang tidak Anda pedulikan. Selama adopsi, terutama dalam proyek warisan di mana Pylint tidak pernah ditegakkan, yang terbaik adalah memulai dengan --errors-only bendera, kemudian menonaktifkan pesan konvensi dan refactor dengan --disable=C,R dan secara progresif mengevaluasi kembali dan mengaktifkan kembali pesan ketika prioritas Anda berkembang.

Pylint sangat dapat dikonfigurasi dan memungkinkan untuk menulis plugin untuk menambahkan cek Anda sendiri (misalnya, untuk perpustakaan internal atau aturan internal). Pylint juga memiliki ekosistem plugin yang ada untuk kerangka kerja populer dan perpustakaan pihak ketiga.

Catatan

Pylint mendukung pustaka standar Python di luar kotak. Perpustakaan pihak ketiga tidak selalu didukung, jadi plugin mungkin diperlukan. Tempat yang baik untuk memulai adalah PyPI yang sering mengembalikan plugin dengan mencari pylint <library> . Pylint-Pydantic, Pylint-Django dan Pylint-Sonarjson adalah contoh plugin tersebut. Informasi lebih lanjut tentang plugin dan cara memuatnya dapat ditemukan di plugin.

Sarankan serangkaian bersama Pylint

Projects that you might want to use alongside pylint include ruff ( really fast, with builtin auto-fix and a large number of checks taken from popular linters, but implemented in rust ) or flake8 (a framework to implement your own checks in python using ast directly), mypy, pyright / pylance or pyre (typing checks), bandit (security oriented checks), black and isort (auto-formatting), Autoflake (penghapusan otomatis impor atau variabel yang tidak digunakan), pyupgrade (peningkatan otomatis ke sintaksis python yang lebih baru) dan pydocstringFormatter (PEP257 otomatis).

Alat tambahan termasuk dalam pylint

Pylint dikirimkan dengan dua alat tambahan:

• Pyreverse (alat mandiri yang menghasilkan diagram paket dan kelas.)
• Symilar (Duplikat Pencari Kode yang juga Terpadu dalam Pylint)

Berkontribusi

Kami menyambut semua bentuk kontribusi seperti pembaruan untuk dokumentasi, kode baru, memeriksa masalah untuk duplikat atau memberi tahu kami bahwa kami dapat menutupnya, mengonfirmasi bahwa masalah masih ada, membuat masalah karena Anda menemukan bug atau menginginkan fitur, dll. Semuanya sangat dihargai!

Harap ikuti kode etik dan periksa panduan kontributor jika Anda ingin memberikan kontribusi kode.

Tunjukkan penggunaan Anda

Anda dapat menempatkan lencana ini di readme Anda untuk memberi tahu orang lain proyek Anda menggunakan Pylint.

Pelajari cara menambahkan lencana ke dokumentasi Anda dalam dokumentasi lencana.

Lisensi

Pylint adalah, dengan beberapa pengecualian yang tercantum di bawah ini, GPLV2.

File ikon dilisensikan di bawah lisensi CC BY-SA 4.0:

• doc/logo.png
• doc/logo.svg

Mendukung

Silakan periksa informasi kontaknya.

Dukungan profesional untuk Pylint tersedia sebagai bagian dari langganan tidelift. Tidelift memberi tim pengembangan perangkat lunak satu sumber tunggal untuk membeli dan memelihara perangkat lunak mereka, dengan jaminan tingkat profesional dari para ahli yang paling tahu, sementara berintegrasi dengan alat yang ada.