2012-01-27 20 views
15

के लिए एक सहायता लिखना मैं अपनी पायथन लिपि को बहुत उपयोगकर्ता के अनुकूल बनाने की कोशिश कर रहा हूं, इसलिए मैं इसके लिए कुछ प्रकार की मदद लिखना चाहता हूं। इसके लिए आपकी क्या सलाह है? मैं बस कुछ तर्क में डाल सकता हूं कि यदि उपयोगकर्ता स्क्रिप्ट के लिए एक पैरामीटर के रूप में मदद पास करता है, तो उन्हें सहायता मिलती है। क्या इसके लिए कोई अच्छा अभ्यास या सम्मेलन है?पायथन लिपि

उत्तर

26

argparse का उपयोग करें।

उदाहरण के लिए, साथ test.py:

import argparse 

parser=argparse.ArgumentParser(
    description='''My Description. And what a lovely description it is. ''', 
    epilog="""All's well that ends well.""") 
parser.add_argument('--foo', type=int, default=42, help='FOO!') 
parser.add_argument('bar', nargs='*', default=[1, 2, 3], help='BAR!') 
args=parser.parse_args() 

% test.py -h 

रनिंग पैदावार

usage: test.py [-h] [--foo FOO] [bar [bar ...]] 

My Description. And what a lovely description it is. 

positional arguments: 
    bar   BAR! 

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

All's well that ends well. 
6

सर्वश्रेष्ठ अभ्यास अपने सभी कमांडलाइन तर्क को संभालने के लिए argparse उपयोग करने के लिए है। इसमें एक डिफ़ॉल्ट --help शामिल है जिसे आप अपनी पसंद के अनुसार अनुकूलित कर सकते हैं।

import argparse 

parser = argparse.ArgumentParser(description='This is my help') 

args = parser.parse_args() 

परिणाम जो में:

% python argparse_test.py -h 
usage: argparse_test.py [-h] 

This is my help 

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

आप argparse के साथ अपने सभी तर्कों को परिभाषित करने और उनमें से हर एक के लिए एक सहायता संदेश सेट कर सकते हैं

यहाँ सबसे सरल उदाहरण है। परिणामस्वरूप फ़िल्टर किए गए/मान्य तर्क parser.parse_args() द्वारा लौटाए जाते हैं।

संबंधित मुद्दे