पायथन डॉकस्ट्रिंग: बढ़ाएं बनाम

Question

मैं पाइचर्म आईडीई का उपयोग करता हूं जो PEP0257-compliant docstrings को क्राफ्ट करने में सहायता करता है। यह दो गुण प्रदान करता है मैं पूरी तरह से बीच के अंतर/उपयोग समझ में नहीं आता:

• :raise Exception: exception explanation here
• :raises Exception: exception explanation here

मैं raise का प्रयोग करेंगे जब के रूप में मेरे docstring में raises करने का विरोध करता है? विशेष रूप से, यदि किसी वर्ग को एक तर्क की आवश्यकता होती है जो प्रदान नहीं की गई थी और TypeError उठाती है, जिसका उपयोग दस्तावेज़ के लिए किया जाना चाहिए?

Answer 1

टी एल; डॉ

raises वर्णन करने के लिए संभव अपवाद उठाया जा रहा प्रयोग किया जाता है। raiseSphinx द्वारा ऑटोडोक चलाते समय पहचाना जाता है और raises जैसा ही होता है।

पूर्ण स्पष्टीकरण

PyCharm टिप्पणी docstring के कुछ ही विभिन्न शैलियों का उपयोग करने में मदद करता है।

तीन जो मैं अक्सर उपयोग कर रहे हैं:

1. NumPy Format
2. Google Format
3. Sphinx (एक प्रारूप की तुलना में अधिक)

इन सब में Raises के लिए एक विशेष खंड है जो आप PyCharm कोड परीक्षण के पुराने संस्करण में देख सकते हैं:

1. Simple NumPy
2. Simple Google

SphinxDocString के लिए कार्यान्वयन हम कर सकते हैं see here वहाँ कई खोजशब्द जो पहचाना जा सकता है कर रहे हैं। वे टैग RAISES_TAGS की सूची से लिंक करते हैं जो here पाया जा सकता है।

मुझे आशा है कि यह जानकारी उपयोगी है।