Merge develop

Author: masad-frost

CHANGELOG.md

@@ -1,13 +1,24 @@
 # History of changes
 
+## Version 1.4.1 (2022/03/27)
+
+### Pull Requests Merged
+
+* [PR 179](https://github.com/python-lsp/python-lsp-server/pull/179) - Fix Yapf formatting with CRLF line endings, by [@ccordoba12](https://github.com/ccordoba12)
+* [PR 174](https://github.com/python-lsp/python-lsp-server/pull/174) - Improved documentation regarding configuration, by [@spookylukey](https://github.com/spookylukey)
+
+In this release 2 pull requests were closed.
+
+----
+
+## Version 1.4.0 (2022/03/11)
+
 ### New features
 
 * Support pycodestyle indent-size option
 * Add `DiagnosticTag` constants from LSP 3.15
 * Drop support for Python 3.6
 
-## Version 1.4.0 (2022/03/11)
-
 ### Issues Closed
 
 * [Issue 153](https://github.com/python-lsp/python-lsp-server/issues/153) - Plugin crash crashes whole diagnostic ([PR 158](https://github.com/python-lsp/python-lsp-server/pull/158) by [@ccordoba12](https://github.com/ccordoba12))

CONFIGURATION.md

@@ -58,7 +58,7 @@ This server can be configured using `workspace/didChangeConfiguration` method. E
 | `pylsp.plugins.pylint.enabled` | `boolean` | Enable or disable the plugin. | `false` |
 | `pylsp.plugins.pylint.args` | `array`  of non-unique `string` items | Arguments to pass to pylint. | `null` |
 | `pylsp.plugins.pylint.executable` | `string` | Executable to run pylint with. Enabling this will run pylint on unsaved files via stdin. Can slow down workflow. Only works with python3. | `null` |
-| `pylsp.plugins.rope_completion.enabled` | `boolean` | Enable or disable the plugin. | `true` |
+| `pylsp.plugins.rope_completion.enabled` | `boolean` | Enable or disable the plugin. | `false` |
 | `pylsp.plugins.rope_completion.eager` | `boolean` | Resolve documentation and detail eagerly. | `false` |
 | `pylsp.plugins.yapf.enabled` | `boolean` | Enable or disable the plugin. | `true` |
 | `pylsp.rope.extensionModules` | `string` | Builtin and c-extension modules that are allowed to be imported and inspected by rope. | `null` |

README.md

@@ -12,6 +12,7 @@ The base language server requires [Jedi](https://github.com/davidhalter/jedi) to
 ```
 pip install python-lsp-server
 ```
+This will expose the command `pylsp` on your PATH. Confirm that installation succeeded by running `pylsp --help`.
 
 If the respective dependencies are found, the following optional providers will be enabled:
 - [Rope](https://github.com/python-rope/rope) for Completions and renaming
@@ -21,6 +22,9 @@ If the respective dependencies are found, the following optional providers will
 - [pydocstyle](https://github.com/PyCQA/pydocstyle) linter for docstring style checking (disabled by default)
 - [autopep8](https://github.com/hhatto/autopep8) for code formatting
 - [YAPF](https://github.com/google/yapf) for code formatting (preferred over autopep8)
+- [flake8](https://github.com/pycqa/flake8) for error checking (disabled by default)
+- [pylint](https://github.com/PyCQA/pylint) for code linting (disabled by default)
+- [preload](https://github.com/tfiers/preload) for heavy modules (not included by default)
 
 Optional providers can be installed using the `extras` syntax. To install [YAPF](https://github.com/google/yapf) formatting for example:
 
@@ -44,7 +48,6 @@ pip install -U setuptools
 
 Installing these plugins will add extra functionality to the language server:
 
-- [pyls-flake8](https://github.com/emanspeaks/pyls-flake8/): Error checking using [flake8](https://flake8.pycqa.org/en/latest/).
 - [pylsp-mypy](https://github.com/Richardk2n/pylsp-mypy): [MyPy](http://mypy-lang.org/) type checking for Python >=3.7.
 - [pyls-isort](https://github.com/paradoxxxzero/pyls-isort): code formatting using [isort](https://github.com/PyCQA/isort) (automatic import sorting).
 - [python-lsp-black](https://github.com/python-lsp/python-lsp-black): code formatting using [Black](https://github.com/psf/black).
@@ -59,19 +62,53 @@ Please file an issue if you require assistance writing a plugin.
 
 ## Configuration
 
-Configuration is loaded from zero or more configuration sources.  Currently implemented are:
+Like all language servers, configuration can be passed from the client that talks to this server (i.e. your editor/IDE or other tool that has the same purpose). The details of how this is done depend on the editor or plugin that you are using to communicate with `python-lsp-server`. The configuration options available at that level are documented in [`CONFIGURATION.md`](https://github.com/python-lsp/python-lsp-server/blob/develop/CONFIGURATION.md).
 
-- pycodestyle: discovered in `~/.config/pycodestyle`, `setup.cfg`, `tox.ini` and `pycodestyle.cfg`.
-- flake8: discovered in `~/.config/flake8`, `setup.cfg`, `tox.ini` and `flake8.cfg`
+`python-lsp-server` depends on other tools, like flake8 and pycodestyle. These tools can be configured via settings passed from the client (as above), or alternatively from other configuration sources. The following sources are available:
 
-The default configuration source is pycodestyle. Change the `pylsp.configurationSources` setting to `['flake8']` in order to respect flake8 configuration instead.
+- `pycodestyle`: discovered in `~/.config/pycodestyle`, `setup.cfg`, `tox.ini` and `pycodestyle.cfg`.
+- `flake8`: discovered in `~/.config/flake8`, `setup.cfg`, `tox.ini` and `flake8.cfg`
+
+The default configuration sources are `pycodestyle` and `pyflakes`. If you would like to use `flake8`, you will need to:
+
+1. Disable `pycodestyle`, `mccabe`, and `pyflakes`, by setting their corresponding `enabled` configurations, e.g. `pylsp.plugins.pycodestyle.enabled`, to `false`. This will prevent duplicate linting messages as flake8 includes these tools.
+1. Set `pylsp.plugins.flake8.enabled` to `true`.
+1. Change the `pylsp.configurationSources` setting (in the value passed in from your client) to `['flake8']` in order to use the flake8 configuration instead.
+
+The configuration options available in these config files (`setup.cfg` etc) are documented in the relevant tools:
+
+- [flake8 configuration](https://flake8.pycqa.org/en/latest/user/configuration.html)
+- [pycodestyle configuration](https://pycodestyle.pycqa.org/en/latest/intro.html#configuration)
 
 Overall configuration is computed first from user configuration (in home directory), overridden by configuration passed in by the language client, and then overridden by configuration discovered in the workspace.
 
-To enable pydocstyle for linting docstrings add the following setting in your LSP configuration:
-`"pylsp.plugins.pydocstyle.enabled": true`
+As an example, to change the list of errors that pycodestyle will ignore, assuming you are using the `pycodestyle` configuration source (the default), you can:
+
+1. Add the following to your ~/.config/pycodestyle:
+
+   ```
+   [pycodestyle]
+   ignore = E226,E302,E41
+   ```
+
+2. Set the `pylsp.plugins.pycodestyle.ignore` config value from your editor
+3. Same as 1, but add to `setup.cfg` file in the root of the project.
+
 
-All configuration options are described in [`CONFIGURATION.md`](https://github.com/python-lsp/python-lsp-server/blob/develop/CONFIGURATION.md).
+Python LSP Server can communicate over WebSockets when configured as follows:
+
+```
+pylsp --ws --port [port]
+```
+
+The following libraries are required for Web Sockets support:
+- [websockets](https://websockets.readthedocs.io/en/stable/) for Python LSP Server Web sockets using websockets library. refer [Websockets installation](https://websockets.readthedocs.io/en/stable/intro/index.html#installation) for more details
+
+You can install this dependency with command below:
+
+```
+pip install 'python-lsp-server[websockets]'
+```
 
 ## LSP Server Features
 

RELEASE.md

@@ -2,7 +2,7 @@
 
 1. Create pull request to update CHANGELOG.md with
     * `loghub python-lsp/python-lsp-server -m vX.X.X`
-    * git add -A && git commit -m "Update Changelog"
+    * git add -A && git commit -m "Update changelog for X.X.X"
 
     This is necessary to run our tests before the release, so we can be sure
     everything is in order.
@@ -16,5 +16,4 @@
 6. python setup.py bdist_wheel
 7. twine check dist/*
 8. twine upload dist/*
-9. git push upstream develop
-10. git push upstream --tags
+9. git push upstream --tags

pylsp/__main__.py

@@ -13,7 +13,7 @@
     import json
 
 from .python_lsp import (PythonLSPServer, start_io_lang_server,
-                         start_tcp_lang_server)
+                         start_tcp_lang_server, start_ws_lang_server)
 from ._version import __version__
 
 LOG_FORMAT = "%(asctime)s {0} - %(levelname)s - %(name)s - %(message)s".format(
@@ -27,6 +27,10 @@ def add_arguments(parser):
         "--tcp", action="store_true",
         help="Use TCP server instead of stdio"
     )
+    parser.add_argument(
+        "--ws", action="store_true",
+        help="Use Web Sockets server instead of stdio"
+    )
     parser.add_argument(
         "--host", default="127.0.0.1",
         help="Bind to this address"
@@ -72,6 +76,9 @@ def main():
     if args.tcp:
         start_tcp_lang_server(args.host, args.port, args.check_parent_process,
                               PythonLSPServer)
+    elif args.ws:
+        start_ws_lang_server(args.port, args.check_parent_process,
+                             PythonLSPServer)
     else:
         stdin, stdout = _binary_stdio()
         start_io_lang_server(stdin, stdout, args.check_parent_process,

pylsp/config/schema.json

@@ -333,7 +333,7 @@
     },
     "pylsp.plugins.rope_completion.enabled": {
       "type": "boolean",
-      "default": true,
+      "default": false,
       "description": "Enable or disable the plugin."
     },
     "pylsp.plugins.rope_completion.eager": {

pylsp/hookspecs.py

@@ -80,12 +80,12 @@ def pylsp_folding_range(config, workspace, document):
 
 
 @hookspec(firstresult=True)
-def pylsp_format_document(config, workspace, document):
+def pylsp_format_document(config, workspace, document, options):
     pass
 
 
 @hookspec(firstresult=True)
-def pylsp_format_range(config, workspace, document, range):
+def pylsp_format_range(config, workspace, document, range, options):
     pass
 
 

pylsp/plugins/autopep8_format.py

@@ -13,13 +13,13 @@
 
 
 @hookimpl(tryfirst=True)  # Prefer autopep8 over YAPF
-def pylsp_format_document(config, document):
+def pylsp_format_document(config, document, options=None):  # pylint: disable=unused-argument
     log.info("Formatting document %s with autopep8", document)
     return _format(config, document)
 
 
 @hookimpl(tryfirst=True)  # Prefer autopep8 over YAPF
-def pylsp_format_range(config, document, range):  # pylint: disable=redefined-builtin
+def pylsp_format_range(config, document, range, options=None):  # pylint: disable=redefined-builtin,unused-argument
     log.info("Formatting document %s in range %s with autopep8", document, range)
 
     # First we 'round' the range up/down to full lines only

pylsp/plugins/flake8_lint.py

@@ -31,8 +31,20 @@ def pylsp_lint(workspace, document):
     per_file_ignores = settings.get("perFileIgnores")
 
     if per_file_ignores:
+        prev_file_pat = None
         for path in per_file_ignores:
-            file_pat, errors = path.split(":")
+            try:
+                file_pat, errors = path.split(":")
+                prev_file_pat = file_pat
+            except ValueError:
+                # It's legal to just specify another error type for the same
+                # file pattern:
+                if prev_file_pat is None:
+                    log.warning(
+                        "skipping a Per-file-ignore with no file pattern")
+                    continue
+                file_pat = prev_file_pat
+                errors = path
             if PurePath(document.path).match(file_pat):
                 ignores.extend(errors.split(","))
 
@@ -81,7 +93,7 @@ def run_flake8(flake8_executable, args, document):
     try:
         cmd = [flake8_executable]
         cmd.extend(args)
-        p = Popen(cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)  # pylint: disable=consider-using-with
+        p = Popen(cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
     except IOError:
         log.debug("Can't execute %s. Trying with '%s -m flake8'", flake8_executable, sys.executable)
         cmd = [sys.executable, '-m', 'flake8']

pylsp/plugins/pylint_lint.py

@@ -246,7 +246,7 @@ def _run_pylint_stdio(pylint_executable, document, flags):
         cmd = [pylint_executable]
         cmd.extend(flags)
         cmd.extend(['--from-stdin', document.path])
-        p = Popen(cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)  # pylint: disable=consider-using-with
+        p = Popen(cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
     except IOError:
         log.debug("Can't execute %s. Trying with 'python -m pylint'", pylint_executable)
         cmd = ['python', '-m', 'pylint']

pylsp/plugins/yapf_format.py

@@ -4,7 +4,7 @@
 import logging
 import os
 
-from yapf.yapflib import file_resources
+from yapf.yapflib import file_resources, style
 from yapf.yapflib.yapf_api import FormatCode
 
 import whatthepatch
@@ -16,12 +16,12 @@
 
 
 @hookimpl
-def pylsp_format_document(document):
-    return _format(document)
+def pylsp_format_document(document, options=None):
+    return _format(document, options=options)
 
 
 @hookimpl
-def pylsp_format_range(document, range):  # pylint: disable=redefined-builtin
+def pylsp_format_range(document, range, options=None):  # pylint: disable=redefined-builtin
     # First we 'round' the range up/down to full lines only
     range['start']['character'] = 0
     range['end']['line'] += 1
@@ -35,25 +35,62 @@ def pylsp_format_range(document, range):  # pylint: disable=redefined-builtin
 
     # Add 1 for 1-indexing vs LSP's 0-indexing
     lines = [(range['start']['line'] + 1, range['end']['line'] + 1)]
-    return _format(document, lines=lines)
+    return _format(document, lines=lines, options=options)
 
 
-def _format(document, lines=None):
-    # Yapf doesn't work with CR line endings, so we replace them by '\n'
-    # and restore them below.
+def _format(document, lines=None, options=None):
     source = document.source
+    # Yapf doesn't work with CRLF/CR line endings, so we replace them by '\n'
+    # and restore them below when adding new lines
     eol_chars = get_eol_chars(source)
-    if eol_chars == '\r':
-        source = source.replace('\r', '\n')
+    if eol_chars in ['\r', '\r\n']:
+        source = source.replace(eol_chars, '\n')
+
+    # Get the default styles as a string
+    # for a preset configuration, i.e. "pep8"
+    style_config = file_resources.GetDefaultStyleForDir(
+        os.path.dirname(document.path)
+    )
+    if options is not None:
+        # We have options passed from LSP format request
+        # let's pass them to the formatter.
+        # First we want to get a dictionary of the preset style
+        # to pass instead of a string so that we can modify it
+        style_config = style.CreateStyleFromConfig(style_config)
+
+        use_tabs = style_config['USE_TABS']
+        indent_width = style_config['INDENT_WIDTH']
+
+        if options.get('tabSize') is not None:
+            indent_width = max(int(options.get('tabSize')), 1)
+
+        if options.get('insertSpaces') is not None:
+            # TODO is it guaranteed to be a boolean, or can it be a string?
+            use_tabs = not options.get('insertSpaces')
+
+            if use_tabs:
+                # Indent width doesn't make sense when using tabs
+                # the specifications state: "Size of a tab in spaces"
+                indent_width = 1
+
+        style_config['USE_TABS'] = use_tabs
+        style_config['INDENT_WIDTH'] = indent_width
+        style_config['CONTINUATION_INDENT_WIDTH'] = indent_width
+
+        for style_option, value in options.items():
+            # Apply arbitrary options passed as formatter options
+            if style_option not in style_config:
+                # ignore if it's not a known yapf config
+                continue
+
+            style_config[style_option] = value
 
     diff_txt, changed = FormatCode(
         source,
         lines=lines,
         filename=document.filename,
         print_diff=True,
-        style_config=file_resources.GetDefaultStyleForDir(
-            os.path.dirname(document.path)
-        )
+        style_config=style_config
     )
 
     if not changed:
@@ -112,4 +149,4 @@ def _format(document, lines=None):
             })
             prev_line_no = lsp_line_no
 
-    return textEdits
+    return textEdits