Modul Docopt dalam Python

Dalam Python, modul Docopt digunakan untuk mencipta antara muka baris arahan. Sama seperti parameter dan pilihan baris perintah yang lain, docopt membolehkan kami mentakrifkan parameter dan pilihan baris arahan serta menjana mesej bantuan dan rentetan penggunaan untuk program. Dalam artikel ini, kita akan belajar cara mentakrifkan modul Docopt dan cara menggunakannya untuk mencipta antara muka baris arahan.

Pemasangan

Sebelum menggunakannya, anda boleh memasang modul Docopt menggunakan arahan pip dalam Python. Untuk memasang modul Docopt, masukkan arahan berikut pada terminal atau command prompt.

pip install docopt

Program menggunakan modul Docopt

Selepas memasang modul Docopt, mari lihat beberapa contoh untuk memahami cara menggunakan modul Docopt dalam Python.

Contoh 1: Program ringkas

Dalam kod di bawah, kami akan memberikan parameter nama fail semasa menjalankan program. Contohnya, jika fail program ialah simple_program.py dan kami mempunyai fail test.txt dalam direktori yang sama, maka parameternya hendaklah python simple_program.py test.txt.

""" Usage: simple_program.py <filename>

Print the contents of the file to the console.
"""

from docopt import docopt

def main():
   args = docopt(__doc__)
   filename = args['<filename>']
   with open(filename, 'r') as f:
      print(f.read())

if __name__ == '__main__':
   main()

Output

This is testing the docopt module.

Contoh 2: Program dengan pilihan

Dalam contoh ini, kami akan mencipta program yang menerima nama fail sebagai hujah dan bendera pilihan untuk menentukan sama ada untuk memaparkan nombor baris. Kami akan menggunakan Docopt untuk menentukan antara muka baris arahan. Dalam contoh di bawah, kami akan menyediakan hujah nama fail dan bendera –nombor baris semasa menjalankan program. Contohnya, jika fail program ialah simple_program.py dan kami mempunyai fail test.txt dalam direktori yang sama, maka parameternya hendaklah python simple_program.py test.txt –line-numbers.

"""Usage: program_with_options.py [--line-numbers] <filename>

Print the contents of the file to the console, with line numbers if specified.

Options:
  --line-numbers  Display line numbers.
"""

from docopt import docopt

def main():
   args = docopt(__doc__)
   filename = args['<filename>']
   with open(filename, 'r') as f:
      if args['--line-numbers']:
         for i, line in enumerate(f):
            print(f"{i+1}: {line}", end="")
      else:
         print(f.read())

if __name__ == '__main__':
    main()

Output

1: This is testing the docopt module.
2: This is line 2
3: This is line 3
4: This is line 4

Kesimpulan

Dalam artikel ini, kami membincangkan cara mencipta antara muka baris arahan menggunakan modul docopt dan cara menggunakannya untuk mencipta parameter dan pilihan baris arahan. Pendekatan deklaratifnya memudahkan untuk menentukan parameter dan pilihan baris arahan, menjadikannya mudah untuk digunakan dan difahami. Menggunakan Docopt, anda boleh membuat antara muka baris arahan dengan cepat untuk program Python anda tanpa perlu risau tentang butiran penghuraian hujah dan penjanaan mesej bantuan.

Atas ialah kandungan terperinci Modul Docopt dalam Python. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!