Tutorial tox alat automasi tugas Python

• Frontend CI dipacu baris perintah dan alat automasi tugas pembangunan
  
• Frontend CI dipacu baris perintah dan alat automasi tugas pembangunan
  

Alamat projek tox ialah: https://github.com/tox-dev/tox

Fungsi terasnya ialah untuk menyokong penciptaan persekitaran Python terpencil, dalam yang ia boleh dipasang Versi berbeza jurubahasa Python dan pelbagai perpustakaan bergantung memudahkan pembangun melakukan ujian automatik, pembungkusan, penyepaduan berterusan, dsb.

Ringkasnya, tox ialah alat baris arahan untuk mengurus persekitaran maya ujian. Ia telah wujud selama bertahun-tahun dan digunakan secara meluas oleh pembangun Contohnya, platform pengkomputeran awan yang terkenal OpenStack juga menggunakannya sebagai salah satu alat ujian yang paling asas.

1.

Kegunaan yang dipecah bahagi termasuk:

• Mencipta persekitaran pembangunan
• Menjalankan analisis kod statik dan alat ujian
  
• Pembinaan pakej automatik
  
• Jalankan ujian terhadap pakej binaan toksik
  
• Semak sama ada pakej itu boleh berjaya dipasang dalam versi/jurubahasa Python yang berbeza
  
• Menyatukan integrasi berterusan (CI) dan ujian berasaskan baris arahan
  
• Cipta dan gunakan dokumentasi projek
  
• Terbitkan pakej ke PyPI atau mana-mana platform lain
  

dokumentasi rasmi tox menyenaraikan lebih daripada 40 contoh senario penggunaan Senarai terperinci boleh dilihat di: https://tox.readthedocs.io/en/latest/examples >

Bagaimana untuk mengkonfigurasi tox?

Mengenai penggunaannya: Gunakan pip install tox untuk memasang, gunakan tox untuk menjalankan semua persekitaran ujian dan tox -e envname untuk menjalankan persekitaran yang ditentukan. Terdapat juga banyak parameter baris arahan, yang boleh dilihat melalui tox -h.

Kelakuan tox dikawal oleh fail konfigurasinya pada masa ini ia menyokong 3 fail konfigurasi:

pyproject.toml

1. tox. ini
2. 
   setup.cfg
3. 
   
Mengambil kandungan konfigurasi tox.ini projek tox sendiri sebagai contoh, anda boleh melihat bahawa ia dikonfigurasikan seperti ini (https :// github.com/tox-dev/tox/blob/master/tox.ini):

setiap [xxx ] dan kandungan di bawahnya membentuk bahagian, dengan garisan kosong antara setiap bahagian.

[tox] Berikut ialah item konfigurasi global Medan envlist mentakrifkan persekitaran di mana tox beroperasi. [xxx] Berikut ialah item konfigurasi persekitaran maya xxx [xxx:yyy] mewarisi konfigurasi xxx, dan item konfigurasinya sendiri mempunyai keutamaan yang lebih tinggi.

Untuk setiap persekitaran maya, terdapat banyak item konfigurasi yang tersedia Contohnya, yang biasa digunakan ialah: penerangan (maklumat penerangan), basepython (versi penterjemah Python), deps (pergantungan persekitaran), arahan (. perintah) pernyataan) dan sebagainya.

tox juga menyokong penggantian pembolehubah, yang menyediakan beberapa pembolehubah asas terbina dalam (global atau untuk persekitaran maya): {toxinidir}, {homedir}, {envname}, {envdir}, dsb. tunggu .

Selain penggantian pembolehubah asas, ia juga menyokong penggunaan lanjutan ini:

Dapatkan pembolehubah persekitaran sistem pengendalian: {env:KEY}, kesannya adalah sama dalam os.environ['KEY']. Boleh ditukar kepada: {env:KEY:DEFAULTVALUE}, nilai lalai digunakan apabila pembolehubah persekitaran tidak boleh diperolehi; {env:KEY:{env:DEFAULT_OF_KEY}}, untuk mencapai kesan nilai if-else

• 
  
Lulus parameter baris arahan: {posargs:DEFAULTS}. Apabila tiada parameter baris arahan, nilai DEFAULTS digunakan. Penggunaan: tox arg1 arg2 untuk lulus dua parameter, atau tox -- --opt1 arg1 untuk lulus "--opt1 arg1" secara keseluruhan.

Pemindahan nilai antara bab: {[sectionname]valuename}, kandungan bab yang berbeza boleh diluluskan dan digunakan.

