Unduh tryceratops - Unduh Kode Sumber tryceratops

tryceratops

Kategori lainnya

v2.4.1

Unduh

Terinspirasi oleh posting blog ini. Saya menggambarkan proses pembangunan alat ini di sini.

"Bagi mereka yang suka dinosaurus? Dan cobalah bersih/kecuali blok."

Ringkasan

Instalasi dan penggunaan
- Instalasi
- Penggunaan
- Plugin flake8
Pelanggaran
- Dukungan Autofix
- Mengabaikan pelanggaran
- Konfigurasi
Pra-komit
Tunjukkan gaya Anda
Sumber daya tambahan
Berkontribusi
Ubah log
Lisensi
Kredit

Instalasi dan penggunaan

Instalasi

 pip install tryceratops

ATAU

 poetry add -D tryceratops

Penggunaan

 tryceratops [filename or dir...]

Anda dapat mengaktifkan analisis eksperimental dengan menjalankan:

 tryceratops --experimental [filename or dir...]

Anda dapat mengabaikan pelanggaran spesifik dengan menggunakan: --ignore TRYXXX berulang kali:

 tryceratops --ignore TRY201 --ignore TRY202 [filename or dir...]

Anda dapat mengecualikan Dirs dengan menggunakan: --exclude dir/path berulang kali:

 tryceratops --exclude tests --exclude .venv [filename or dir...]

Anda juga dapat secara otomatis beberapa pelanggaran:

 tryceratops --autofix [filename or dir...]

Plugin `flake8`

? Tryceratops juga merupakan plugin untuk flake8 , jadi Anda bisa:

 ❯ flake8 --select TRY src/tests/samples/violations/call_raise_vanilla.py
src/tests/samples/violations/call_raise_vanilla.py:13:9: TRY002 Create your own exception
src/tests/samples/violations/call_raise_vanilla.py:13:9: TRY003 Avoid specifying long messages outside the exception class
src/tests/samples/violations/call_raise_vanilla.py:21:9: TRY201 Simply use 'raise' without specifying exception object again

Pelanggaran

Semua pelanggaran dan deskripsinya dapat ditemukan di dokumen.

Dukungan Autofix

Sejauh ini, AutoFix hanya mendukung pelanggaran: TRY200, TRY201, dan TRY400.

Mengabaikan pelanggaran

Jika Anda ingin mengabaikan pelanggaran dalam file tertentu, Anda dapat:

Tambahkan komentar dengan noqa ke bagian atas file yang ingin Anda abaikan
Tambahkan komentar dengan noqa ke baris yang ingin Anda abaikan
Tambahkan Komentar dengan noqa: CODE ke baris yang Anda ingin mengabaikan pelanggaran khusus

Contoh:

 def verbose_reraise_1 ():
    try :
        a = 1
    except Exception as ex :
        raise ex  # noqa: TRY202

Konfigurasi

Anda dapat mengatur file pyproject.toml untuk mengatur aturan. Ini berguna untuk menghindari penggunaan kembali bendera CLI yang sama berulang -ulang dan membantu menentukan struktur proyek Anda.

Contoh:

[ tool . tryceratops ]
exclude = [ " samples " ]
ignore = [ " TRY002 " , " TRY200 " , " TRY300 " ]
experimental = false
check_pickable = false
allowed_base_exceptions = [ " MyAppBase " ]

Bendera CLI selalu menimpa file konfigurasi.

Pra-komit

Jika Anda ingin menggunakan pra-komit, tambahkan ini:

  - repo : https://github.com/guilatrova/tryceratops
    rev : v2.4.1
    hooks :
      - id : tryceratops

Tunjukkan gaya Anda

Tambahkan lencana mewah ini ke README.md proyek Anda.

 [ ![ try/except style: tryceratops ] ( https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black )] ( https://github.com/guilatrova/tryceratops )