eric: comparison Plugins/CheckerPlugins/CodeStyleChecker/DocStyleChecker.py

-:e67c1c4f4abb
+:34041e56ec42
 "D203", "D205",
 "D221", "D222",
 "D231", "D232", "D234", "D235", "D236", "D237", "D238", "D239",
 "D242", "D243", "D244", "D245", "D246", "D247",
-"D250", "D251",
+"D250", "D251", "D252", "D253",
+"D260", "D261", "D262", "D263",
 "D901",
 ]
 def __init__(self, source, filename, select, ignore, expected, repeat,
 ],
 "classDocstring": [
 (self.__checkClassDocstring, ("D104", "D205")),
 (self.__checkEricNoBlankBeforeAndAfterClassOrFunction,
 ("D242", "D243")),
+(self.__checkEricSignal, ("D260", "D261", "D262", "D263")),
 ],
 "methodDocstring": [
 (self.__checkEricSummary, ("D232")),
 ],
 "defDocstring": [
 (self.__checkEricReturn, ("D234", "D235")),
 (self.__checkEricFunctionArguments,
 ("D236", "D237", "D238", "D239")),
 (self.__checkEricNoBlankBeforeAndAfterClassOrFunction,
 ("D244", "D245")),
-(self.__checkEricException, ("D250", "D251")),
+(self.__checkEricException,
+("D250", "D251", "D252", "D253")),
 ],
 "docstring": [
 (self.__checkTripleDoubleQuotes, ("D111",)),
 (self.__checkBackslashes, ("D112",)),
 (self.__checkUnicode, ("D113",)),
 def __checkEricException(self, docstringContext, context):
 """
 Private method to check, that docstrings contain an &#64;exception line
 if they raise an exception and don't otherwise.
+Note: This method also checks the raised and documented exceptions for
+completeness (i.e. raised exceptions that are not documented or
+documented exceptions that are not raised)
 @param docstringContext docstring context (DocStyleContext)
 @param context context of the docstring (DocStyleContext)
 """
 if docstringContext is None:
 return
 tokens = list(
 tokenize.generate_tokens(StringIO(context.ssource()).readline))
-exception = [tokens[i + 1][0] for i, token in enumerate(tokens)
+exceptions = set()
-if token[1] == "raise"]
+raisedExceptions = set()
+tokensLen = len(tokens)
+for i, token in enumerate(tokens):
+if token[1] == "raise":
+exceptions.add(tokens[i + 1][0])
+if tokens[i + 1][0] == tokenize.NAME:
+if tokensLen > (i + 2) and \
+tokens[i + 2][1] == ".":
+raisedExceptions.add("{0}.{1}".format(
+tokens[i + 1][1], tokens[i + 3][1]))
+else:
+raisedExceptions.add(tokens[i + 1][1])
 if "@exception" not in docstringContext.ssource() and \
 "@throws" not in docstringContext.ssource() and \
 "@raise" not in docstringContext.ssource():
-if (set(exception) -
+if (exceptions -
 {tokenize.COMMENT, tokenize.NL, tokenize.NEWLINE} !=
 set()):
 self.__error(docstringContext.end(), 0, "D250")
 else:
-if (set(exception) -
+if (exceptions -
 {tokenize.COMMENT, tokenize.NL, tokenize.NEWLINE} ==
 set()):
 self.__error(docstringContext.end(), 0, "D251")
+else:
+# step 1: extract documented exceptions
+documentedExceptions = set()
+for line in docstringContext.source():
+line = line.strip()
+if line.startswith(("@exception", "@throws", "@raise")):
+exceptionTokens = line.split(None, 2)
+if len(exceptionTokens) >= 2:
+documentedExceptions.add(exceptionTokens[1])
+# step 2: report undocumented exceptions
+for exception in raisedExceptions:
+if exception not in documentedExceptions:
+self.__error(docstringContext.end(), 0, "D252",
+exception)
+# step 3: report undefined signals
+for exception in documentedExceptions:
+if exception not in raisedExceptions:
+self.__error(docstringContext.end(), 0, "D253",
+exception)
+def __checkEricSignal(self, docstringContext, context):
+"""
+Private method to check, that docstrings contain an &#64;signal line
+if they define signals and don't otherwise.
+Note: This method also checks the defined and documented signals for
+completeness (i.e. defined signals that are not documented or
+documented signals that are not defined)
+@param docstringContext docstring context (DocStyleContext)
+@param context context of the docstring (DocStyleContext)
+"""
+if docstringContext is None:
+return
+tokens = list(
+tokenize.generate_tokens(StringIO(context.ssource()).readline))
+definedSignals = set()
+for i, token in enumerate(tokens):
+if token[1] in ("pyqtSignal", "Signal"):
+if tokens[i - 1][1] == "." and tokens[i - 2][1] == "QtCore":
+definedSignals.add(tokens[i - 4][1])
+elif tokens[i - 1][1] == "=":
+definedSignals.add(tokens[i - 2][1])
+if "@signal" not in docstringContext.ssource() and definedSignals:
+self.__error(docstringContext.end(), 0, "D260")
+elif "@signal" in docstringContext.ssource():
+if not definedSignals:
+self.__error(docstringContext.end(), 0, "D261")
+else:
+# step 1: extract documented signals
+documentedSignals = set()
+for line in docstringContext.source():
+line = line.strip()
+if line.startswith("@signal"):
+signalTokens = line.split(None, 2)
+if len(signalTokens) >= 2:
+signal = signalTokens[1]
+if "(" in signal:
+signal = signal.split("(", 1)[0]
+documentedSignals.add(signal)
+# step 2: report undocumented signals
+for signal in definedSignals:
+if signal not in documentedSignals:
+self.__error(docstringContext.end(), 0, "D262", signal)
+# step 3: report undefined signals
+for signal in documentedSignals:
+if signal not in definedSignals:
+self.__error(docstringContext.end(), 0, "D263", signal)
 def __checkEricBlankAfterSummary(self, docstringContext, context):
 """
 Private method to check, that docstring summaries are followed
 by a blank line.

Mercurial Repositories > eric / file comparison

comparison: Plugins/CheckerPlugins/CodeStyleChecker/DocStyleChecker.py

Plugins/CheckerPlugins/CodeStyleChecker/DocStyleChecker.py