Black: Murosasiz Python kod formatlovchisi

Dasturiy ta'minotni ishlab chiqish dunyosida izchillik asosiy omildir. Loyiha bo'ylab, ayniqsa, global miqyosda tarqalgan jamoalar bilan ishlashda bir xil kod uslubini saqlash o'qish qulayligini sezilarli darajada yaxshilaydi, xatolarni kamaytiradi va hamkorlikni soddalashtiradi. Python ekotizimida izchil uslubni ta'minlash uchun ajralib turadigan vosita Black hisoblanadi.

Black nima?

Black - bu murosasiz Python kod formatlovchisi. Ko'plab konfiguratsiya imkoniyatlarini taklif qiladigan boshqa formatlovchilardan farqli o'laroq, Black ataylab uslubiy tanlovlarni cheklaydi. Ushbu "murosasiz" yondashuv shuni anglatadiki, Black'ni qabul qilganingizdan so'ng, jamoangizdagi har bir kishi – joylashuvi yoki kodlash tajribasidan qat'i nazar – bir xil, standartlashtirilgan kod uslubida ishlaydi. Bu formatlash afzalliklari bo'yicha cheksiz tortishuvlarni bartaraf etadi va dasturchilarni haqiqiy muammolarni hal qilishga qaratishga imkon beradi.

Black asosan PEP 8 uslubiy qo'llanmasiga rioya qiladi, lekin PEP 8 noaniq bo'lgan joylarda o'zining asosli qarorlarini ham qabul qiladi. Bu umume'tirof etilgan Python eng yaxshi amaliyotlariga mos kelgan holda yuqori darajadagi izchillikni ta'minlaydi.

Nima uchun Black'dan foydalanish kerak? Global afzalliklar

Black'dan foydalanishning afzalliklari shunchaki estetik jozibadan tashqariga chiqadi. Global miqyosda tarqalgan jamoalar uchun Black bir qator muhim afzalliklarni taklif etadi:

• O'qish qulayligi yaxshilanadi: Izchil formatlash kodni kim yozganidan qat'i nazar, o'qish va tushunishni osonlashtiradi. Bu, ayniqsa, turli madaniy va lingvistik kelib chiqishga ega dasturchilar hamkorlik qilganda juda muhimdir. Izchil uslub umumiy til vazifasini o'taydi, noaniqlikni va kognitiv yukni kamaytiradi.
• Kodni ko'rib chiqish vaqti qisqaradi: Kodni avtomatik ravishda standart uslubda formatlash orqali Black kodni ko'rib chiqish jarayonini buzishi mumkin bo'lgan ko'plab mayda-chuydalar haqidagi izohlarni yo'q qiladi. Ko'rib chiquvchilar kodning formatlashiga emas, balki mantiq va funksionalligiga e'tibor qaratishlari mumkin. Bu tezroq va samaraliroq kodni ko'rib chiqish jarayoniga olib keladi.
• Hamkorlik soddalashadi: Hamma bir xil formatlovchidan foydalanganda, uslubiy farqlar tufayli kelib chiqadigan birlashish konfliktlari kamayadi. Bu, ayniqsa, katta, geografik jihatdan tarqoq jamoalarda hamkorlikni yanada silliq va samaraliroq qiladi. Misol uchun, Hindistondagi dasturchi Germaniyadagi dasturchi tomonidan boshlangan loyihaga formatlash nomuvofiqliklarini kiritmasdan bemalol hissa qo'shishi mumkin.
• Yangi jamoa a'zolarini o'qitish: Black yangi dasturchilarning loyihaga qo'shilishini osonlashtiradi. Ular loyihaning o'ziga xos uslubiy qo'llanmasini o'rganishga vaqt sarflashlari shart emas; ular shunchaki Black'ni ishga tushirishlari va o'z kodlari loyiha standartlariga mos kelishiga ishonch hosil qilishlari mumkin. Bu o'qitish jarayonini tezlashtiradi va yangi jamoa a'zolariga tezroq samarali bo'lish imkonini beradi. Braziliyadagi yosh dasturchining AQSh va Yaponiyadagi katta dasturchilar bilan jamoaga qo'shilish stsenariysini ko'rib chiqing. Black har bir kishi bir xil uslubiy sahifada bo'lishini ta'minlaydi.
• Kognitiv yukning kamayishi: Dasturchilar endi kodlarini qo'lda formatlash haqida tashvishlanishlari shart emas. Black buni avtomatik ravishda hal qiladi, ularning aqliy energiyasini muhimroq vazifalarga qaratishga imkon beradi. Bu, ayniqsa, murakkab loyihalar ustida yoki qisqa muddatlarda ishlashda qimmatlidir.
• Eng yaxshi amaliyotlarni qo'llash: "Murosasiz" bo'lsa-da, Black PEP 8 ko'rsatmalarini qo'llash va PEP 8 noaniq bo'lgan joylarda formatlash bo'yicha oqilona qarorlar qabul qilish orqali yaxshi kodlash amaliyotlarini targ'ib qiladi. Bu dasturchilarni toza, osonroq saqlanadigan kod yozishga undaydi.

