pydoc'ın açıklaması argparse '--help' bölümünün bir parçası olarak gösteriliyor

Question

Komut dizimde argparse.ArgumentParser() kullanıyorum. '--help' seçeneğinin bir parçası olarak betiğimin pydoc açıklamasını görüntülemek istiyorum Argparse'nin

biri muhtemelen çözüm yardım görüntülendiği yapılandırmak için formatter_class veya ArgumentParser ait description özellik kullanmak olabilir. Ancak bu durumda, açıklamayı almak için 'pydoc' komutunu dahili olarak kullanmamız gerekiyor.

Bunu yapmak için başka yöntemlerimiz (muhtemelen zarif) var mı?

Answer 1

Komut dosyanızın belgelerini global olarak __doc__'dan alabilirsiniz. Komut dosyasının yardımına eklemek için, ayrıştırıcının description bağımsız değişkenini ayarlayabilirsiniz. Yardım etmeleri sonuna docstring'ini taşımak için description yerine epilog kelime argüman kullanabilirsiniz

$ python tmp.py --help 
usage: tmp.py [-h] foo 

My python script 

Script to process a file 

positional arguments: 
    foo   Name of file to process 

optional arguments: 
    -h, --help show this help message and exit 

hemen kullanım dizesini uygulamak yerine,: gibi

"""My python script 

Script to process a file 
""" 

p = argparse.ArgumentParser(description=__doc__, 
          formatter_class=argparse.RawDescriptionHelpFormatter) 
p.add_argument('foo', help="Name of file to process") 
p.parse_args() 

Sonra yardım bakacağız.