💴 🤰🏿 🖐🏽 सही टूलकिट ढूँढना: लोकप्रिय पायथन प्रोजेक्ट टेम्प्लेट का विश्लेषण करना 🕺🏻 🏥 📛

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

अवलोकन

पायथन विकास की "सर्वोत्तम प्रथाओं" के बारे में एक उद्देश्य राय बनाना मेरे लिए हमेशा मुश्किल रहा है। तकनीक की दुनिया में, कुछ लोकप्रिय रुझान लगातार उभर रहे हैं, अक्सर लंबे समय तक मौजूद नहीं होते हैं। यह सूचना के शोर से "उपयोगी संकेत" के निष्कर्षण को जटिल करता है।

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

मुझे इस बात की स्पष्ट समझ नहीं थी कि वास्तव में मैंने विकास की "सर्वोत्तम प्रथाओं" को क्या माना है। मुझे लगता है कि मैंने कुछ उपयोगी पाया, मुख्य रूप से "उपयोगिता" के एपिसोडिक सबूतों पर आधारित, और बातचीत में कभी-कभार इसका उल्लेख किया। पिछले कुछ हफ्तों में, मैंने इस मामले में चीजों को रखने का फैसला किया। ऐसा करने के लिए, मैंने पायथन प्रोजेक्ट्स के सभी टेम्प्लेट्स का विश्लेषण करना शुरू किया, जो मुझे मिल सकते हैं (हम उन पर आधारित पायथन प्रोजेक्ट्स बनाने के लिए कुकीक्यूटर कमांड-लाइन यूटिलिटी द्वारा उपयोग किए गए टेम्प्लेट्स के बारे में बात कर रहे हैं)।

मुझे ऐसा लगा कि यह पता लगाना बहुत दिलचस्प था कि इन टूल्स के आधार पर तैयार किए गए नए पायथन प्रोजेक्ट में इन टूल्स को पाने के लिए सहायक लेखक किस तरह के सहायक उपकरण को योग्य मानते हैं।

मैंने 18 सबसे लोकप्रिय टेम्प्लेट प्रोजेक्ट्स (गिथहब पर 76 से 6300 सितारों से) का विश्लेषण किया और उनकी तुलना में, विशेष ध्यान दिया कि वे किस प्रकार के सहायक उपकरणों का उपयोग करते हैं। इस विश्लेषण के परिणाम इस तालिका में पाए जा सकते हैं ।

नीचे मैं मुख्य निष्कर्षों को साझा करना चाहता हूं जो मैंने लोकप्रिय टेम्पलेट्स का विश्लेषण करते समय किए हैं।

डी वास्तविक मानकों

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

▍Flake8

मैं काफी समय से Flake8 का उपयोग कर रहा हूं , लेकिन मुझे यह पता नहीं था कि लाइनिंग के क्षेत्र में प्रमुख स्थान के बारे में यह नहीं पता है कि यह किस स्थान पर है। मैंने सोचा था कि यह एक प्रकार की प्रतियोगिता में मौजूद है, लेकिन अधिकांश परियोजना के खाके इसका उपयोग करते हैं।

हां, यह आश्चर्य की बात नहीं है। कुछ ही सेकंड में प्रोजेक्ट के पूरे कोड बेस को लाइन करने की सुविधा के लिए कुछ विरोध करना मुश्किल है। जो लोग अत्याधुनिक घटनाओं का उपयोग करना चाहते हैं, वेमेक-पाइथन-स्टाइलगाइड पर एक नज़र डाल सकते हैं । यह कुछ ऐसा है "स्टेरॉयड पर फ्लेके 8"। यह उपकरण अच्छी तरह से अप्रचलित अन्य समान उपकरण (जैसे पाइलिंट) की श्रेणी में स्थानांतरण में योगदान कर सकता है।

▍प्यार और कवरेज

बहुसंख्यक टेम्प्लेट पाइस्टेस्ट का उपयोग करते हैं । यह मानक unittest परीक्षण ढांचे के उपयोग को कम करता है। जब साथ संयुक्त Pytest और भी अधिक आकर्षक लग रहा है tox । लगभग आधे खाकों में यही किया गया था। परीक्षण के साथ कोड कवरेज को सबसे अधिक बार कवरेज ऑरेकल का उपयोग करके जांचा जाता है ।

▍Sphinx

अधिकांश टेम्प्लेट प्रलेखन बनाने के लिए स्फिंक्स का उपयोग करते हैं । मेरे आश्चर्य के लिए, MkDocs का उपयोग शायद ही कभी इस उद्देश्य के लिए किया जाता है।

परिणामस्वरूप, हम कह सकते हैं कि यदि आप अपने वर्तमान प्रोजेक्ट में Flake8, pytest और Sphinx का उपयोग नहीं करते हैं, तो आपको उन्हें शुरू करने पर विचार करना चाहिए।

होनहार औजार

इस खंड में, मैंने काम के उन उपकरणों और तकनीकों को एकत्र किया है, जिनमें से टेम्प्लेट का उपयोग कुछ रुझानों का सुझाव देता है। मुद्दा यह है कि यद्यपि यह सब अधिकांश प्रोजेक्ट टेम्प्लेट में नहीं दिखाई देता है, यह कई हालिया टेम्प्लेट में पाया जाता है। तो - यह सब ध्यान देने योग्य है।

▍Pyproject.toml

पीईपी 518pyproject.toml में फ़ाइल उपयोग का सुझाव दिया गया है । यह परियोजना विधानसभा आवश्यकताओं को निर्दिष्ट करने के लिए एक आधुनिक तंत्र है। इसका उपयोग सबसे अधिक युवा टेम्पलेट्स में किया जाता है।

▍Poetry

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