Black bilan ishlashni boshlash

Black'ni pip yordamida o'rnatish oddiy:

            pip install black
            

              
                Copy
              
            
          

O'rnatilgandan so'ng, bitta faylni quyidagicha formatlashingiz mumkin:

            black my_file.py
            

              
                Copy
              
            
          

Butun katalog bo'ylab rekursiv formatlash uchun:

            black my_directory
            

              
                Copy
              
            
          

Black kodni avtomatik ravishda joyida qayta formatlaydi. Agar siz Black qiladigan o'zgarishlarni fayllarni haqiqatda o'zgartirmasdan ko'rmoqchi bo'lsangiz, --diff bayrog'idan foydalanishingiz mumkin:

            black --diff my_file.py
            

              
                Copy
              
            
          

Agar fayl Black uslubiga ko'ra allaqachon formatlanganligini tekshirish uchun --check bayrog'idan foydalanishingiz mumkin:

            black --check my_file.py
            

              
                Copy
              
            
          

Bu Black'ni CI/CD quvur liniyangizga integratsiya qilish uchun foydalidir (bu haqda keyinroq).

Black'ni ish oqimingizga integratsiya qilish

Black bir necha yo'l bilan ish oqimingizga muammosiz integratsiya qilinishi mumkin:

1. IDE integratsiyasi

Ko'plab mashhur IDE'lar va kod muharrirlari Black uchun plaginlar yoki kengaytmalar taklif qiladi. Ushbu integratsiyalar har safar faylni saqlaganingizda kodingizni avtomatik ravishda formatlashga imkon beradi. Bu Black'dan foydalanishning eng qulay usuli bo'lib, kodingiz har doim to'g'ri formatlanganligini ta'minlaydi.

Mana ba'zi misollar:

• VS Code: Microsoft tomonidan "Python" kengaytmasini o'rnating va uni Black'ni formatlovchi sifatida ishlatish uchun sozlang. Quyidagilarni settings.json faylingizga qo'shing:

              
   {
   "python.formatting.provider": "black",
   "editor.formatOnSave": true
   }
   
              
  
                
                  Copy
                
              
            

• PyCharm: Sozlamalar > Muharrir > Kod uslubi > Python ga o'ting va sxemani "Black" ga o'rnating. Shuningdek, Sozlamalar > Versiya nazorati > Kommit da "Kommittan keyin kodni qayta formatlash"ni yoqishingiz mumkin.
• Sublime Text: Package Control orqali "Black" paketini o'rnating. Black ijro etuvchi faylining yo'lini sozlash talab qilinishi mumkin.

2. Pre-commit kancasi

Pre-commit kancalari – bu kodni versiya nazorati tizimiga kommit qilishdan oldin avtomatik ravishda ishga tushadigan skriptlar. Siz har bir kommittan oldin Black'ni ishga tushirish va kodni avtomatik ravishda formatlash uchun pre-commit kancasidan foydalanishingiz mumkin. Bu faqat to'g'ri formatlangan kodning omborga kommit qilinishini ta'minlaydi.

Black uchun pre-commit kancasini o'rnatish uchun pre-commit freymvorkidan foydalanishingiz mumkin. Avval uni o'rnating:

            pip install pre-commit
            

              
                Copy
              
            
          

Keyin, omboringizning ildiz katalogida quyidagi tarkibga ega .pre-commit-config.yaml faylini yarating:

            
 repos:
 - repo: https://github.com/psf/black
 rev: 24.3.0  # Black'ning so'nggi versiyasi bilan almashtiring
 hooks:
 - id: black
 
            

              
                Copy
              
            
          

Pre-commit kancalarini o'rnatish uchun pre-commit install buyrug'ini ishga tushiring. Endi har safar kodni kommit qilganingizda, Black avtomatik ravishda ishga tushadi. Agar Black biron bir faylni o'zgartirsa, kommit bekor qilinadi va siz o'zgarishlarni sahnaga chiqarishingiz va qayta kommit qilishingiz kerak bo'ladi.

