एक सफल पायथन परियोजना के लिए 10 कदम

सामग्री, जिसका अनुवाद आज हम प्रकाशित करते हैं, उन उपकरणों के लिए समर्पित है जो कोड स्वरूपण, परीक्षण, निरंतर एकीकरण और निर्भरता विश्लेषण उपकरण के साथ पायथन परियोजनाओं को लैस करने की अनुमति देते हैं। यह विकास प्रक्रिया को गति देने में मदद करता है, कोड की गुणवत्ता, एकरूपता और सुरक्षा में सुधार करने में मदद करता है। यह माना जाता है कि इस सामग्री के पाठक को पहले से ही पायथन विकास और पायथन परियोजना में कुछ अनुभव है, जिसके साथ वह पढ़ने के दौरान प्रयोग करेंगे। यदि आपके पास ऐसी कोई परियोजना नहीं है, तो यहां आप सीख सकते हैं कि विकास का माहौल कैसे तैयार किया जाए और पायथन पैकेज बनाया जाए। यहां दिए गए उदाहरण macOS और पायथन 3.7 का उपयोग करके तैयार किए जाएंगे।

चरण 1. काले रंग की स्थापना

प्रोजेक्ट कोड को कोड शैली सम्मेलनों का पालन करना चाहिए। ब्लैक एक पायथन पैकेज है जो स्वचालित रूप से कोड को स्वरूपित करता है, जो पीईपी 8 मानक के लिए अपनी उपस्थिति लाता है। ब्लैक एक अपेक्षाकृत नई परियोजना है, लेकिन यह पहले ही एक मिलियन से अधिक डाउनलोड प्राप्त कर चुकी है। इसका उपयोग जल्दी से पायथन विकास में अच्छे स्वाद का संकेत बन गया। यहां ब्लैक मैनुअल है।

मैं, एक कोड संपादक के रूप में, एटम का उपयोग करता हूं, इसलिए मैंने एटम में Python-Black पैकेज जोड़ा। आप यह जान सकते हैं कि इसे यहां कैसे स्थापित किया जाए। इस पैकेज को स्थापित करने के बाद, एटम फाइल को सेव करने के बाद कोड को रिफॉर्म करेगा।

जबकि हम ब्लैक के बारे में बात कर रहे हैं - आइए इस टूल को उन लोगों के विकास के माहौल से लैस करें जो प्रोजेक्ट पर हमारे साथ काम करते हैं। नतीजतन, परियोजना पर काम करने वाले सभी लोग समान कोड प्रारूपण नियमों का उपयोग करेंगे, अन्यथा उनके पुल अनुरोध स्वीकार नहीं किए जाएंगे।

आवश्यकताएँ_ black==18.9b0 फ़ाइल की पहली मिली फ्री लाइन में black==18.9b0 जोड़ें और install -r requirements_dev.txt black==18.9b0 कमांड चलाएँ।

काला, डिफ़ॉल्ट रूप से, कोड की लंबाई 88 वर्णों तक निर्धारित करता है। कुछ शैली गाइड, जैसे कि स्फिंक्स , को 79 वर्णों की एक लंबी लंबाई की आवश्यकता होती है। Black-Atom पैकेज की सेटिंग में, आप वांछित लाइन की लंबाई निर्धारित कर सकते हैं।

अब जब हमें एक टूल मिल गया है, जो कोड फॉर्मेटिंग पर समय बचाने में मदद करेगा, तो हम यह सोचेंगे कि कैसे तेजी से और PyPI को कोड भेजने को सरल बनाया जाए।

चरण 2. .pypirc File बनाना

जब TestPyPI और PyPI में एप्लिकेशन असेंबली भेजने के लिए सुतली का उपयोग किया जाता है, तो आपको मैन्युअल रूप से लॉगिन जानकारी दर्ज करनी होगी। यदि आप सुतली से परिचित नहीं हैं, तो इस सामग्री पर एक नज़र डालें। अब हम इस प्रक्रिया को स्वचालित करेंगे।

सुतली .pypirc फाइल के साथ काम कर सकती है, जो हमारे होम डायरेक्टरी में होनी चाहिए। यह उपकरण, डेटा को अनलोड करने के लिए, दी गई फ़ाइल से एक URL, उपयोगकर्ता नाम और पासवर्ड लेता है।

