Path 1: 13 calls (0.43)

→ msgs dict (13)

→ options [] (12) _ArgumentsProvider.options_and_values def (1)

→ reports [] (12) () (1)

→ doc None (13)

→ module None (13)

→ show_options True (13)

↩ return 'Basic checker\n~~~~~~~~~~~~~\n\nVerbatim name of the checker is ``basic``.\n\nBasic checker Messages\n^^^^^^^^^^^^^^^^^^^^^^\n:basic-checker-example ...

19 run 13 not run

1def get_full_documentation(
2        self,
3        msgs: dict[str, MessageDefinitionTuple],
4        options: Iterable[tuple[str, OptionDict, Any]],
5        reports: Sequence[tuple[str, str, ReportsCallable]],
6        doc: str | None = None,
7        module: str | None = None,
8        show_options: bool = True,
9    ) -> str:
10        result = ""
11        checker_title = f"{self.name.replace('_', ' ').title()} checker"
12        if module:
13            # Provide anchor to link against
14            result += f".. _{module}:\n\n"
15        result += f"{get_rst_title(checker_title, '~')}\n"
16        if module:
17            result += f"This checker is provided by ``{module}``.\n"
18        result += f"Verbatim name of the checker is ``{self.name}``.\n\n"
19        if doc:
20            # Provide anchor to link against
21            result += get_rst_title(f"{checker_title} Documentation", "^")
22            result += f"{cleandoc(doc)}\n\n"
23        # options might be an empty generator and not be False when cast to boolean
24        options_list = list(options)
25        if options_list:
26            if show_options:
27                result += get_rst_title(f"{checker_title} Options", "^")
28                result += f"{get_rst_section(None, options_list)}\n"
29            else:
30                result += f"See also :ref:`{self.name} checker's options' documentation <{self.name}-options>`\n\n"
31        if msgs:
32            result += get_rst_title(f"{checker_title} Messages", "^")
33            for msgid, msg in sorted(
34                msgs.items(), key=lambda kv: (_MSG_ORDER.index(kv[0][0]), kv[1])
35            ):
36                msg_def = self.create_message_definition_from_tuple(msgid, msg)
37                result += f"{msg_def.format_help(checkerref=False)}\n"
38            result += "\n"
39        if reports:
40            result += get_rst_title(f"{checker_title} Reports", "^")
41            for report in reports:
42                result += (
43                    ":%s: %s\n" % report[:2]  # pylint: disable=consider-using-f-string
44                )
45            result += "\n"
46        result += "\n"
47        return result
            

Path 2: 13 calls (0.43)

→ msgs dict (13)

→ options list (12) _ArgumentsProvider.options_and_values def (1)

→ reports [] (12) () (1)

→ doc None (13)

→ module None (13)

→ show_options True (13)

↩ return 'Basic checker\n~~~~~~~~~~~~~\n\nVerbatim name of the checker is ``basic``.\n\nBasic checker Options\n^^^^^^^^^^^^^^^^^^^^^\n:example-args:\n Example...

22 run 10 not run

1def get_full_documentation(
2        self,
3        msgs: dict[str, MessageDefinitionTuple],
4        options: Iterable[tuple[str, OptionDict, Any]],
5        reports: Sequence[tuple[str, str, ReportsCallable]],
6        doc: str | None = None,
7        module: str | None = None,
8        show_options: bool = True,
9    ) -> str:
10        result = ""
11        checker_title = f"{self.name.replace('_', ' ').title()} checker"
12        if module:
13            # Provide anchor to link against
14            result += f".. _{module}:\n\n"
15        result += f"{get_rst_title(checker_title, '~')}\n"
16        if module:
17            result += f"This checker is provided by ``{module}``.\n"
18        result += f"Verbatim name of the checker is ``{self.name}``.\n\n"
19        if doc:
20            # Provide anchor to link against
21            result += get_rst_title(f"{checker_title} Documentation", "^")
22            result += f"{cleandoc(doc)}\n\n"
23        # options might be an empty generator and not be False when cast to boolean
24        options_list = list(options)
25        if options_list:
26            if show_options:
27                result += get_rst_title(f"{checker_title} Options", "^")
28                result += f"{get_rst_section(None, options_list)}\n"
29            else:
30                result += f"See also :ref:`{self.name} checker's options' documentation <{self.name}-options>`\n\n"
31        if msgs:
32            result += get_rst_title(f"{checker_title} Messages", "^")
33            for msgid, msg in sorted(
34                msgs.items(), key=lambda kv: (_MSG_ORDER.index(kv[0][0]), kv[1])
35            ):
36                msg_def = self.create_message_definition_from_tuple(msgid, msg)
37                result += f"{msg_def.format_help(checkerref=False)}\n"
38            result += "\n"
39        if reports:
40            result += get_rst_title(f"{checker_title} Reports", "^")
41            for report in reports:
42                result += (
43                    ":%s: %s\n" % report[:2]  # pylint: disable=consider-using-f-string
44                )
45            result += "\n"
46        result += "\n"
47        return result
            

