Django में प्रबंधन आदेश बनाना

प्रबंधन कमांड - कमांड लाइन से मैनेज कमांड से स्क्रिप्ट को निष्पादित किया जाता है।

आवेदन के सबसे आम क्षेत्र एक बार या समय-समय पर किए जाने वाले कार्य हैं, लेकिन जिसके लिए अनुसूचक के माध्यम से लॉन्च करना किसी कारण से अनुपलब्ध है। उदाहरण के लिए, उपयोगकर्ताओं को एक-बार संदेश भेजना, डेटाबेस से डेटा प्राप्त करना, अपडेट करने से पहले आवश्यक फ़ाइलों और फ़ोल्डरों की उपस्थिति की जांच करना, विकास के दौरान मॉडल ऑब्जेक्ट जल्दी से बनाना आदि।

मूल बातें

एप्लिकेशन / प्रबंधन / कमांड उपनिर्देशिका में एप्लिकेशन निर्देशिकाओं में एप्लिकेशन बनाए जाते हैं (एप्लिकेशन INSTALED_APPS में जोड़े जाने चाहिए)। प्रत्येक कमांड के लिए एक अलग फाइल बनाई जाती है। फाइलें कमांड लाइन से उपलब्ध होंगी, सिवाय उनके जो अंडरस्कोर से शुरू होती हैं।

app/ __init__.py management/ __init__.py commands/ __init__.py _tools.py zen.py 

इस उदाहरण में, ज़ेन कमांड उपलब्ध होगा, लेकिन _tools नहीं होगा।

कमांड django.core.management.base.BaseCommand वर्ग से विरासत में मिली हैं। सरलतम मामले में, हैंडल फ़ंक्शन को फिर से लिखना पर्याप्त है। यह आदेश निष्पादित किया जाएगा, और इसके द्वारा लौटाया गया परिणाम कंसोल में मुद्रित किया जाएगा।

 from django.core.management.base import BaseCommand class Command(BaseCommand): help = 'The Zen of Python' def handle(self, *args, **options): import this 

आइए हमारे आदेश को कॉल करने का प्रयास करें:

 python manage.py zen The Zen of Python, by Tim Peters Beautiful is better than ugly. ... 

हेल्प क्लास की विशेषता एक विवरण है जो तब प्रदर्शित होता है जब --help स्विच वाली कमांड को कॉल किया जाता है या यदि कमांड गलत दर्ज की जाती है।

 $ python manage.py zen --help usage: manage.py zen [-h] [--version] [-v {0,1,2,3}] [--settings SETTINGS] [--pythonpath PYTHONPATH] [--traceback] [--no-color] The Zen of Python optional arguments: -h, --help show this help message and exit --version show program's version number and exit -v {0,1,2,3}, --verbosity {0,1,2,3} Verbosity level; 0=minimal output, 1=normal output, 2=verbose output, 3=very verbose output --settings SETTINGS The Python path to a settings module, eg "myproject.settings.main". If this isn't provided, the DJANGO_SETTINGS_MODULE environment variable will be used. --pythonpath PYTHONPATH A directory to add to the Python path, eg "/home/djangoprojects/myproject". --traceback Raise on CommandError exceptions --no-color Don't colorize the command output. 

पार्सिंग तर्क

जैसा कि हम देख सकते हैं, हमारी टीम पहले से ही 7 तर्क दे रही है।

लेकिन क्या होगा अगर यह हमारे लिए पर्याप्त नहीं है और हम अपने विकल्पों को जोड़ना चाहते हैं? ऐसा करने के लिए, आपको हमारी कक्षा में add_arguments फ़ंक्शन बनाने की आवश्यकता है, जहां उन सभी तर्कों को सूचीबद्ध करना है जिन्हें हम अपनी टीम को पास करना चाहते हैं। प्रत्येक तर्क पैरामीटर की एक श्रृंखला के साथ parser.add_argument फ़ंक्शन को कॉल करके बनाया जाता है।

मान लीजिए कि हम अपने फ़ंक्शन के लंबे आउटपुट के साथ सहज नहीं हैं, और हम चाहते हैं कि हैलो दुनिया सिर्फ -s और - orortort कुंजियों के साथ मुद्रित हो:

 from django.core.management.base import BaseCommand class Command(BaseCommand): help = 'The Zen of Python' def handle(self, *args, **options): if options['short']: import __hello__ else: import this def add_arguments(self, parser): parser.add_argument( '-s', '--short', action='store_true', default=False, help='  ' ) 

-S स्विच के साथ कॉल करने पर यह फ़ाइल हैलो वर्ल्ड को प्रिंट करेगी।

 $ python manage.py zen -s Hello world... (coolwriter)$ python manage.py zen The Zen of Python, by Tim Peters Beautiful is better than ugly. Explicit is better than implicit. ... 

आइए हम अधिक विस्तार से जांच करें कि तर्कों की पार्सिंग कैसे निर्दिष्ट की जाती है।

पार्सर को argparse.ArgumentParser से विरासत में मिला है, और आप अजगर दस्तावेज़ में argparse लाइब्रेरी के लिए प्रलेखन में add_argument फ़ंक्शन द्वारा लिए गए तर्कों के बारे में पढ़ सकते हैं। सबसे महत्वपूर्ण हैं:

