pep8speaks
pep8speaks is back again!
Aplikasi GitHub untuk secara otomatis meninjau gaya kode Python atas permintaan tarik
pycodestyle atau flake8 sebagai linter Anda. Bot dapat membaca konfigurasi untuk keduanya.setup.cfg Anda untuk bagian [flake8] dan [pycodestyle] . Lihat bagian Configuration di bawah ini. File konfigurasi tidak diperlukan agar integrasi berfungsi . Namun dapat dikonfigurasi tambahan dengan menambahkan file .pep8speaks.yml di akar proyek. Inilah contohnya:
# File : .pep8speaks.yml
scanner :
diff_only : True # If False, the entire file touched by the Pull Request is scanned for errors. If True, only the diff is scanned.
linter : pycodestyle # Other option is flake8
pycodestyle : # Same as scanner.linter value. Other option is flake8
max-line-length : 100 # Default is 79 in PEP 8
ignore : # Errors and warnings to ignore
- W504 # line break after binary operator
- E402 # module level import not at top of file
- E731 # do not assign a lambda expression, use a def
- C406 # Unnecessary list literal - rewrite as a dict literal.
- E741 # ambiguous variable name
no_blank_comment : True # If True, no comment is made on PR without any errors.
descending_issues_order : False # If True, PEP 8 issues in message will be displayed in descending order of line numbers in the file
message : # Customize the comment made by the bot
opened : # Messages when a new PR is submitted
header :
" Hello @{name}! Thanks for opening this PR. "
# The keyword {name} is converted into the author's username
footer :
" Do see the [Hitchhiker's guide to code style](https://goo.gl/hqbW4r) "
# The messages can be written as they would over GitHub
updated : # Messages when new commits are added to the PR
header : " Hello @{name}! Thanks for updating this PR. "
footer : " " # Why to comment the link to the style guide everytime? :)
no_errors : " There are currently no PEP 8 issues detected in this Pull Request. Cheers! :beers: "Catatan:
.pep8speaks.yml Anda akan mengesampingkan nilai -nilai ini..pep8speaks.yml di cabang base (yang sudah ada). Jika file tidak ditemukan, maka ia mencari cabang head (perubahan yang masuk).scanner.linter ke pycodestyle atau flake8ignore atau max-line-length ), pep8speaks akan terlihat dan memprioritaskan konfigurasi dalam urutan berikut:pycodestyle: atau flake8: bagian dari .pep8speaks.yml .scanner.linter .[pycodestyle] atau [flake8] bagian file setup.cfg di root proyek.scanner.linter . Jadi, bagian [flake8] dari setup.cfg juga akan bekerja untuk pycodestyle.| Organisasi | Keterangan | |
|---|---|---|
| Panda | Alat manipulasi data yang kuat untuk python | |
| Adobe | Sumber terbuka dari Adobe | |
| OpenSuse | Distribusi Linux | |
| Petir Pytorch | Pembungkus Pytorch ringan untuk peneliti ML. | |
| Networkx | Perpustakaan Python untuk Teori Grafik dan Jaringan Kompleks | |
| Statsmodels | Pemodelan Statistik dan Ekonometrik di Python | |
| xarray (pydata) | Array dan set data berlabel ND di Python (Python untuk data) | |
 | Sunpy | Python untuk fisika matahari |
| Astropy | Astronomi dalam Python | |
| Scikit belajar contrib | Proyek yang kompatibel dengan scikit-learn | |
| Gambar scikit | Pemrosesan gambar dalam python | |
| IDE Spyder | Lingkungan pengembangan python ilmiah | |
 | Katalisator | Kerangka Pytorch untuk penelitian dan pengembangan pembelajaran mendalam |
Lihat daftar lengkap organisasi dan pengguna.
@pep8speaks suggest diff dalam komentar PR, dan itu akan mengomentari inti dari perbaikan yang disarankan untuk PR. Contoh@pep8speaks pep8ify pada PR dan itu akan membuat permintaan tarik dengan perubahan yang disarankan oleh autopep8 terhadap cabang penulis PR. autopep8 memperbaiki sebagian besar kesalahan yang dilaporkan oleh pycodestyle .[skip pep8] di mana saja dalam pesan komit, judul PR atau deskripsi PR untuk melarang PEP8Speaks dari mengomentari permintaan tarik.Aplikasi ini hanya akan berfungsi untuk repositori yang di -host publik. Jadi, jika Anda ingin menggunakan garpu atau menggunakan aplikasi untuk repositori pribadi , berikut adalah instruksi.
pep8 ). Pembaruan aplikasi diumumkan menggunakan fitur rilis GitHub di sini. Banyak perubahan besar dilakukan saat komunitas tumbuh lebih besar. Klik Watch -> Releases only di atas halaman, untuk mendapatkan pemberitahuan tentang konfigurasi baru atau pembaruan fitur.
Biasanya, cabang master digunakan segera setelah permintaan tarik digabungkan dalam repositori. Namun, pada setiap hari Jumat, saya membuat rilis dan memastikan kode terbaru digunakan. Anda tidak perlu melakukan apa pun untuk menggunakan versi terbaru. Jika Anda menggunakan Fork of Pep 8 berbicara, lihat ruang rilis.
Menjadi sponsor emas dan dapatkan logo dan nama Anda dengan tautan ke situs Anda di ReadMe dan situs web kami.
Pemerintahan Samagra |  Samagrax |
Menjadi sponsor emas dan dapatkan logo dan nama Anda dengan tautan ke situs Anda di ReadMe dan situs web kami.
Python Software Foundation | Berenun |
Menjadi sponsor perak dan dapatkan logo dan nama Anda dengan tautan ke situs Anda di ReadMe dan situs web kami.
CCExtractor | Sudhanshu Mishra |
Anda dapat mendukung proyek dengan berkontribusi pada pengembangannya. Jika Anda memiliki saran untuk fitur atau peningkatan baru, silakan buat masalah. Permintaan tarik sangat disambut! Baca Doc Kontribusi untuk memahami cara kerja proyek dan bagaimana Anda dapat melakukan perubahan.
Proyek perlu di -host di server dan karena itu, ia membutuhkan dukungan keuangan juga.
Harap baca kasus untuk mendanai PEP 8 berbicara.
Jika Anda menggunakan proyek ini dan Anda menyukainya, beri tahu saya. Terima kasih!
❤️
Proyek ini tidak mendukung semua aturan Pep 8 asli dan dengan demikian percaya pada penyesuaian gaya pycodyle.
.
