Merge lp:~zomux/twistedchecker/make-epydoc-optional into lp:~twistedchecker-dev/twistedchecker/trunk

[raphael shu]

Added an option 'strict-epydoc' for enabling checking '@type' and '@rtype' in docstring.

[lp:~zomux/twistedchecker/make-epydoc-optional]

29. By raphael shu on 2012-08-20

make sure a method has return value when warn 'missing @return'

[Jonathan Lange (jml)]

Great :)

review: Approve

=== modified file 'twistedchecker/checkers/docstring.py'
--- twistedchecker/checkers/docstring.py	2012-07-24 13:40:33 +0000
+++ twistedchecker/checkers/docstring.py	2012-08-20 04:17:22 +0000
@@ -161,7 +161,7 @@
         """
         returnFound = False
         for subnode in node.body:
-            if type(subnode) == node_classes.Return:
+            if type(subnode) == node_classes.Return and subnode.value:
                 returnFound = True
                 break
         return returnFound

=== modified file 'twistedchecker/core/runner.py'
--- twistedchecker/core/runner.py	2012-08-17 08:32:52 +0000
+++ twistedchecker/core/runner.py	2012-08-20 04:17:22 +0000
@@ -18,6 +18,7 @@
     """
     outputStream = None
     linter = None
+    allowOptions = None
     # Customized checkers.
     checkers = ("header.HeaderChecker",
                 "modulename.ModuleNameChecker",
@@ -39,6 +40,7 @@
         """
         Initialize C{PyLinter} object, and load configuration file.
         """
+        self.allowOptions = True
         self.linter = PyLinter(self._makeOptions())
         # register standard checkers.
         self.linter.load_default_plugins()
@@ -61,7 +63,6 @@
         self.setOutput(sys.stdout)
         # set default reporter to limited reporter
         self.setReporter(LimitedReporter(allowedMessages))
-        
 
 
     def _makeOptions(self):
@@ -76,6 +77,11 @@
               "help": "Set comparing result file to automatically "
                       "generate a diff."}
             ),
+            ('strict-epydoc',
+             {'type': 'yn', 'metavar': '<y_or_n>',
+              'default': False,
+              'help': "Check '@type' and '@rtype' in epydoc."}
+            ),
           )
 
 
@@ -296,6 +302,9 @@
             raise
         if not args:
             self.displayHelp()
+        # Check for 'strict-epydoc' option.
+        if self.allowOptions and not self.linter.option_value("strict-epydoc"):
+            map(self.linter.disable, ["W9203", "W9205"])
         # check for diff option.
         if self.diffOption:
             self.prepareDiff()

=== modified file 'twistedchecker/functionaltests/docstring_pass.py'
--- twistedchecker/functionaltests/docstring_pass.py	2012-07-18 05:19:07 +0000
+++ twistedchecker/functionaltests/docstring_pass.py	2012-08-20 04:17:22 +0000
@@ -55,3 +55,10 @@
         """
         def k():
             pass
+
+
+    def f(self):
+        """
+        A method returns nothing.
+        """
+        return

=== modified file 'twistedchecker/test/test_runner.py'
--- twistedchecker/test/test_runner.py	2012-08-17 08:32:52 +0000
+++ twistedchecker/test/test_runner.py	2012-08-20 04:17:22 +0000
@@ -214,6 +214,7 @@
                        msg="could not find resultfile:\n%s" % pathResultFile)
             self.clearOutputStream()
             runner = Runner()
+            runner.allowOptions = False
             runner.setOutput(self.outputStream)
             # set the reporter to C{twistedchecker.reporters.test.TestReporter}
             runner.setReporter(TestReporter())