नाम या झंडे - नाम या लेबल की सूची या नाम। हमारे पास यह 'छोटा', ​​'-s' और '--शॉर्ट' है।
कार्रवाई - तर्क के मूल्य के साथ क्या करना है। सबसे दिलचस्प (लेकिन सभी नहीं) विकल्प निम्नानुसार हैं:

स्टोर - हमारे विकल्प के मूल्य के रूप में सहेजें। यदि कई कुंजी-मूल्य जोड़े प्रेषित होते हैं, तो अंतिम का मूल्य
store_const - नाम कुंजी में निरंतर मान को सहेजें। स्थिरांक को समान add_argument फ़ंक्शन के लिए कॉन्स्ट तर्क के रूप में पास किया जाता है।

उदाहरण के लिए:

 parser.add_argument('my_option', action='store_const', const=1234) 

विकल्पों में हैंडल फ़ंक्शन 'my_option': 1234 पारित किया जाएगा

store_true, store_false - पिछले विकल्प के विशेष मामले। सही या गलत संग्रहीत
append - मूल्य सूची के अंत में संलग्न होगा
append_const पिछले एक के समान है, लेकिन कॉन्स्टैंट तर्क के लिए दिया गया मान (जो किसी भी वस्तु का हो सकता है)

नर्ग तर्कों की संख्या है। संभावित मान: पूर्णांक, '?' - डिफ़ॉल्ट तर्क से एक या डिफ़ॉल्ट मान, '*' - जितने भी हैं, और एक सूची में एकत्र किए जाते हैं, '+' - कम से कम एक, और यदि कई - एक सूची में एकत्र किए जाते हैं, तो argparse.REMAINDER - कमांड लाइन से सभी शेष तर्क एकत्र किए जाते हैं। । कार्रवाई के साथ असंगत = const

कृपया ध्यान दें: यदि आप इस तर्क का उपयोग करते हैं, तो कमांड लाइन से आपके विकल्प का मूल्य सूची के रूप में संभालने के लिए पारित किया जाएगा, भले ही केवल एक ही तत्व हो। (इस मामले में, डिफ़ॉल्ट मान को सूची में डाले बिना, प्रसारित किया जाता है।)

डिफ़ॉल्ट डिफ़ॉल्ट मान है।
प्रकार - निर्दिष्ट प्रकार को तर्क दें।
विकल्प - तर्क मूल्य के प्रकार के प्रतिबंध संभावित मानों की एक सूची को विकल्प मान में पास किया जाता है।
आवश्यकता एक आवश्यक तर्क है।
मदद - इस तर्क का क्या वर्णन है।
भाग्य - यदि आप एक अलग नाम के तहत अपना विकल्प बचाना चाहते हैं, तो आप dest = 'my_new_name' निर्दिष्ट कर सकते हैं। अन्यथा, तर्क नाम का उपयोग किया जाएगा।
इन तर्कों को विकल्प शब्दकोश के रूप में हैंडल फ़ंक्शन में पास किया जाएगा।

लेकिन क्या होगा अगर हम संभाल करने के लिए अनाम तर्क पारित करना चाहते हैं?

इस स्थिति में, आपको ar_ विकल्प में सभी अनाम तर्कों की add_arguments में निर्दिष्ट करने की आवश्यकता है। उदाहरण के लिए, यदि हम कमांड में कई पूर्णांक पास करना चाहते हैं:

 def add_arguments(self, parser): parser.add_argument( nargs='+', type=int, dest = 'args' ) 

निष्पादन आदेश

कमांड को निम्नलिखित क्रम में निष्पादित किया जाता है:

1. सबसे पहले, run_from_argv () विधि कहा जाता है। यह विधि create_parser के लिए कॉल के माध्यम से एक पार्सर बनाता है, और बनाया गया पार्सर डिफ़ॉल्ट तर्क (प्रकार का कोई रंग नहीं) जोड़ता है, और add_arguments विधि को भी कॉल करता है, इस प्रकार हमारे द्वारा बनाए गए सभी विकल्पों को जोड़ देता है।
2. उसके बाद, निष्पादित कार्य कहा जाता है। यह फ़ंक्शन कई जाँच करता है, और फिर हैंडल फ़ंक्शन चलाता है। हैंडल का परिणाम मानक आउटपुट पर मुद्रित होता है।

बेशक, इनमें से किसी भी कार्य को अनुकूलित किया जा सकता है। उदाहरण के लिए, आइए एक बहु-पंक्ति सहायता संदेश के सुंदर आउटपुट को आकर्षित करें:

 from argparse import RawTextHelpFormatter def create_parser(self, prog_name, subcommand): parser = super(Command, self).create_parser(prog_name, subcommand) parser.formatter_class = RawTextHelpFormatter return parser 

ज्यादातर मामलों में प्रबंधन कमांड लिखने के लिए शायद यही सब कुछ है।

निष्कर्ष

आलेख प्रबंधन कमांड बनाते समय सभी संभावनाओं का एक पूरा अवलोकन होने का दावा नहीं करता है - उन्हें Django प्रलेखन में वर्णित किया गया है। जिन लोगों की रूचि हो सकती है
प्रलेखन ।

वहाँ, कमांड लाइन के तर्क को पार्स करते हुए, व्यावहारिक रूप से खुलासा नहीं किया गया है। इस मुद्दे की पेचीदगी में गोता लगाने के इच्छुक लोगों को अजगर संचयन का अध्ययन करना चाहिए।

अर्गपर्स मॉड्यूल