Python में pydoc मॉड्यूल का उपयोग करके डॉक्यूमेंटेशन जनरेशन

परिचय

pydoc मॉड्यूल Python मॉड्यूल्स से स्वचालित रूप से डॉक्यूमेंटेशन जनरेट करता है। डॉक्यूमेंटेशन को कंसोल पर टेक्स्ट के पेजों के रूप में सहेजा जा सकता है, वेब ब्राउज़र पर प्रदर्शित किया जा सकता है, या HTML फाइलों के रूप में भी।

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

अब जब आप pydoc के उपयोग को जानते हैं, तो आइए शुरू करें।

शुरुआत करना

pydoc मॉड्यूल Python के साथ पैकेज्ड आता है, जिसका अर्थ है कि आपको इसे अलग से डाउनलोड और इंस्टॉल करने की आवश्यकता नहीं है।

pydoc तक पहुंचने के लिए, आपको पहले इसे इम्पोर्ट करना होगा।

import pydoc

help() फंक्शन का उपयोग करके इंटरैक्टिव शेल एक्सेस करना

आप इसके help फंक्शन का उपयोग करके pydoc में इंटरैक्टिव शेल एक्सेस कर सकते हैं।

ऐसा करने के लिए, अपना टर्मिनल लॉन्च करें, और Python इंटरैक्टिव शेल में प्रवेश करें।

अब, pydoc इम्पोर्ट करें और फिर इंटरैक्टिव शेल लॉन्च करने के लिए pydoc.help() कमांड का उपयोग करें।

उदाहरण

>> import pydoc
>>> pydoc.help()

अब, आप मॉड्यूल, डेटाटाइप, फंक्शन, क्लासेस आदि का नाम दर्ज करके इंटरैक्टिव स्क्रिप्ट से सीधे उसका डॉक्यूमेंटेशन प्राप्त कर सकते हैं।

ब्राउज़र से डॉक्यूमेंटेशन देखना

यदि आप ब्राउज़र से डॉक्यूमेंटेशन देखना चाहते हैं, तो आप pydoc का उपयोग करके आसानी से ऐसा कर सकते हैं।

इस बार, आपको कमांड को Python शेल के माध्यम से चलाने की आवश्यकता नहीं है। बल्कि आप इसे आर्गुमेंट्स प्रदान करके सीधे लॉन्च कर सकते हैं।

ऐसा करने के लिए, अपना टर्मिनल लॉन्च करें और नीचे दिए गए कमांड को टाइप करें।

python -m pydoc -b

यह आपके लोकल सिस्टम पर मौजूद सभी Python मॉड्यूल्स, फंक्शन्स, ऑब्जेक्ट्स के लिए ब्राउज़र पर डॉक्यूमेंटेशन जनरेट करना चाहिए।

आप इस तरह से विशिष्ट कीवर्ड्स को खोज और पुनः प्राप्त भी कर सकते हैं।

C:\Users\vijay>python -m pydoc -b
Server ready at https://localhost:50621/
Server commands: [b]rowser, [q]uit
server> q
Server stopped

डॉकस्ट्रिंग्स के साथ काम करना

उदाहरण

def documentation():
    '''डॉकस्ट्रिंग्स का उपयोग करके डॉक्यूमेंटेशन'''
    print(documentation.__doc__)
help(documentation)

आउटपुट

डॉकस्ट्रिंग्स का उपयोग करके डॉक्यूमेंटेशन
Help on function documentation in module __main__:
documentation()
    डॉकस्ट्रिंग्स का उपयोग करके डॉक्यूमेंटेशन

निष्कर्ष

अब आप जानते हैं कि Python के विभिन्न कीवर्ड्स, फंक्शन्स, मॉड्यूल्स, मेथड्स के डॉक्यूमेंटेशन को pydoc फंक्शन का उपयोग करके ऑफलाइन कैसे देखें और पढ़ें।

आपने डॉकस्ट्रिंग्स का उपयोग करके अपना खुद का डॉक्यूमेंटेशन जनरेट और बनाना भी सीखा।

बड़े पैमाने के प्रोजेक्ट्स पर काम करते समय अच्छा डॉक्यूमेंटेशन बनाए रखना आवश्यक है ताकि आप जान सकें कि आप कहां क्या कर रहे हैं और भविष्य में बाद में कन्फ्यूजन से बचें। यह विभिन्न अज्ञात या रनटाइम त्रुटियों को रोकने में भी मदद करता है।