सबसे कम उम्र (लेकिन, फिर भी, लोकप्रिय) प्रोजेक्ट टेम्पलेट मेरा इस विचार से सहमत हैं। यह सच है, यह कहने योग्य है कि यदि कोई व्यक्ति किसी प्रकार के पुस्तकालय पर काम कर रहा है जिसे वह PyPI के माध्यम से वितरित करने की योजना बना सकता है , तो उसे अभी भी सेटप्टूल का उपयोग करना होगा । (यह ध्यान दिया जाना चाहिए कि इस सामग्री के प्रकाशन के बाद मुझे सूचित किया गया था कि यह, जाहिरा तौर पर, अब कोई समस्या नहीं है)।

इसके अलावा, सावधान रहना है, तो अपनी परियोजना (एक ही निर्भरता के लिए चला जाता है) पर निर्भर करता Conda। इस मामले में, कविता आपको सूट नहीं करेगी, क्योंकि यह उपकरण, अपने वर्तमान रूप में, डेवलपर को पाइप करने के लिए और virtualenv को बांधता है ।

▍Dependabot

Dependabot नियमित रूप से अप्रचलन के लिए परियोजना की निर्भरता की जाँच करता है और पीआर को स्वचालित रूप से खोलकर डेवलपर की मदद करने की कोशिश करता है।

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

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

व्यक्तिगत सिफारिशें

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

▍Pre-लिखें

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

▍Pylint

यद्यपि पाइलिंट की धीमी होने के लिए आलोचना की जाती है , हालांकि इस उपकरण की इसकी सेटिंग्स की विशेषताओं के लिए आलोचना की जाती है, मैं कह सकता हूं कि इसने मुझे प्रोग्रामिंग के क्षेत्र में खुद से ऊपर बढ़ने की अनुमति दी।

वह मुझे कोड के उन हिस्सों पर विशिष्ट निर्देश देता है जिन्हें मैं सुधार सकता हूं, मुझे बताता है कि कोड को नियमों का बेहतर अनुपालन कैसे करें। एक मुफ्त टूल के लिए, यह अकेले पहले से ही बहुत अधिक है। इसलिए, मैं Pylint के साथ जुड़े असुविधा के साथ तैयार हूं।

▍Black

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

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

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

सबटोटल

अठारह जांच किए गए टेम्प्लेट में से 12 कूकीचर फ्रेमवर्क का उपयोग करके बनाए गए थे । उन कुछ टेम्पलेट्स में जहां इस ढांचे का उपयोग नहीं किया गया है, उनमें दिलचस्प गुण हैं।

लेकिन इस तथ्य को देखते हुए कि परियोजना के खाके बनाने के लिए कुकिजेटर प्रमुख ढांचा है, जो लोग ऐसे खाके का उपयोग करने का निर्णय लेते हैं, जिन्होंने कुकिसेटर का उपयोग नहीं किया है, इसके लिए अच्छे कारण होने चाहिए। इस तरह के निर्णय को बहुत उचित ठहराया जाना चाहिए।

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

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

बोनस: टेम्पलेट अनुशंसाएँ

▍Django

सबसे लोकप्रिय Django टेम्प्लेट के साथ, wemake-django- टेम्प्लेट का उपयोग करने पर विचार करें । यह एक गहन विचार उत्पाद की छाप देता है।

▍ डाटा प्रोसेसिंग और विश्लेषण

डेटा के प्रसंस्करण और विश्लेषण के उद्देश्य से अधिकांश परियोजनाओं में, कुकिसेटर डेटा साइंस टेम्पलेट उपयोगी है । हालांकि, डेटा वैज्ञानिकों को भी केदारो को देखना चाहिए ।

यह खाका मानकीकृत डेटा प्रोसेसिंग पाइपलाइन बनाने के लिए एक तंत्र के साथ कुकिसेटर डेटा साइंस का विस्तार करता है। यह डेटा और मॉडल को लोड करने और सहेजने का समर्थन करता है। ये विशेषताएं आपके अगले प्रोजेक्ट में योग्य एप्लिकेशन खोजने में सक्षम होने की बहुत संभावना है।

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

Templates सामान्य उद्देश्य टेम्पलेट

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

यह एक प्रसिद्ध पैटर्न नहीं है, लेकिन मुझे यह तथ्य पसंद है कि इसमें पोएट्री, आइसोर्ट , ब्लैक, पाइलिंट, और मैपी है ।

PyScaffold सबसे लोकप्रिय गैर-कुकिसेटर आधारित टेम्पलेट्स में से एक है। इसके कई एक्सटेंशन हैं (उदाहरण के लिए, Django और डेटा साइंस प्रोजेक्ट के लिए )। यह सेटपूल-स्कैम का उपयोग करके GitHub से संस्करण संख्याओं को भी डाउनलोड करता है। इसके अलावा, यह कॉनडा का समर्थन करने वाले कुछ टेम्पलेट्स में से एक है।

यहाँ कुछ जोड़े हैं जो GitHub Actions Technology का उपयोग करते हैं:

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

और अंत में - मैं wemake-python-package टेम्पलेट पर एक नज़र डालने की सलाह देता हूं । मुझे लगता है कि यह वैसे भी करने लायक है। विशेष रूप से - यदि आप एक ही डेवलपर के Django- टेम्पलेट को पसंद करते हैं, या यदि आप शुद्ध फ्लेक 8 के बजाय उन्नत वेमेक-पायथन-स्टाइलगाइड का उपयोग करने जा रहे हैं ।

सारांश

इस लेख के प्रकाशित होने के बाद, मैंने इसके बारे में गुइडो वैन रोसुम को लिखा।

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

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

सही टूलकिट ढूँढना: लोकप्रिय पायथन प्रोजेक्ट टेम्प्लेट का विश्लेषण करना