Method: pylint.extensions.docparams.DocstringParameterChecker.visit_return
Calls: 131, Exceptions: 0, Paths: 8Back
Path 1: 85 calls (0.65)
Return (85)
None (85)
1def visit_return(self, node: nodes.Return) -> None:
2 if not utils.returns_something(node):
3 return
4
5 if self.linter.config.accept_no_return_doc:
6 return
7
8 func_node: astroid.FunctionDef = node.frame(future=True)
9
10 # skip functions that match the 'no-docstring-rgx' config option
11 no_docstring_rgx = self.linter.config.no_docstring_rgx
12 if no_docstring_rgx and re.match(no_docstring_rgx, func_node.name):
13 return
14
15 doc = utils.docstringify(
16 func_node.doc_node, self.linter.config.default_docstring_type
17 )
18
19 is_property = checker_utils.decorated_with_property(func_node)
20
21 if not (doc.has_returns() or (doc.has_property_returns() and is_property)):
22 self.add_message("missing-return-doc", node=func_node, confidence=HIGH)
23
24 if func_node.returns:
25 return
26
27 if not (doc.has_rtype() or (doc.has_property_type() and is_property)):
28 self.add_message("missing-return-type-doc", node=func_node, confidence=HIGH)
Path 2: 12 calls (0.09)
Return (12)
None (12)
1def visit_return(self, node: nodes.Return) -> None:
2 if not utils.returns_something(node):
3 return
4
5 if self.linter.config.accept_no_return_doc:
6 return
7
8 func_node: astroid.FunctionDef = node.frame(future=True)
9
10 # skip functions that match the 'no-docstring-rgx' config option
11 no_docstring_rgx = self.linter.config.no_docstring_rgx
12 if no_docstring_rgx and re.match(no_docstring_rgx, func_node.name):
13 return
14
15 doc = utils.docstringify(
16 func_node.doc_node, self.linter.config.default_docstring_type
17 )
18
19 is_property = checker_utils.decorated_with_property(func_node)
20
21 if not (doc.has_returns() or (doc.has_property_returns() and is_property)):
22 self.add_message("missing-return-doc", node=func_node, confidence=HIGH)
23
24 if func_node.returns:
25 return
26
27 if not (doc.has_rtype() or (doc.has_property_type() and is_property)):
28 self.add_message("missing-return-type-doc", node=func_node, confidence=HIGH)
Path 3: 12 calls (0.09)
Return (12)
None (12)
1def visit_return(self, node: nodes.Return) -> None:
2 if not utils.returns_something(node):
3 return
4
5 if self.linter.config.accept_no_return_doc:
6 return
7
8 func_node: astroid.FunctionDef = node.frame(future=True)
9
10 # skip functions that match the 'no-docstring-rgx' config option
11 no_docstring_rgx = self.linter.config.no_docstring_rgx
12 if no_docstring_rgx and re.match(no_docstring_rgx, func_node.name):
13 return
14
15 doc = utils.docstringify(
16 func_node.doc_node, self.linter.config.default_docstring_type
17 )
18
19 is_property = checker_utils.decorated_with_property(func_node)
20
21 if not (doc.has_returns() or (doc.has_property_returns() and is_property)):
22 self.add_message("missing-return-doc", node=func_node, confidence=HIGH)
23
24 if func_node.returns:
25 return
26
27 if not (doc.has_rtype() or (doc.has_property_type() and is_property)):
28 self.add_message("missing-return-type-doc", node=func_node, confidence=HIGH)
Path 4: 9 calls (0.07)
Return (9)
1def visit_return(self, node: nodes.Return) -> None:
2 if not utils.returns_something(node):
3 return
4
5 if self.linter.config.accept_no_return_doc:
6 return
7
8 func_node: astroid.FunctionDef = node.frame(future=True)
9
10 # skip functions that match the 'no-docstring-rgx' config option
11 no_docstring_rgx = self.linter.config.no_docstring_rgx
12 if no_docstring_rgx and re.match(no_docstring_rgx, func_node.name):
13 return
14
15 doc = utils.docstringify(
16 func_node.doc_node, self.linter.config.default_docstring_type
17 )
18
19 is_property = checker_utils.decorated_with_property(func_node)
20
21 if not (doc.has_returns() or (doc.has_property_returns() and is_property)):
22 self.add_message("missing-return-doc", node=func_node, confidence=HIGH)
23
24 if func_node.returns:
25 return
26
27 if not (doc.has_rtype() or (doc.has_property_type() and is_property)):
28 self.add_message("missing-return-type-doc", node=func_node, confidence=HIGH)
Path 5: 6 calls (0.05)
Return (6)
1def visit_return(self, node: nodes.Return) -> None:
2 if not utils.returns_something(node):
3 return
4
5 if self.linter.config.accept_no_return_doc:
6 return
7
8 func_node: astroid.FunctionDef = node.frame(future=True)
9
10 # skip functions that match the 'no-docstring-rgx' config option
11 no_docstring_rgx = self.linter.config.no_docstring_rgx
12 if no_docstring_rgx and re.match(no_docstring_rgx, func_node.name):
13 return
14
15 doc = utils.docstringify(
16 func_node.doc_node, self.linter.config.default_docstring_type
17 )
18
19 is_property = checker_utils.decorated_with_property(func_node)
20
21 if not (doc.has_returns() or (doc.has_property_returns() and is_property)):
22 self.add_message("missing-return-doc", node=func_node, confidence=HIGH)
23
24 if func_node.returns:
25 return
26
27 if not (doc.has_rtype() or (doc.has_property_type() and is_property)):
28 self.add_message("missing-return-type-doc", node=func_node, confidence=HIGH)
Path 6: 5 calls (0.04)
Return (5)
1def visit_return(self, node: nodes.Return) -> None:
2 if not utils.returns_something(node):
3 return
4
5 if self.linter.config.accept_no_return_doc:
6 return
7
8 func_node: astroid.FunctionDef = node.frame(future=True)
9
10 # skip functions that match the 'no-docstring-rgx' config option
11 no_docstring_rgx = self.linter.config.no_docstring_rgx
12 if no_docstring_rgx and re.match(no_docstring_rgx, func_node.name):
13 return
14
15 doc = utils.docstringify(
16 func_node.doc_node, self.linter.config.default_docstring_type
17 )
18
19 is_property = checker_utils.decorated_with_property(func_node)
20
21 if not (doc.has_returns() or (doc.has_property_returns() and is_property)):
22 self.add_message("missing-return-doc", node=func_node, confidence=HIGH)
23
24 if func_node.returns:
25 return
26
27 if not (doc.has_rtype() or (doc.has_property_type() and is_property)):
28 self.add_message("missing-return-type-doc", node=func_node, confidence=HIGH)
Path 7: 1 calls (0.01)
Return (1)
None (1)
1def visit_return(self, node: nodes.Return) -> None:
2 if not utils.returns_something(node):
3 return
4
5 if self.linter.config.accept_no_return_doc:
6 return
7
8 func_node: astroid.FunctionDef = node.frame(future=True)
9
10 # skip functions that match the 'no-docstring-rgx' config option
11 no_docstring_rgx = self.linter.config.no_docstring_rgx
12 if no_docstring_rgx and re.match(no_docstring_rgx, func_node.name):
13 return
14
15 doc = utils.docstringify(
16 func_node.doc_node, self.linter.config.default_docstring_type
17 )
18
19 is_property = checker_utils.decorated_with_property(func_node)
20
21 if not (doc.has_returns() or (doc.has_property_returns() and is_property)):
22 self.add_message("missing-return-doc", node=func_node, confidence=HIGH)
23
24 if func_node.returns:
25 return
26
27 if not (doc.has_rtype() or (doc.has_property_type() and is_property)):
28 self.add_message("missing-return-type-doc", node=func_node, confidence=HIGH)
Path 8: 1 calls (0.01)
Return (1)
None (1)
1def visit_return(self, node: nodes.Return) -> None:
2 if not utils.returns_something(node):
3 return
4
5 if self.linter.config.accept_no_return_doc:
6 return
7
8 func_node: astroid.FunctionDef = node.frame(future=True)
9
10 # skip functions that match the 'no-docstring-rgx' config option
11 no_docstring_rgx = self.linter.config.no_docstring_rgx
12 if no_docstring_rgx and re.match(no_docstring_rgx, func_node.name):
13 return
14
15 doc = utils.docstringify(
16 func_node.doc_node, self.linter.config.default_docstring_type
17 )
18
19 is_property = checker_utils.decorated_with_property(func_node)
20
21 if not (doc.has_returns() or (doc.has_property_returns() and is_property)):
22 self.add_message("missing-return-doc", node=func_node, confidence=HIGH)
23
24 if func_node.returns:
25 return
26
27 if not (doc.has_rtype() or (doc.has_property_type() and is_property)):
28 self.add_message("missing-return-type-doc", node=func_node, confidence=HIGH)