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

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

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

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

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

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

# example
def sample(random):
   # statement 1
   # statement 2
   # ...
   return random

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

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

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

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

# example
tup = (1, 2, 3,)

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

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

def sample():
   """This is a function"""
   """
   This
   is
   a function
   """
class Smaple:
   """This is a class"""
   """
   This
   is
   a class
   """

एक पंक्ति में 79 से अधिक वर्ण न लिखें

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

# example
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)

रिक्त स्थान का उपयोग करना

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

# example
import random
result = random.randint(1, 3) + random.randint(1, 2)

नामकरण चर, स्थिरांक, वर्ग और कार्य

पूरे कार्यक्रम में चर, स्थिरांक, कक्षाओं और कार्यों के लिए एक ही मामले का पालन करें। अधिकांश पायथन उपयोगकर्ता snake_case . का उपयोग करेंगे कार्यों और चरों के नामकरण और पास्कलकेस . के लिए कक्षाओं के नामकरण के लिए। स्थिरांक के लिए, अंडरस्कोर से अलग किए गए सभी बड़े अक्षरों का उपयोग करें (उदा:- PI_TWO )।

सांप_केस => this_is_function

पास्कलकेस => ThisIsClass

CONSTANT => THIS_IS_CONSTANT

एक बार में एक मॉड्यूल आयात करना

वाक्य-रचना की दृष्टि से सही होने पर भी एक में एकाधिक मॉड्यूल आयात करने का प्रयास न करें। नीचे दिया गया उदाहरण देखें।

# don't
import math, random
# do
import math
import random

टिप्पणी अपडेट करना

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

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

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

पहचानकर्ताओं में ASCII वर्णों का उपयोग न करें

ASCII . का उपयोग करना पहचानकर्ताओं में वर्ण एक अच्छा अभ्यास नहीं है। उनका उपयोग करने से बचें।