पायथन कोडिंग स्टाइल गाइड

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

पायथन के लिए, अधिकांश उपयोगकर्ता PEP 8 स्टाइल गाइड का पालन करते हैं। कोड सुंदर और अधिक पठनीय दिखता है। आप स्टाइल गाइड की पूरी सूची यहां पा सकते हैं। इस लेख में हम स्टाइल गाइड की एक क्यूरेटेड सूची प्रस्तुत कर रहे हैं।

इंडेंटेशन के लिए टैब का उपयोग करें

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

नीचे कुछ उदाहरण देख सकते हैं।

# उदाहरण
def sample(random):
    # स्टेटमेंट 1
    # स्टेटमेंट 2
    # ...
    return random

पायथन का डिफ़ॉल्ट UTF-8 या ASCII एन्कोडिंग

अंतरराष्ट्रीय वातावरण के लिए पायथन के डिफ़ॉल्ट UTF-8 या ASCII एन्कोडिंग का उपयोग करना सर्वोत्तम अभ्यास है।

टुपल्स में ट्रेलिंग कॉमा

टुपल्स में ट्रेलिंग कॉमा का उपयोग सर्वोत्तम प्रथाओं में से एक है। लेकिन, यह अनिवार्य नहीं है।

# उदाहरण
tup = (1, 2, 3,)

डॉकस्ट्रिंग्स का उपयोग

फंक्शन्स और क्लासेस में डॉकस्ट्रिंग का उपयोग करें। हम डॉकस्ट्रिंग्स के लिए ट्रिपल कोट्स का उपयोग कर सकते हैं। नीचे कुछ उदाहरण देखें।

def sample():
    \"\"\"This is a function\"\"\"
    \"\"\"
    This
    is
    a function
    \"\"\"

class Sample:
    \"\"\"This is a class\"\"\"
    \"\"\"
    This
    is
    a class
    \"\"\"

एक लाइन में 79 से अधिक कैरेक्टर्स न लिखें

PEP 8 स्टाइल गाइड में एक लाइन में 79 से अधिक कैरेक्टर्स लिखने की अनुशंसा नहीं की जाती है। एस्केप कैरेक्टर (\\) का उपयोग करके लाइन को कई लाइनों में तोड़कर इससे बचें। नीचे उदाहरण देखें।

# उदाहरण
def evaluate(a, b, c, d):
    return (2 ** (a + b) / (c // d) ** d + a - d * b) \\
    - (3 ** (a + b) / (c // d) ** d + a - d * b)

स्पेसेस का उपयोग

ऑपरेटर के पहले और बाद में स्पेस का उपयोग करना सर्वोत्तम प्रथाओं में से एक है। बेहतर पठनीयता के लिए कॉमा के बाद भी स्पेस का उपयोग करें।

# उदाहरण
import random
result = random.randint(1, 3) + random.randint(1, 2)

वेरिएबल्स, कॉन्स्टेंट्स, क्लासेस और फंक्शन्स का नामकरण

प्रोग्राम भर में वेरिएबल्स, कॉन्स्टेंट्स, क्लासेस और फंक्शन्स के लिए एक ही केस का पालन करें। अधिकांश पायथन उपयोगकर्ता फंक्शन्स और वेरिएबल्स के नामकरण के लिए snake_case और क्लासेस के नामकरण के लिए PascalCase का उपयोग करते हैं। कॉन्स्टेंट्स के लिए, अंडरस्कोर से अलग किए गए सभी अपरकेस लेटर्स का उपयोग करें (उदाहरण: PI_TWO)।

snake_case => this_is_function

PascalCase => ThisIsClass

CONSTANT => THIS_IS_CONSTANT

एक समय में एक मॉड्यूल इम्पोर्ट करें

भले ही यह सिंटैक्टिकली सही हो, एक ही लाइन में कई मॉड्यूल्स इम्पोर्ट करने का प्रयास न करें। नीचे उदाहरण देखें।

# न करें
import math, random

# करें
import math
import random

कमेंट्स अपडेट रखें

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

ऐसे कैरेक्टर्स जिन्हें सिंगल वेरिएबल नाम के रूप में उपयोग नहीं करना चाहिए

कुछ कैरेक्टर्स हैं जिन्हें अकेले वेरिएबल नाम के रूप में उपयोग नहीं किया जाना चाहिए। वे हैं I (अपरकेस i), और l (लोअरकेस L) क्योंकि वे रोमन अक्षरों के समान दिखते हैं।

आइडेंटिफायर्स में ASCII कैरेक्टर्स का उपयोग न करें

आइडेंटिफायर्स में ASCII कैरेक्टर्स का उपयोग करना बिल्कुल भी अच्छी प्रथा नहीं है। इनका उपयोग करने से बचें।