तो, अपने घर निर्देशिका में एक .pypirc फ़ाइल बनाएँ:

 touch ~/.pypirc 

इसमें निम्न पाठ जोड़ें:

 [distutils] index-servers =   pypi   testpypi [testpypi] repository: https://test.pypi.org/legacy username = your_username password = your_pypitest_password [pypi] username = your_username password = your_pypi_password 

यह स्पष्ट है कि यहां आपको अपना वास्तविक उपयोगकर्ता नाम और पासवर्ड दर्ज करना होगा। यह भी देखें कि यह फ़ाइल होम डायरेक्टरी में सेव की गई है, न कि मौजूदा वर्किंग डायरेक्टरी में। यदि आप इस फ़ाइल को अन्य उपयोगकर्ताओं से सुरक्षित रखना चाहते हैं, तो आप कमांड लाइन टूल का उपयोग करके, इसकी अनुमति को कॉन्फ़िगर कर सकते हैं:

 chmod 600 ~/.pypirc 

अब आपके पैकेज को निम्नलिखित कमांड का उपयोग करके TestPyPI में लोड किया जा सकता है:

 twine upload -r testpypi dist/* 

नियमित रूप से PyPI में, आप इस तरह से पैकेज लोड कर सकते हैं:

 twine upload dist/* 

.pypirc फ़ाइल प्राप्त करने के बाद, आपको अब अपना उपयोगकर्ता नाम और पासवर्ड मैन्युअल रूप से दर्ज नहीं करना होगा।

अब हम अपने विकास के वातावरण में परीक्षण उपकरण जोड़ते हैं जो हमें उस पैकेज के सही संचालन को सत्यापित करने की अनुमति देगा जो हम बना रहे हैं।

चरण 3. स्थापित करें और pytest कॉन्फ़िगर करें

पायथन पाइथन में लिखे गए परीक्षण कोड के लिए सबसे लोकप्रिय, उपयोग में आसान लाइब्रेरी है। इस उदाहरण में, हम प्रोजेक्ट में सरल परीक्षण जोड़ेंगे। अब , यदि आप pytest के विवरण में रुचि रखते हैं, तो इस उपकरण का एक अच्छा परिचयात्मक मार्गदर्शक।

requirements_dev.txt लिए अधिक विवरण जोड़ें_dev.txt:

 pytest==4.3.0 

आइए पैकेज स्थापित करें:

 pip install requirements_dev.txt 

अब निम्नलिखित कमांड निष्पादित करें, जो हमारे पैकेज को खोजने के लिए पूरी तरह से अनुमति देगा:

 pip install -e . 

यदि आपने अपने वर्चुअल डेवलपमेंट परिवेश को निष्क्रिय कर दिया है, तो आपको परीक्षणों को चलाने के लिए फिर से दोनों pip कमांड चलाने की आवश्यकता होगी।

चरण 4. टेस्ट बनाना

test फ़ोल्डर को अपनी परियोजना की मूल निर्देशिका में जोड़ें। इसमें फ़ाइल test_your_package_name.py रखें। मेरी फ़ाइल को test_notebookc.py कहा जाता है। यदि फ़ाइल का नाम test_ शुरू होता है, तो pytest स्वचालित रूप से ऐसी फ़ाइल का पता लगा सकता है।

मैंने निम्नलिखित परीक्षण को test_notebookc.py फ़ाइल में test_notebookc.py है, जिसका उद्देश्य यह test_notebookc.py है कि फ़ंक्शन सही नाम प्रदर्शित करता है या नहीं। इस कोड को संशोधित करें ताकि इसमें उपयोग की गई फ़ाइल और फ़ंक्शन नाम आपका मिलान करें, इसमें अपने स्वयं के परीक्षणों का वर्णन करें।

 """Tests for `notebookc` package.""" import pytest from notebookc import notebookc def test_convert(capsys):   """Correct my_name argument prints"""   notebookc.convert("Jill")   captured = capsys.readouterr()   assert "Jall" in captured.out 

यहाँ क्या हो रहा है?

पहले हम अपने मॉड्यूल को यहां आयात करते हैं। फिर हम एक फ़ंक्शन बनाते हैं जिसका नाम टेम्प्लेट test_my_function_name अनुसार बनाया गया है। यह फ़ंक्शन नामकरण सम्मेलन अन्य लोगों को आपके प्रोजेक्ट कोड को पढ़ने की अनुमति देता है ताकि यह समझ सके कि परीक्षणों में वास्तव में क्या परीक्षण किया जा रहा है। इसके अलावा, यह एक पैकेज के लिए आवश्यक है जो परीक्षणों के साथ कोड की कवरेज को नियंत्रित करने में मदद करता है, जिसके बारे में हम नीचे चर्चा करेंगे।

उसके बाद, हम फ़ंक्शन ( convert ) को कॉल करते हैं, इसे एक तर्क के रूप में Jill नाम देते हैं। अगला - फ़ंक्शन जो दिखाता है उसे कैप्चर करें। यहां यह कहने योग्य है कि प्रश्न में फ़ंक्शन अत्यंत सरल है। वह my_name पैरामीटर लेता है और निम्न कार्य करता है:

 print(f"I'll convert a notebook for you some day, {my_name}.") 

यह देखने के लिए पाइस्टेस्ट चेक करता है कि क्या फ़ंक्शन आउटपुट में Jall है या नहीं। यह रेखा नहीं होनी चाहिए, क्योंकि हम Jill कार्यों को पारित करते हैं। यहाँ पर पाइटेस्ट डॉक्यूमेंटेशन है जहाँ आप इंटरसेप्टिंग आउटपुट के बारे में जानकारी पा सकते हैं।

कमांड प्रॉम्प्ट पर pytest लिखकर परीक्षण चलाएँ। यह परीक्षा असफल होनी चाहिए। त्रुटि जानकारी लाल रंग में प्रदर्शित होती है।


परीक्षण के दौरान एक त्रुटि का पता चला था।

यह सही होने के लिए परीक्षणों की जांच करने की सिफारिश की गई है, उनका वर्णन करते हुए कि कुछ शर्तों के तहत, वे एक त्रुटि के साथ समाप्त हो जाएंगे। आपको ऐसे परीक्षणों को नहीं लिखना चाहिए जो केवल हरे संदेश देते हैं, क्योंकि अन्यथा यह पता चल सकता है कि परीक्षण उन सभी की जांच करते हैं जो उन्हें जांचने के लिए लिखे गए हैं।

हमने यह सुनिश्चित करने के बाद कि परीक्षण विफल हो गया, Jill बयान को Jill बदल Jall और फिर से परीक्षण चलाएं। अब इसे सफलतापूर्वक पूरा करना चाहिए।


परीक्षण के सफल समापन।

अब सब ठीक है। परीक्षण आपको यह सुनिश्चित करने की अनुमति देता है कि यदि कोई हमारे फ़ंक्शन के लिए एक पंक्ति से गुजरता है, तो यह रेखा उस पाठ में गिर जाएगी जिसे यह फ़ंक्शन प्रदर्शित करता है।

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

जब हमने पिछला परीक्षण बनाया था, तो हमने कोड लिखा था जो परीक्षण के सफल समापन की ओर ले जाता है। इसे Test-Driven Development (TDD) कहा जाता है। टीडीडी एक सिद्ध प्रोग्रामिंग दृष्टिकोण है जो आपको कोड लिखने में मदद करता है जिसमें टीडीडी के बिना कम त्रुटियां होती हैं। यहाँ कुछ उपयोगी टीडीडी सामग्री है।

अब, एक अभ्यास के रूप में, एक परीक्षण लिखने की कोशिश करें जो convert() फ़ंक्शन की जांच करता है ताकि स्ट्रिंग से कुछ अलग करते समय, यह एक त्रुटि फेंक दे, और इस फ़ंक्शन के लिए उपयुक्त तंत्र को लागू कर सके। ध्यान दें कि पूर्णांकों, सूचियों और शब्दकोशों को स्ट्रिंग में बदल दिया जाता है।

पैकेज सफलतापूर्वक परीक्षणों को पारित करने के बाद, हम निरंतर एकीकरण प्रणाली का लाभ उठाने के लिए तैयार हैं।

चरण 5. ट्रैविस सीआई सेवा और उसके कॉन्फ़िगरेशन में पंजीकरण

ट्रैविस CI एक "वितरित वेब सेवा है जो सॉफ्टवेयर और निर्माण सॉफ्टवेयर के लिए है।" इसे हाल ही में इडेरा ने खरीदा था। अन्य निरंतर एकीकरण प्रणालियां हैं, लेकिन ट्रैविस सीआई एक लोकप्रिय, खुला-स्रोत और अच्छी तरह से प्रलेखित उपकरण है, इसलिए हम इसका उपयोग करेंगे।

ट्रैविस सीआई आपको अपनी परियोजना में केवल उस कोड को एकीकृत करने की अनुमति देता है जो परीक्षण पास करता है और मानकों को पूरा करता है। यहां आप ट्रैविस सीआई के बारे में अधिक पढ़ सकते हैं, और यहां निरंतर एकीकरण के बारे में पढ़ सकते हैं।

Https://travis-ci.org/ पर एक खाता बनाएँ। इसके बाद, लिंक पर क्लिक करें Review and add your authorized organizations प्रोफ़ाइल पृष्ठ पर Review and add your authorized organizations को Review and add your authorized organizations । आपको GitHub तक पहुंचने के लिए पासवर्ड के लिए कहा जाएगा। Organization access अनुभाग में Grant पर क्लिक करें।


ट्रैविस सीआई खाता सेट करें

मुझे नोटबुकटॉल के बारे में जानकारी और खाते में प्रदर्शित होने के लिए notebookc रिपॉजिटरी के लिए खाते को सिंक्रनाइज़ करने की आवश्यकता है। आमतौर पर, ट्रैविस CI को कोड के साथ काम करने में लगभग एक मिनट का समय लगता है। उसके बाद, आपको निम्न आकृति में दिखाए गए स्विच का उपयोग करके भंडार को सक्रिय करना होगा।


रिपोजिटरी सक्रियण

अब Settings बटन पर क्लिक करें। यहां आपको यह इंगित करने की आवश्यकता है कि ट्रैविस पुल अनुरोधों के आधार पर निर्माण कर सकता है या रिपॉजिटरी को भेजी गई शाखाएं।


प्रोजेक्ट बिल्ड सेटअप

अब हम जिस परियोजना पर काम कर रहे हैं, उसे स्थापित करने का समय आ गया है, जिससे ट्रैविस प्रत्येक पुल अनुरोध के लिए परियोजना का निर्माण कर सकेगा।

चरण 6. .travis.yml फ़ाइल बनाना

प्रोजेक्ट रूट फ़ोल्डर में, निम्न सामग्री के साथ एक .travis.yml फ़ाइल बनाएँ:

 dist: xenial language: python python: 3.7.2 install: - pip install -r requirements_dev.txt - pip install -e . script: - pytest 

dist: xenial ट्रैविस को उबुन्टू क्निअल 16.04 का उपयोग करने के लिए आभासी वातावरण को व्यवस्थित करने के लिए dist: xenial आवश्यकता है। पायथन 3.7 कोड का परीक्षण करने के लिए, Ubuntu Xenial की आवश्यकता है, इसके बारे में विवरण यहां पाया जा सकता है ।

install सेक्शन आपको प्रोजेक्ट डेवलपमेंट में उपयोग किए गए पैकेज को स्थापित करने की अनुमति देता है। pip install -e . कमांड ट्रैविस के आभासी वातावरण में हमारे पैकेज की स्थापना करता है। उसके बाद, ट्रेविस, जो कि पाइस्टेस्ट शुरू कर रहा है, हमारे पैकेज को खोजने में सक्षम होगा।

चरण 7. ट्रेविस सीआई में परीक्षण

परिवर्तन करें, उन्हें GitHub में सबमिट करें, PR करें। ट्रैविस को सेकंड के भीतर काम करना शुरू कर देना चाहिए।


काम पर ट्रैविस

ट्रैविस परियोजना को संभालने में यही करता है।


ट्रैविस द्वारा परियोजना प्रसंस्करण के दौरान किए गए कार्य

यदि पीआर असफल रहा - ट्रैविस इसकी रिपोर्ट करेगा। कृपया ध्यान दें कि यदि पुल अनुरोध असफल है, तो आप उसी शाखा में परिवर्तन भेज सकते हैं और ट्रैविस स्वचालित रूप से काम करना शुरू कर देगा।

ट्रैविस वेबसाइट पर अपने रिपॉजिटरी पेज पर जाएं और वहां देखें। यहां आप विधानसभाओं के बारे में बहुत सारी दिलचस्प बातें जान सकते हैं। संभवतः भविष्य में आप इस पृष्ठ के लगातार अतिथि बनेंगे जब आप यह समझने की कोशिश करेंगे कि असफल विधानसभा का कारण क्या था।

यदि हम मानते हैं कि सब कुछ ठीक हो गया, यदि पृष्ठ में हरे लेबल हैं, तो परियोजना का सत्यापन और संयोजन सफल रहे।


प्रोजेक्ट असेंबली सफलतापूर्वक संपन्न हुई

यदि पृष्ठ पर हरे या लाल लेबल नहीं हैं, तो More options मेनू खोलें और Requests चयन करें। यदि आप यहां लाल त्रुटि संदेश देखते हैं, तो उनका विश्लेषण करें। यदि आप देखते हैं कि Build config file is required त्रुटि संदेश की Build config file is required , तो इसका मतलब है कि ट्रैविस रिपॉजिटरी में आपकी .travis.yml फ़ाइल नहीं खोज सकता है। इसे ठीक करें और त्रुटि गायब हो जाएगी।

ट्रैविस उपयोगकर्ताओं को उन मामलों में ईमेल भेजता है जहां परियोजना की असेंबली असफल है, और उन मामलों में जहां इसे ठीक करना संभव है।

याद रखें कि आप PR खोलने के लिए कमिट भेज सकते हैं और ट्रैविस स्वचालित रूप से प्रोजेक्ट बिल्ड प्रक्रिया को पुनः आरंभ करेगा।

अब कोड को परीक्षणों के साथ कवर करने के लिए हमारी परियोजना का विश्लेषण करें।

चरण 8. परीक्षणों के साथ कोड कवरेज का आकलन करना

परीक्षणों के साथ कोड कवरेज पर रिपोर्ट आपको यह पता लगाने की अनुमति देती है कि परियोजना कोड के किस भाग में, एक छोटे से परीक्षण किया गया है। ऐसी रिपोर्ट बनाने के लिए, हम pytest-cov पैकेज का उपयोग करेंगे।

requirements_dev.txt लिए निम्नलिखित पंक्ति को requirements_dev.txt फ़ाइल:

 pytest-cov==2.6.1 

निम्न आदेश चलाएँ:

 pytest --cov=my_project_name 

मेरे मामले में, pytest --cov=notebookc कमांड pytest --cov=notebookc के बाद, निम्न रिपोर्ट प्रदर्शित की गई थी।


कोड कवरेज रिपोर्ट

जैसा कि यह निकला, सभी परियोजना कोड परीक्षणों के साथ प्रदान किए गए हैं। इस तरह के संकेतक बहुत आसानी से हासिल कर सकते हैं यदि पूरी परियोजना में कोड की कई लाइनें हों।

अब आइए एक उपकरण के बारे में बात करते हैं जो आपको परीक्षण के साथ अपने कोड को कवर करने के मामले में परियोजना की स्थिति का सार्वजनिक इतिहास रखने की अनुमति देता है।

चरण 9. कवरॉल का उपयोग करना

कवरल्स प्रोजेक्ट आपको परीक्षणों के साथ कोड कवरेज के बारे में ऐतिहासिक जानकारी बनाए रखने की अनुमति देता है।


coveralls

इस परियोजना की क्षमताओं का लाभ उठाने के लिए, आपको अपने GitHub खाते के डेटा का उपयोग करके साइट https://coveralls.io/ पर पंजीकरण करना होगा। फिर आपको रिपॉजिटरी को कनेक्ट करने की आवश्यकता है।

requirements_dev.txt फ़ाइल में, लाइन coveralls==1.6.0 जोड़ें coveralls==1.6.0 । यह फ़ाइल, वैसे, प्रोजेक्ट पर काम के इस स्तर पर इस तरह दिखना चाहिए:

 pip==19.0.3 wheel==0.33.0 twine==1.13.0 pytest==4.3.0 pytest-cov==2.6.1 coveralls==1.6.0 

.travis.yml फ़ाइल को .travis.yml , इसे इस रूप में लाते हैं (आपके मामले में, आपकी परियोजना का नाम यहां होगा):

 dist: xenial language: python python: 3.7.2 install: — pip install -r requirements_dev.txt — pip install -e . script: — pytest --cov=my_package_name after_success: — coveralls 

अब, जब ट्रैविस परियोजना का निर्माण करेगा, तो वह आवश्यक पैकेज स्थापित करेगा, परीक्षण चलाएगा और परीक्षणों के साथ कोड के कवरेज पर एक रिपोर्ट तैयार करेगा। फिर इस रिपोर्ट को Coveralls सेवा के लिए भेजा जाएगा।

कमिट करें, GitHub को कोड सबमिट करें, और देखें कि क्या होता है। Coveralls में आने के लिए कोड कवरेज परीक्षण रिपोर्ट में कुछ मिनट लग सकते हैं।


प्रोजेक्ट प्रोसेसिंग, टेस्ट कवरेज रिपोर्ट

अब, PR चेक के बीच, Coveralls द्वारा किया गया चेक भी है।

Coveralls पृष्ठ पर, आप यह सत्यापित कर सकते हैं कि परियोजना परीक्षणों में 100% कवर है।


टेस्ट कवरेज जानकारी

अब हम अपनी परियोजना को एक और उपयोगी उपकरण से लैस करते हैं।

चरण 10. PyUp के साथ कार्य करना

PyUp.io सेवा डेवलपर को यह पता लगाने की अनुमति देती है कि क्या उसके द्वारा उपयोग की गई निर्भरताएं पुरानी हैं और क्या उनकी कमजोरियां हैं। यह सेवा स्वचालित रूप से GitHub पर पैकेज को अद्यतन करने के उद्देश्य से पुल अनुरोधों को निष्पादित करती है। इस परियोजना की क्षमताओं का लाभ उठाने के लिए, आपको इसकी वेबसाइट - https://pyup.io/ पर GitHub खाते का उपयोग करके पंजीकरण करना होगा। रिपॉजिटरी जोड़ते समय, every week Update Schedules सेट करने की सिफारिश की जाती है। इस दृष्टिकोण के साथ, यदि आपकी परियोजना में कई निर्भरताएं हैं, तो आप बहुत अधिक पुल अनुरोधों का सामना नहीं करेंगे।


अपडेट कॉन्फ़िगर करें

यहाँ पैकेज की जानकारी कैसी दिखती है, इनमें से कुछ पुरानी हैं, PyUp.io वेबसाइट पर।


पैकेज विवरण

इस सेवा का उपयोग करते हुए, आपको हमेशा पता चलेगा कि आपके द्वारा उपयोग किए जाने वाले पैकेज के नवीनतम संस्करण कब निकलते हैं। ज्ञान, जैसा कि वे कहते हैं, आधी जीत है। और दूसरी छमाही निर्भरता को अद्यतन करने के लिए, जाहिर है, स्वचालित पुल-अनुरोध है।

परिणाम

इस लेख में, आपने सीखा कि पायथन परियोजनाओं को विकसित करते समय ब्लैक, पाइस्टेस्ट, ट्रैविस सीआई, कवरॉल्स और PyUp जैसे टूल का उपयोग कैसे करें। वे परियोजना निर्भरता, प्रारूप और परीक्षण कोड को नियंत्रित करने और परियोजनाओं के सत्यापन और निर्माण में मदद करते हैं। हमें उम्मीद है कि आपको ये उपकरण उपयोगी लगेंगे।

प्रिय पाठकों! पायथन परियोजनाओं को विकसित करते समय आप किन उपकरणों का उपयोग करते हैं?