3. Uzluksiz integratsiya (CI/CD)

Black'ni CI/CD quvur liniyangizga integratsiya qilish asosiy tarmoqqa birlashtirilgan barcha kodning to'g'ri formatlanganligini ta'minlaydi. Buni CI/CD quvur liniyangizga Black'ni tekshirish rejimida ishga tushiradigan qadamni qo'shish orqali amalga oshirish mumkin. Agar Black biron bir formatlash muammosini aniqlasa, quvur liniyasi ishlamay qoladi va kodning birlashtirilishiga to'sqinlik qiladi.

Misol uchun, GitHub Actions'da ish oqimi faylingizga quyidagi qadamni qo'shishingiz mumkin:

            
 - name: Run Black
 uses: psf/black@v1
 with:
 options: "--check --verbose"
 src: "."
 
            

              
                Copy
              
            
          

Bu ombordagi barcha fayllarda Black'ni tekshirish rejimida ishga tushiradi. Agar biron bir fayl to'g'ri formatlanmagan bo'lsa, harakat ishlamay qoladi.

Konfiguratsiya imkoniyatlari (cheklangan)

Yuqorida aytib o'tilganidek, Black ataylab konfiguratsiya imkoniyatlarini cheklaydi. Biroq, bir nechta imkoniyatlar mavjud:

• --line-length: Maksimal qator uzunligini belgilaydi. Standart qiymat 88 belgidir. Umuman tavsiya etilmasa-da, bu qiymatni oshirish ba'zi loyihalar yoki uzoq qatorlardan keng foydalanadigan eski kod bazalari uchun zarur bo'lishi mumkin. Standartdan chetga chiqishdan oldin "foyda-xarajat" nisbatini diqqat bilan ko'rib chiqing.
• --target-version: Qaysi Python versiyasini nishonga olishni belgilaydi. Bu bir nechta Python versiyalarini qo'llab-quvvatlaydigan loyiha ustida ishlayotgan bo'lsangiz foydalidir. Black o'z formatlashini belgilangan versiya bilan mos bo'lishi uchun sozlaydi.
• --include va --exclude: Fayllar va kataloglarni formatlashdan kiritish yoki chiqarish uchun muntazam ifodalarni belgilaydi. Bu yaratilgan kodni yoki formatlashni xohlamaydigan uchinchi tomon kutubxonalarini chiqarib tashlash uchun foydali bo'lishi mumkin. Misol uchun, Django loyihasida migrations katalogini chiqarib tashlashingiz mumkin.

Ushbu imkoniyatlar buyruq satrida yoki omboringizning ildiz katalogidagi pyproject.toml faylida ko'rsatilishi mumkin. Misol uchun:

            
 [tool.black]
 line-length = 120
 target-version = ['py37', 'py38', 'py39']
 exclude = 'migrations'
 
            

              
                Copy
              
            
          

Umumiy tashvishlar va e'tirozlarni hal qilish

Black keng e'tirof etilsa-da, ba'zi dasturchilar dastlab uni qabul qilishga qarshilik ko'rsatadilar. Mana ba'zi umumiy tashvishlar va ularni qanday hal qilish kerak:

• "Black kodimni formatlash uslubi yoqmaydi." Black samaradorligining kaliti uning murosasiz tabiatidadir. Uni shaxsiy afzalliklaringizga moslashtirish istagiga qarshi turing. Standartlashtirilgan uslubni qabul qiling va siz izchillikning afzalliklari har qanday individual estetik afzalliklardan ustun ekanligini tezda tushunasiz. Maqsad shaxsiy mukammallik emas, balki jamoa bo'ylab izchil kod ekanligini unutmang.
• "Black kodimni buzadi." Black xavfsiz va ishonchli bo'lish uchun mo'ljallangan. Biroq, Black bilan kodni formatlaganingizdan so'ng, hamma narsa kutilganidek ishlashini ta'minlash uchun sinovlaringizni o'tkazish har doim yaxshi fikrdir. Agar Black'da haqiqiy xatoga duch kelsangiz, uni ishlab chiquvchilarga xabar bering.
• "Black juda o'z fikriga qat'iy." Gap shunda! Black'ning o'z fikriga qat'iy tabiati uni izchil uslubni ta'minlashda shu qadar samarali qiladi. U formatlash bo'yicha cheksiz tortishuvlarni bartaraf etadi va dasturchilarga muhimroq vazifalarga e'tibor qaratishga imkon beradi.
• "Black mening diff'larimni o'qishni qiyinlashtiradi." Dastlab, keng miqyosli Black'ni qabul qilish katta diff'larni keltirib chiqarishi mumkin. Dasturchilarni buzilishni minimallashtirish va keyingi kommitlarda mantiqiy o'zgarishlarga e'tibor qaratish uchun butun fayllar yoki modullarni bir vaqtning o'zida formatlashga undash kerak. Izchil formatlashning uzoq muddatli afzalliklari dastlabki formatlash o'tkazmasining qisqa muddatli noqulayliklaridan ustun turadi.

