Add a new configuration option 'config_files'

.github/workflows/python-package.yml

@@ -0,0 +1,74 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python package
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+
+  testCode:
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --show-source --statistics
+    - name: Check black formatting
+      run: |
+        # stop the build if black detect any changes
+        black --check .
+    - name: Check isort sorting
+      run: |
+        # stop the build if isort detect any changes
+        isort . --check --diff
+    - name: Test with pytest
+      run: |
+        pytest
+
+  testUploadability:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Test with rstcheck
+      run: |
+        rstcheck README.rst
+    - name: Build and check
+      run: |
+        python setup.py sdist bdist_wheel
+        twine check dist/*

.github/workflows/python-publish.yml

@@ -0,0 +1,31 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+  - repo: https://github.com/Lucas-C/pre-commit-hooks-markup
+    rev: v1.0.1
+    hooks:
+      - id: rst-linter
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort

LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
 Copyright (c) 2017 Tom van Ommeren
+Copyright (c) 2022 Richard Kellnberger
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MANIFEST.in

@@ -1,3 +1 @@
 include README.rst
-include versioneer.py
-include pyls-mypy/_version.py

README.rst

@@ -1,47 +1,119 @@
-Mypy plugin for PYLS
+Mypy plugin for PYLSP
 ======================
 
-.. image:: https://badge.fury.io/py/pyls-mypy.svg
-    :target: https://badge.fury.io/py/pyls-mypy
+.. image:: https://badge.fury.io/py/pylsp-mypy.svg
+    :target: https://badge.fury.io/py/pylsp-mypy
 
-.. image:: https://travis-ci.org/tomv564/pyls-mypy.svg?branch=master
-    :target: https://travis-ci.org/tomv564/pyls-mypy
+.. image:: https://github.com/python-lsp/pylsp-mypy/workflows/Python%20package/badge.svg?branch=master
+    :target: https://github.com/python-lsp/pylsp-mypy/
 
-This is a plugin for the Palantir's Python Language Server (https://github.com/palantir/python-language-server)
+This is a plugin for the `Python LSP Server`_.
 
-It, like mypy, requires Python 3.2 or newer.
+.. _`Python LSP Server`: https://github.com/python-lsp/python-lsp-server
+
+It, like mypy, requires Python 3.7 or newer.
 
 
 Installation
 ------------
 
-Install into the same virtualenv as pyls itself.
+Install into the same virtualenv as python-lsp-server itself.
 
-``pip install pyls-mypy``
+``pip install pylsp-mypy``
 
 Configuration
 -------------
 
 ``live_mode`` (default is True) provides type checking as you type.
+    This writes to a tempfile every time a check is done. Turning off ``live_mode`` means you must save your changes for mypy diagnostics to update correctly.
+
+``dmypy`` (default is False) executes via ``dmypy run`` rather than ``mypy``.
+    This uses the ``dmypy`` daemon and may dramatically improve the responsiveness of the ``pylsp`` server, however this currently does not work in ``live_mode``. Enabling this disables ``live_mode``, even for conflicting configs.
+
+``strict`` (default is False) refers to the ``strict`` option of ``mypy``.
+    This option often is too strict to be useful.
 
-As mypy is unaware of what file path is being checked, there are limitations with live_mode
- - Imports cannot be followed correctly
- - Stub files are not validated correctly
+``overrides`` (default is ``[True]``) specifies a list of alternate or supplemental command-line options.
+    This modifies the options passed to ``mypy`` or the mypy-specific ones passed to ``dmypy run``. When present, the special boolean member ``True`` is replaced with the command-line options that would've been passed had ``overrides`` not been specified. Later options take precedence, which allows for replacing or negating individual default options (see ``mypy.main:process_options`` and ``mypy --help | grep inverse``).
 
-Turning off live_mode means you must save your changes for mypy diagnostics to update correctly.
+``config_names`` (default is ``[]``) specifies alternate file names under which the mypy configuration may be found.
 
-Depending on your editor, the configuration should be roughly like this:
+This project supports the use of ``pyproject.toml`` for configuration. It is in fact the preferred way. Using that your configuration could look like this:
+
+::
+
+    [tool.pylsp-mypy]
+    enabled = true
+    live_mode = true
+    strict = true
+
+A ``pyproject.toml`` does not conflict with the legacy config file given that it does not contain a ``pylsp-mypy`` section. The following explanation uses the syntax of the legacy config file. However, all these options also apply to the ``pyproject.toml`` configuration (note the lowercase bools).
+Depending on your editor, the configuration (found in a file called pylsp-mypy.cfg in your workspace or a parent directory) should be roughly like this for a standard configuration:
 
 ::
 
-    "pyls":
     {
-        "plugins":
-        {
-            "pyls_mypy":
-            {
-                "enabled": true,
-                "live_mode": false
-            }
-        }
+        "enabled": True,
+        "live_mode": True,
+        "strict": False
     }
+
+With ``dmypy`` enabled your config should look like this:
+
+::
+
+    {
+        "enabled": True,
+        "live_mode": False,
+        "dmypy": True,
+        "strict": False
+    }
+
+With ``overrides`` specified (for example to tell mypy to use a different python than the currently active venv), your config could look like this:
+
+::
+
+    {
+        "enabled": True,
+        "overrides": ["--python-executable", "/home/me/bin/python", True]
+    }
+
+With ``config_files`` your config could look like this:
+
+::
+
+    {
+        "enabled": True,
+        "config_files": [".config/mypy.ini"]
+    }
+
+
+Developing
+-------------
+
+Install development dependencies with (you might want to create a virtualenv first):
+
+::
+
+   pip install -r requirements.txt
+
+The project is formatted with `black`_. You can either configure your IDE to automatically format code with it, run it manually (``black .``) or rely on pre-commit (see below) to format files on git commit.
+
+The project is formatted with `isort`_. You can either configure your IDE to automatically sort imports with it, run it manually (``isort .``) or rely on pre-commit (see below) to sort files on git commit.
+
+The project uses two rst tests in order to assure uploadability to pypi: `rst-linter`_ as a pre-commit hook and `rstcheck`_ in a GitHub workflow. This does not catch all errors.
+
+This project uses `pre-commit`_ to enforce code-quality. After cloning the repository install the pre-commit hooks with:
+
+::
+
+   pre-commit install
+
+After that pre-commit will run `all defined hooks`_ on every ``git commit`` and keep you from committing if there are any errors.
+
+.. _black: https://github.com/psf/black
+.. _isort: https://github.com/PyCQA/isort
+.. _rst-linter: https://github.com/Lucas-C/pre-commit-hooks-markup
+.. _rstcheck: https://github.com/myint/rstcheck
+.. _pre-commit: https://pre-commit.com/
+.. _all defined hooks: .pre-commit-config.yaml