Support pydocstyle configuration (#302)

Author: gatesn

pyls/plugins/pydocstyle_lint.py

@@ -1,6 +1,8 @@
 # Copyright 2017 Palantir Technologies, Inc.
 import contextlib
 import logging
+import os
+import re
 import sys
 
 import pydocstyle
@@ -12,6 +14,9 @@
 pydocstyle_logger = logging.getLogger(pydocstyle.utils.__name__)
 pydocstyle_logger.setLevel(logging.INFO)
 
+DEFAULT_MATCH_RE = pydocstyle.config.ConfigurationParser.DEFAULT_MATCH_RE
+DEFAULT_MATCH_DIR_RE = pydocstyle.config.ConfigurationParser.DEFAULT_MATCH_DIR_RE
+
 
 @hookimpl
 def pyls_settings():
@@ -20,10 +25,39 @@ def pyls_settings():
 
 
 @hookimpl
-def pyls_lint(document):
-    conf = pydocstyle.config.ConfigurationParser()
+def pyls_lint(config, document):
+    settings = config.plugin_settings('pydocstyle')
+    log.debug("Got pydocstyle settings: %s", settings)
+
+    # Explicitly passing a path to pydocstyle means it doesn't respect the --match flag, so do it ourselves
+    filename_match_re = re.compile(settings.get('match', DEFAULT_MATCH_RE) + '$')
+    if not filename_match_re.match(os.path.basename(document.path)):
+        return []
+
+    # Likewise with --match-dir
+    dir_match_re = re.compile(settings.get('matchDir', DEFAULT_MATCH_DIR_RE) + '$')
+    if not dir_match_re.match(os.path.basename(os.path.dirname(document.path))):
+        return []
+
+    args = [document.path]
 
-    with _patch_sys_argv([document.path]):
+    if settings.get('convention'):
+        args.append('--convention=' + settings['convention'])
+
+        if settings.get('addSelect'):
+            args.append('--add-select=' + ','.join(settings['addSelect']))
+        if settings.get('addIgnore'):
+            args.append('--add-ignore=' + ','.join(settings['addIgnore']))
+
+    elif settings.get('select'):
+        args.append('--select=' + ','.join(settings['select']))
+    elif settings.get('ignore'):
+        args.append('--ignore=' + ','.join(settings['ignore']))
+
+    log.info("Using pydocstyle args: %s", args)
+
+    conf = pydocstyle.config.ConfigurationParser()
+    with _patch_sys_argv(args):
         # TODO(gatesn): We can add more pydocstyle args here from our pyls config
         conf.parse()
 

test/plugins/test_pydocstyle_lint.py

@@ -1,9 +1,12 @@
 # Copyright 2017 Palantir Technologies, Inc.
+import os
 from pyls import lsp, uris
 from pyls.workspace import Document
 from pyls.plugins import pydocstyle_lint
 
-DOC_URI = uris.from_fs_path(__file__)
+DOC_URI = uris.from_fs_path(os.path.join(os.path.dirname(__file__), "pydocstyle.py"))
+TEST_DOC_URI = uris.from_fs_path(__file__)
+
 DOC = """import sys
 
 def hello():
@@ -13,9 +16,9 @@ def hello():
 """
 
 
-def test_pydocstyle():
+def test_pydocstyle(config):
     doc = Document(DOC_URI, DOC)
-    diags = pydocstyle_lint.pyls_lint(doc)
+    diags = pydocstyle_lint.pyls_lint(config, doc)
 
     assert all([d['source'] == 'pydocstyle' for d in diags])
 
@@ -32,15 +35,22 @@ def test_pydocstyle():
     }
 
 
-def test_pydocstyle_empty_source():
+def test_pydocstyle_test_document(config):
+    # The default --match argument excludes test_* documents.
+    doc = Document(TEST_DOC_URI, "")
+    diags = pydocstyle_lint.pyls_lint(config, doc)
+    assert not diags
+
+
+def test_pydocstyle_empty_source(config):
     doc = Document(DOC_URI, "")
-    diags = pydocstyle_lint.pyls_lint(doc)
+    diags = pydocstyle_lint.pyls_lint(config, doc)
     assert diags[0]['message'] == 'D100: Missing docstring in public module'
     assert len(diags) == 1
 
 
-def test_pydocstyle_invalid_source():
+def test_pydocstyle_invalid_source(config):
     doc = Document(DOC_URI, "bad syntax")
-    diags = pydocstyle_lint.pyls_lint(doc)
+    diags = pydocstyle_lint.pyls_lint(config, doc)
     # We're unable to parse the file, so can't get any pydocstyle diagnostics
     assert not diags

vscode-client/package.json

@@ -131,6 +131,61 @@
                     "default": false,
                     "description": "Enable or disable the plugin."
                 },
+                "pyls.plugins.pydocstyle.convention": {
+                    "type": "string",
+                    "default": null,
+                    "enum": [
+                        "pep257",
+                        "numpy"
+                    ],
+                    "description": "Choose the basic list of checked errors by specifying an existing convention."
+                },
+                "pyls.plugins.pydocstyle.addIgnore": {
+                    "type": "array",
+                    "default": null,
+                    "items": {
+                        "type": "string"
+                    },
+                    "uniqueItems": true,
+                    "description": "Ignore errors and warnings in addition to the specified convention."
+                },
+                "pyls.plugins.pydocstyle.addSelect": {
+                    "type": "array",
+                    "default": null,
+                    "items": {
+                        "type": "string"
+                    },
+                    "uniqueItems": true,
+                    "description": "Select errors and warnings in addition to the specified convention."
+                },
+                "pyls.plugins.pydocstyle.ignore": {
+                    "type": "array",
+                    "default": null,
+                    "items": {
+                        "type": "string"
+                    },
+                    "uniqueItems": true,
+                    "description": "Ignore errors and warnings"
+                },
+                "pyls.plugins.pydocstyle.select": {
+                    "type": "array",
+                    "default": null,
+                    "items": {
+                        "type": "string"
+                    },
+                    "uniqueItems": true,
+                    "description": "Select errors and warnings"
+                },
+                "pyls.plugins.pydocstyle.match": {
+                    "type": "string",
+                    "default": "(?!test_).*\\.py",
+                    "description": "Check only files that exactly match the given regular expression; default is to match files that don't start with 'test_' but end with '.py'."
+                },
+                "pyls.plugins.pydocstyle.matchDir": {
+                    "type": "string",
+                    "default": "[^\\.].*",
+                    "description": "Search only dirs that exactly match the given regular expression; default is to match dirs which do not begin with a dot."
+                },
                 "pyls.plugins.pyflakes.enabled": {
                     "type": "boolean",
                     "default": true,