diff options
| author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2019-06-09 23:01:01 +0200 |
|---|---|---|
| committer | Claudiu Popa <pcmanticore@gmail.com> | 2019-06-20 14:09:59 +0200 |
| commit | b398aafa99c144d60c7f5498ef3e150c0e12ec7e (patch) | |
| tree | 0d13fe01a2a8f78353b73456e4fe2ffa2ffd180d /doc/exts | |
| parent | 75e28a196b7025e1950c1ddd5437f6cdd837d098 (diff) | |
| download | pylint-git-b398aafa99c144d60c7f5498ef3e150c0e12ec7e.tar.gz | |
Refactor - Give a checker instead of a string to _print_checker_doc
Will permit to move functions in the BaseChecker class later.
Diffstat (limited to 'doc/exts')
| -rwxr-xr-x | doc/exts/pylint_extensions.py | 30 |
1 files changed, 14 insertions, 16 deletions
diff --git a/doc/exts/pylint_extensions.py b/doc/exts/pylint_extensions.py index dd660767c..016ba6f54 100755 --- a/doc/exts/pylint_extensions.py +++ b/doc/exts/pylint_extensions.py @@ -65,14 +65,13 @@ def builder_inited(app): "\n load-plugins=pylint.extensions.docparams," "pylint.extensions.docstyle\n\n" ) - by_module = get_plugins_info(linter, doc_files) - for module, info in sorted(by_module.items()): - linter._print_checker_doc(info["name"], info, stream=stream) + by_checker = get_plugins_info(linter, doc_files) + for checker, info in sorted(by_checker.items()): + linter._print_checker_doc(checker, info, stream=stream) def get_plugins_info(linter, doc_files): - by_module = {} - + by_checker = {} for checker in linter.get_checkers(): if checker.name == "master": continue @@ -80,23 +79,23 @@ def get_plugins_info(linter, doc_files): # Plugins only - skip over core checkers if re.match("pylint.checkers", module): continue - # Find any .rst documentation associated with this plugin doc = "" doc_file = doc_files.get(module) if doc_file: with open(doc_file, "r") as f: doc = f.read() - try: - by_module[module]["options"] += checker.options_and_values() - by_module[module]["msgs"].update(checker.msgs) - by_module[module]["reports"] += checker.reports - by_module[module]["doc"] += doc - by_module[module]["name"] += checker.name - by_module[module]["module"] += module + by_checker[checker]["checker"] = checker + by_checker[checker]["options"] += checker.options_and_values() + by_checker[checker]["msgs"].update(checker.msgs) + by_checker[checker]["reports"] += checker.reports + by_checker[checker]["doc"] += doc + by_checker[checker]["name"] += checker.name + by_checker[checker]["module"] += module except KeyError: - by_module[module] = { + by_checker[checker] = { + "checker": checker, "options": list(checker.options_and_values()), "msgs": dict(checker.msgs), "reports": list(checker.reports), @@ -104,8 +103,7 @@ def get_plugins_info(linter, doc_files): "name": checker.name, "module": module, } - - return by_module + return by_checker def setup(app): |