छोटा आनंद # 4: राडोण - कोड गुणवत्ता को संख्याओं में मापा जाता है

इंजीनियर माप और संख्या के बहुत शौकीन हैं। इसलिए, यह आश्चर्यजनक नहीं है कि वे संख्यात्मक रूप में मापने की कोशिश कर रहे हैं जैसे कि कोड की गुणवत्ता के रूप में एक गैर-तुच्छ चीज।

कार्यक्रमों के ग्रंथों के मूल्यांकन के लिए मेट्रिक्स का बहुत आविष्कार किया गया है - परियोजना में कोड की पंक्तियों की सामान्य संख्या से लेकर "स्पष्टता सूचकांक" तक स्पष्ट नहीं है। सभी प्रकार के मीट्रिक के साथ कोड को कोटिंग करने के सभी मौजूदा तरीकों के बारे में विवरण इस लेख में पाया जा सकता है।

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

हमने इसे अपने पास रख लिया

pip install radon 

हम आपके कोड के साथ फ़ोल्डर में जाते हैं और मापना शुरू करते हैं।

कच्चे आँकड़े

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

 radon raw ./ 

जवाब में, परियोजना की फाइलों की एक सूची और प्रत्येक फ़ाइल के आंकड़े बाहर गिर जाएंगे।

चक्रीय जटिलता

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

इसे एक टीम माना जाता है।

 radon cc ./ 

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

हाल्टेड मेट्रिक्स

यहां हम कोड में अद्वितीय ऑपरेटरों और ऑपरेंड की संख्या और उनकी कुल संख्या पर विचार करते हैं। प्राप्त मानों को सूत्रों में प्रतिस्थापित किया जाता है और संख्याओं का एक सेट प्राप्त किया जाता है जो प्रोग्राम की जटिलता और उस कोड की मात्रा का वर्णन करता है जो कोड को लिखने और समझने में खर्च किया जाता है।

 radon hal ./ 

कोड समर्थन सूचकांक

यह इंडेक्स हमें बताता है कि प्रोग्राम के एक टुकड़े को बनाए रखना या संपादित करना कितना मुश्किल होगा। इस पैरामीटर की गणना ऊपर गणना की गई मैट्रिक्स से प्राप्त संख्याओं के आधार पर की जाती है।

 radon mi ./ 

जवाब में, हमें परियोजना की फाइलों और उनके समर्थन सूचकांक में प्रकाश से लेकर बहुत भारी तक की सूची मिलती है।

मीट्रिक और उनके लिए प्रलेखन की गणना के लिए विस्तृत एल्गोरिदम यहां देखे जा सकते हैं ।

यह सब कहाँ है?

बेशक, कोड की गुणवत्ता के बारे में कोई भी निष्कर्ष निकालना असंभव है, केवल संख्यात्मक मैट्रिक्स पर निर्भर है। लेकिन कुछ मामलों में, रेडॉन के साथ एक त्वरित मूल्यांकन सहायक हो सकता है।

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

जानकारीपूर्ण? हां। उपयोगी और आवश्यक? शायद कभी-कभी, शायद कुछ मामलों में।

मेट्रिक्स के माध्यम से अपनी परियोजनाओं के एक जोड़े को चलाने के लिए, एक छोटी स्क्रिप्ट लिखें और इसे कमिट पर हुक करें? शायद शाम के लिए एक अच्छा प्रोजेक्ट।