Kengaytirilgan foydalanish va maslahatlar

• Asta-sekin qabul qilish: Agar sizda katta, mavjud kod bazasi bo'lsa, butun kod bazasini bir vaqtning o'zida formatlash amaliy bo'lmasligi mumkin. Black'ni asta-sekin, yangi kod yoki o'ziga xos modullardan boshlab qabul qilishni ko'rib chiqing. Formatlanishi kerak bo'lgan fayllarni aniqlash uchun --diff va --check bayroqlaridan foydalanishingiz mumkin.
• Boshqa linterlar bilan birlashtirish: Black faqat kodni formatlashga e'tibor qaratadi. U hech qanday statik tahlil yoki kod lintingni bajarmaydi. Boshqa kodlash standartlari va eng yaxshi amaliyotlarni ta'minlash uchun Black'ni Flake8 yoki Pylint kabi boshqa linterlar bilan birlashtirishni ko'rib chiqing. Misol uchun, kod murakkabligini tekshirish uchun Flake8 va formatlash uchun Black'dan foydalaning.
• # fmt: off va # fmt: on dan foydalanish: Kamdan-kam hollarda, kodning ma'lum qismlari uchun Black'ni o'chirib qo'yishingiz kerak bo'lishi mumkin. Buni # fmt: off va # fmt: on izohlari yordamida amalga oshirishingiz mumkin. Biroq, buni kamdan-kam ishlating, chunki u Black'dan foydalanish maqsadini yo'qqa chiqaradi. Buni faqat Black o'qish qulayligiga yoki saqlanuvchanlikka faol to'sqinlik qiladigan juda o'ziga xos holatlar uchun ishlating.
• Maxsus Black plaginini ko'rib chiqing (kengaytirilgan): Black kengaytirilgan sozlashni rag'batlantirmasa-da, plaginlarni yaratishga imkon beradi. Ushbu plaginlar kamdan-kam uchraydi va odatda juda o'ziga xos ehtiyojlarni qondiradi. Buni faqat juda murakkab stsenariylar uchun ko'rib chiqing.

Haqiqiy misollar va keys-tadqiqotlar

Dunyo bo'ylab ko'plab tashkilotlar Black'ni muvaffaqiyatli qabul qilishgan, jumladan:

• Instagram: Katta Python kod bazasida izchil kod uslubini saqlash uchun Black'dan foydalanadi.
• Dropbox: Black'ni o'zining rivojlanish ish oqimining bir qismi sifatida qo'llaydi, kod sifatini va hamkorlikni oshiradi.
• Mozilla: Black'ni o'zining CI/CD quvur liniyasiga integratsiya qiladi, barcha kod hissalari izchil uslubga rioya qilishini ta'minlaydi.

Turli geografik joylashuvlar va tashkiliy tuzilmalarni ifodalovchi ushbu tashkilotlar kod sifatini yaxshilash, xatolarni kamaytirish va hamkorlikni soddalashtirishda Black'ning qadrini tan olishgan.

Xulosa: Izchillikni qabul qiling, Black'ni qabul qiling

Black Python loyihalarida izchil kod uslubini ta'minlash uchun kuchli vositadir. Uning murosasiz yondashuvi uslubiy bahslarni bartaraf etadi, o'qish qulayligini oshiradi va, ayniqsa, global miqyosda tarqalgan jamoalar ichida hamkorlikni soddalashtiradi. Black'ni ish oqimingizga integratsiya qilish orqali siz formatlash haqida qayg'urmasdan, ajoyib kod yozishga e'tibor qaratishingiz mumkin. Izchillikni qabul qiling, Black'ni qabul qiling va Python dasturchi jamoangizning to'liq salohiyatini oching, ular dunyoning qayerida bo'lmasin.

Bugunoq Black'dan foydalanishni boshlang va standartlashtirilgan kod uslubining afzalliklarini his qiling!