Path 3: 3 calls (0.1)

→ msgs dict (3)

→ options list (3)

→ reports list (3)

→ doc None (3)

→ module None (3)

→ show_options True (3)

↩ return 'Basic checker\n~~~~~~~~~~~~~\n\nVerbatim name of the checker is ``basic``.\n\nBasic checker Options\n^^^^^^^^^^^^^^^^^^^^^\n:no-docstring-rgx:\n Reg...

27 run 5 not run

1def get_full_documentation(
2        self,
3        msgs: dict[str, MessageDefinitionTuple],
4        options: Iterable[tuple[str, OptionDict, Any]],
5        reports: Sequence[tuple[str, str, ReportsCallable]],
6        doc: str | None = None,
7        module: str | None = None,
8        show_options: bool = True,
9    ) -> str:
10        result = ""
11        checker_title = f"{self.name.replace('_', ' ').title()} checker"
12        if module:
13            # Provide anchor to link against
14            result += f".. _{module}:\n\n"
15        result += f"{get_rst_title(checker_title, '~')}\n"
16        if module:
17            result += f"This checker is provided by ``{module}``.\n"
18        result += f"Verbatim name of the checker is ``{self.name}``.\n\n"
19        if doc:
20            # Provide anchor to link against
21            result += get_rst_title(f"{checker_title} Documentation", "^")
22            result += f"{cleandoc(doc)}\n\n"
23        # options might be an empty generator and not be False when cast to boolean
24        options_list = list(options)
25        if options_list:
26            if show_options:
27                result += get_rst_title(f"{checker_title} Options", "^")
28                result += f"{get_rst_section(None, options_list)}\n"
29            else:
30                result += f"See also :ref:`{self.name} checker's options' documentation <{self.name}-options>`\n\n"
31        if msgs:
32            result += get_rst_title(f"{checker_title} Messages", "^")
33            for msgid, msg in sorted(
34                msgs.items(), key=lambda kv: (_MSG_ORDER.index(kv[0][0]), kv[1])
35            ):
36                msg_def = self.create_message_definition_from_tuple(msgid, msg)
37                result += f"{msg_def.format_help(checkerref=False)}\n"
38            result += "\n"
39        if reports:
40            result += get_rst_title(f"{checker_title} Reports", "^")
41            for report in reports:
42                result += (
43                    ":%s: %s\n" % report[:2]  # pylint: disable=consider-using-f-string
44                )
45            result += "\n"
46        result += "\n"
47        return result
            

Path 4: 1 calls (0.03)

→ msgs {} (1)

→ options [] (1)

→ reports list (1)

→ doc None (1)

→ module None (1)

→ show_options True (1)

↩ return 'Metrics checker\n~~~~~~~~~~~~~~~\n\nVerbatim name of the checker is ``metrics``.\n\nMetrics checker Reports\n^^^^^^^^^^^^^^^^^^^^^^^\n:RP0701: Raw me...

18 run 14 not run

1def get_full_documentation(
2        self,
3        msgs: dict[str, MessageDefinitionTuple],
4        options: Iterable[tuple[str, OptionDict, Any]],
5        reports: Sequence[tuple[str, str, ReportsCallable]],
6        doc: str | None = None,
7        module: str | None = None,
8        show_options: bool = True,
9    ) -> str:
10        result = ""
11        checker_title = f"{self.name.replace('_', ' ').title()} checker"
12        if module:
13            # Provide anchor to link against
14            result += f".. _{module}:\n\n"
15        result += f"{get_rst_title(checker_title, '~')}\n"
16        if module:
17            result += f"This checker is provided by ``{module}``.\n"
18        result += f"Verbatim name of the checker is ``{self.name}``.\n\n"
19        if doc:
20            # Provide anchor to link against
21            result += get_rst_title(f"{checker_title} Documentation", "^")
22            result += f"{cleandoc(doc)}\n\n"
23        # options might be an empty generator and not be False when cast to boolean
24        options_list = list(options)
25        if options_list:
26            if show_options:
27                result += get_rst_title(f"{checker_title} Options", "^")
28                result += f"{get_rst_section(None, options_list)}\n"
29            else:
30                result += f"See also :ref:`{self.name} checker's options' documentation <{self.name}-options>`\n\n"
31        if msgs:
32            result += get_rst_title(f"{checker_title} Messages", "^")
33            for msgid, msg in sorted(
34                msgs.items(), key=lambda kv: (_MSG_ORDER.index(kv[0][0]), kv[1])
35            ):
36                msg_def = self.create_message_definition_from_tuple(msgid, msg)
37                result += f"{msg_def.format_help(checkerref=False)}\n"
38            result += "\n"
39        if reports:
40            result += get_rst_title(f"{checker_title} Reports", "^")
41            for report in reports:
42                result += (
43                    ":%s: %s\n" % report[:2]  # pylint: disable=consider-using-f-string
44                )
45            result += "\n"
46        result += "\n"
47        return result