डॉकस्ट्रिंग कवरेज - प्रलेखन के साथ अजगर कोड को कवर करना

यह कैसे सत्यापित करें कि अजगर डेवलपर्स (या स्वयं) ने कोड को अच्छी तरह से प्रलेखित किया है, सिवाय हाथ से सब कुछ ब्राउज़ करने या pydoc में प्रलेखन उत्पन्न करने और स्रोत के साथ तुलना करने के अलावा? इसलिए मुझे तब तक कोई समाधान नहीं मिला जब तक कि मैं गलती से एक पुरानी-पुरानी लिपि में नहीं आ गया जिसने मुझे कांटा और उसके बाद के सरल शोधन के लिए प्रेरित किया।

नतीजतन, मुझे एक सरल और उपयोगी (कम से कम मेरे लिए :)) डॉकस्ट्रिंग कवरेज टूल मिला जो आपको पूरे प्रोजेक्ट के लिए दस्तावेज़ के साथ कोड के प्रतिशत कवरेज का अनुमान लगाने की अनुमति देता है।



यह इस तरह शुरू होता है:

docstring-coverage [] <    > 

आउटपुट उदाहरण:

 $ docstring-coverage docstring-coverage/ File docstring-coverage/setup.py - No module dostring! Needed: 1; Exist: 0; Missing: 1; Coverage: 0.0% File docstring-coverage/docstringcoverage/__init__.py - No module dostring! Needed: 1; Exist: 0; Missing: 1; Coverage: 0.0% File docstring-coverage/docstringcoverage/cover.py - No docstring for DocStringCoverageVisitor! - No docstring for DocStringCoverageVisitor.__init__! - No docstring for DocStringCoverageVisitor.visitModule! - No docstring for DocStringCoverageVisitor.visitClass! - No docstring for DocStringCoverageVisitor.visitFunction! - No docstring for DocStringCoverageVisitor.getResult! - No docstring for get_docstring_coverage.printDocstring! Needed: 11; Exist: 4; Missing: 7; Coverage: 36.4% Overall statistics for 3 files: Docstrings needed: 13; Docstrings exist: 4; Docstrings missing: 9 Total docstring coverage: 30.8%; Grade: not so good 

विकल्पों में से -m है, जो उपयोगिता को __magic__ पायथन और -v तरीकों को छोड़ने के लिए मजबूर करता है, जो आपको 0 से 3 तक आउटपुट के "बातूनीपन" के स्तर को समायोजित करने की अनुमति देता है।

यदि आप चाहें, तो आप कवरेज पर आंकड़े प्राप्त करने के लिए उपयोग करने के लिए एक कार्य मसौदे में आयात कर सकते हैं:

 import docstringcoverage cover_results = docstringcoverage.get_docstring_coverage(['somefolder/somefile.py']) 

सूची के दो तत्वों के साथ एक सूची के रूप में सुझाव दिया गया:

 [ {'< >': { 'missing': ["< ,   ","..."], 'module_doc': <True or False>, #     'missing_count': <missing_count>, #   'needed_count': <needed_docstrings_count>, #     'coverage': <percent_of_coverage>, #  'empty': <True or False> #True,    #( , ,   ) }, ... }, #   { 'missing_count': <total_missing_count>, 'needed_count': <total_needed_docstrings_count>, 'coverage': <total_percent_of_coverage>, } 

उदाहरण के साथ सभी प्रलेखन परियोजना पृष्ठ पर है।