Apa itu Black

Black adalah penata kode yang memiliki pendapat sendiri untuk Python. Ia secara otomatis memformat ulang kode Anda agar konsisten dan mudah dibaca, sesuai dengan panduan gaya PEP 8 dengan beberapa pengecualian.

Sebagai contoh, misalkan Anda memiliki kode berikut:

#comment
'''
hello world
'''

a = [1, 2, 3,      4,
5]
print(a)

Setelah menerapkan Black, kode akan diformat sebagai berikut:

# comment
"""
hello world
"""

a = [1, 2, 3, 4, 5]
print(a)

Black disebut sebagai "Penata Kode Tanpa Kompromi (The Uncompromising Code Formatter)" karena tidak memberikan banyak konfigurasi terkait aturan pemformatan; ia memiliki gaya tertentu dan tetap pada gaya tersebut. Namun, keuntungannya adalah ketika Anda menggunakan Black, Anda tidak perlu menghabiskan waktu untuk menyesuaikan gaya pemformatan.

Instalasi

Menginstal Black adalah proses yang sederhana dan dapat dilakukan melalui pip, yaitu pengelola paket Python. Jika Anda memiliki Python 3.6 atau versi lebih baru, instalasi dapat dilakukan dengan menjalankan perintah berikut:

$ pip install black

Menggunakan Black untuk Pemformatan Kode

Saya akan menjelaskan bagaimana menggunakan Black untuk memformat kode Python. Saya akan mencakup bagaimana memformat satu file, seluruh proyek, dan bagaimana membuat pengecualian untuk file atau direktori tertentu.

Memformat Satu File Python

Memformat satu file Python dengan Black sangat mudah. Setelah Anda menginstal Black, navigasikan ke direktori di mana file Python Anda berada, dan jalankan perintah berikut:

$ black myfile.py

Gantilah myfile.py dengan nama file Python Anda. Black akan secara otomatis memformat ulang file Anda sesuai dengan aturan gayanya.

reformatted myfile.py
All done! ✨ 🍰 ✨

Memformat Sebuah Proyek

Jika Anda sedang bekerja pada proyek yang lebih besar dengan beberapa file Python, Anda mungkin ingin memformat semuanya sekaligus. Untuk melakukannya, navigasikan ke direktori utama proyek Anda dan jalankan perintah Black diikuti oleh tanda titik:

$ black .

Ini akan memberitahu Black untuk memformat ulang semua file Python di direktori saat ini dan subdirektorinya.

Menyesuaikan Panjang Baris

Secara default, Black memformat kode dengan panjang baris maksimum 88 karakter. Namun, Anda mungkin memiliki preferensi atau persyaratan proyek yang berbeda. Black memungkinkan Anda untuk mengatur panjang baris kustom menggunakan opsi --line-length.

Misalnya, jika Anda ingin mengatur panjang baris maksimum menjadi 100 karakter, gunakan perintah berikut:

$ black --line-length 100 myfile.py

Demikian pula, Anda dapat menerapkan opsi ini saat memformat seluruh proyek:

$ black --line-length 100 .

Mengabaikan File atau Direktori Tertentu

Dalam beberapa kasus, Anda mungkin tidak ingin Black memformat beberapa file atau direktori tertentu. Anda dapat menggunakan opsi --exclude saat menjalankan Black untuk mengabaikan file atau direktori yang sesuai dengan pola ekspresi reguler yang diberikan. Sebagai contoh:

$ black . --exclude '/migrations/'

Ini akan memformat semua file Python di direktori saat ini dan subdirektorinya, kecuali yang berada dalam direktori migrations.

Referensi

https://pypi.org/project/black/