परिचय
पाइडोक मॉड्यूल स्वचालित रूप से पायथन मॉड्यूल से प्रलेखन उत्पन्न करता है। दस्तावेज़ीकरण को वेब ब्राउज़र पर प्रदर्शित कंसोल पर पाठ के पृष्ठों के रूप में, या यहाँ तक कि HTML फ़ाइलों के रूप में भी सहेजा जा सकता है।
इस लेख में आप विभिन्न मामलों में इन दस्तावेज़ों को देखने के तरीके सीखेंगे और यहां तक कि उन डॉकस्ट्रिंग के बारे में भी जानेंगे जो आपकी पायथन लिपियों के लिए अपना स्वयं का दस्तावेज़ बनाने में मदद करते हैं।
अब जब आप pydoc के उपयोग के बारे में जानते हैं, तो चलिए शुरू करते हैं।
आरंभ करना
पाइडोक मॉड्यूल पायथन के साथ पैक किया गया है, जिसका अर्थ है कि आपको इसे अलग से डाउनलोड और इंस्टॉल करने की आवश्यकता नहीं है।
पाइडोक तक पहुंचने के लिए, आपको पहले इसे आयात करना होगा।
import pydoc
सहायता () फ़ंक्शन का उपयोग करके इंटरैक्टिव शेल तक पहुंचना
आप pydoc के हेल्प फंक्शन का उपयोग करके इंटरेक्टिव शेल को एक्सेस कर सकते हैं।
ऐसा करने के लिए, अपना टर्मिनल लॉन्च करें, और पायथन इंटरेक्टिव शेल दर्ज करें।
अब, pydoc आयात करें और फिर इंटरैक्टिव शेल लॉन्च करने के लिए pydoc.help() कमांड का उपयोग करें।
उदाहरण
>>>import pydoc >>>pydoc.help()
अब, आप मॉड्यूल का नाम, डेटाटाइप, फ़ंक्शन, कक्षाएं आदि दर्ज कर सकते हैं, ताकि इसके दस्तावेज़ीकरण को सीधे इंटरेक्टिव स्क्रिप्ट से प्राप्त किया जा सके।
ब्राउज़र से दस्तावेज़ देखना
यदि आप ब्राउज़र से दस्तावेज़ देखना चाहते हैं, तो आप pydoc का उपयोग करके ऐसा आसानी से कर सकते हैं।
इस बार, आपको अजगर शेल के माध्यम से कमांड चलाने की आवश्यकता नहीं है। इसके बजाय आप इसे तर्क प्रदान कर सकते हैं और इसे सीधे लॉन्च कर सकते हैं।
ऐसा करने के लिए, अपना टर्मिनल लॉन्च करें और निम्न कमांड टाइप करें।
python −m pydoc −b
यह ब्राउज़र पर आपके स्थानीय सिस्टम पर मौजूद सभी पायथन मॉड्यूल, फ़ंक्शंस, ऑब्जेक्ट्स के लिए दस्तावेज़ीकरण उत्पन्न करना चाहिए।
आप इस तरह से विशिष्ट खोजशब्दों को खोज और पुनः प्राप्त भी कर सकते हैं।
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(): '''Documentation using docstrings''' print(documentation.__doc__) help(documentation)
आउटपुट
Documentation using docstrings Help on function documentation in module __main__: documentation() Documentation using docstrings
निष्कर्ष
अब आप जानते हैं कि pydoc फ़ंक्शन का उपयोग करके विभिन्न पायथन कीवर्ड, फ़ंक्शन, मॉड्यूल, विधियों के ऑफ़लाइन दस्तावेज़ों को कैसे देखना और पढ़ना है।
आपने यह भी सीखा कि कैसे डॉकस्ट्रिंग का उपयोग करके अपना स्वयं का दस्तावेज़ बनाना और बनाना है।
यह जानने के लिए कि आप कहां क्या कर रहे हैं और भविष्य में बाद में भ्रम से बचने के लिए बड़े पैमाने की परियोजनाओं पर काम करते समय अच्छे दस्तावेज़ीकरण को बनाए रखना आवश्यक है। यह विभिन्न अज्ञात या रनटाइम त्रुटियों को रोकने में भी मदद करता है।