• 
  Suntikan konsol interaktif: {tty:ON_VALUE:OFF_VALUE}, apabila konsol shell interaktif dibuka, nilai pertama digunakan, jika tidak, nilai kedua digunakan. Ini adalah contoh apabila pytest menggunakan "--pdb".
• 
  
Selain digunakan untuk penggantian berubah, kurungan kerinting "{}" juga boleh digunakan sebagai nilai penghakiman "OR hubungan". Lihat terus pada contoh berikut:

{py27,py36}-django{15,16} mempunyai 2 nilai dalam setiap 2 set kurungan kerinting mereka sebenarnya boleh digabungkan menjadi 4 persekitaran: py27- django15, py27-django16, py36-django15, py36-django16.

[tox]
envlist = {py27,py36}-django{15,16}

Mengenai item konfigurasi tox, syarat penggunaan, maksud, penggunaan lanjutan, dsb., anda boleh melihatnya dalam dokumentasi rasmi: https://tox.readthedocs.io/en/latest/config . html

3. Pemalam tox

Selain kebolehkonfigurasiannya yang kuat, tox juga mempunyai kebolehskalaan yang kuat dan boleh dipalamkan (pluggable), di sekelilingnya yang sangat kaya ekosistem plug-in telah muncul.

Menggunakan tox carian pip, anda boleh melihat sejumlah besar perpustakaan bermula dengan "tox-", yang kesemuanya merupakan pakej pemalam tox. Antaranya ialah nama yang terkenal seperti setuptools, pipenv, conda, travis, pytest, dan docker.

toks telah membuka banyak antara muka API untuk memudahkan orang lain menyesuaikan dan membangunkan pemalam.

4. Aliran kerja tox

Mari kita lihat cara tox berfungsi:

Pautan utama dalam aliran kerjanya ialah:

• Konfigurasi (dari konfigurasi): muatkan fail konfigurasi (seperti tox.ini), huraikan baris arahan parameter, baca pembolehubah persekitaran sistem, dsb.
• Pembungkusan: Pilihan, untuk projek dengan fail setup.py, anda boleh menjana versi pengedaran sumbernya dalam langkah ini
  
• Cipta persekitaran maya : Gunakan virtualenv secara lalai untuk mencipta persekitaran maya, pasang kebergantungan yang diperlukan mengikut "deps" dalam item konfigurasi, dan kemudian laksanakan arahan yang dikonfigurasikan (arahan)
  
• Laporan: Ringkaskan hasil yang dijalankan bagi semua persekitaran maya dan senaraikannya
  

5 Ringkasan

toks itu sendiri diletakkan sebagai alat ujian, yang cuba menjadikan ujian Python menjadi automatik, piawai dan. diperkemas. Tetapi tidak seperti rangka kerja ujian seperti unittest dan pytest, ia berfungsi melebihi tahap kod dan merupakan alat peringkat projek. Oleh itu, ia perlu digabungkan dengan rangka kerja ujian ini, atau mengendalikan berbilang tugasan automatik pada masa yang sama (seperti menjalankan pep8, menguji liputan kod, menjana dokumentasi, dll.), supaya ia dapat menggunakan nilainya dengan lebih baik.

Salah satu cirinya ialah penciptaan/pengurusan persekitaran maya, tetapi ini hanya digunakan untuk memudahkan ujian, jadi berbanding dengan alatan lain yang boleh menguruskan persekitaran maya, seperti Virtualenvwrapper, conda, pipenv, puisi, ia mempunyai kekurangan dalam beberapa aspek.

tox juga mempunyai kebolehkonfigurasian yang kuat dan sokongan pemalam yang kaya, yang memberikan kemungkinan besar dan kebebasan dalam aplikasi. Oleh itu, ramai pembangun setia masih menggunakannya Contohnya, penulis siri artikel yang baru saya terjemah adalah salah seorang penyelenggaranya.

Akhir sekali, saya perlu menambah bahawa tox menggunakan fail konfigurasi sebagai pemacu, tetapi fail konfigurasi masih agak rumit, jadi seseorang membangunkan nox yang serupa dengan tox. Gunakan fail Python untuk konfigurasi. Projek ini juga sangat popular, menarik banyak projek untuk melabur di bawah payungnya, seperti pipx, urllib3, Salt, dll. Jika anda berminat dengan projek ini, sila lihat: https://nox.thea.codes/en/stable.

Atas ialah kandungan terperinci Tutorial tox alat automasi tugas Python. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!