Merge #469 from jamessan/github-actions

Author: justinmk

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: test
+name: ci
 on:
   push:
   pull_request:
@@ -13,6 +13,21 @@ env:
   PYTEST_ADDOPTS: '-vv'
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        cache: 'pip'
+        python-version: 3.11
+    - name: install dependencies
+      run: pip install tox tox-gh-actions
+    - name: checkqa
+      env:
+        TOXENV: 'checkqa,docs'
+      run: tox
+
   test:
     strategy:
       fail-fast: false
@@ -34,8 +49,6 @@ jobs:
           EXTRACT: unzip
 
     runs-on: ${{ matrix.os }}
-
-    # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
     - uses: actions/checkout@v3
     - uses: actions/setup-python@v4
@@ -58,34 +71,11 @@ jobs:
       run: echo "$(pwd)/${{ matrix.NVIM_BIN_PATH }}" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
 
     - name: install dependencies
-      run: |
-        pip install .  # Install from setup.py
-        pip install -q pytest
+      run: pip install tox tox-gh-actions
 
     - name: test
       run: |
         echo $PATH
         which nvim
         nvim --version
-        python -m pytest
-
-    - uses: codecov/codecov-action@v3
-      if: runner.os == 'macOS'
-      with:
-        verbose: true # optional (default = false)
-
-# TODO: tox, codecov steps from old travis workflow
-#
-# env: CI_TARGET=checkqa TOXENV=checkqa,docs
-# script:
-#   - tox
-# after_script:
-#   - if [ $CI_TARGET = tests ]; then
-#       set -x;
-#       pip install coverage;
-#       coverage combine;
-#       coverage report -m;
-#       coverage xml;
-#       bash <(curl --retry 5 --silent --fail https://codecov.io/bash) -f coverage.xml;
-#       set +x;
-#     fi
+        tox

docs/conf.py

@@ -68,7 +68,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

pynvim/__init__.py

@@ -6,7 +6,7 @@
 import os
 import sys
 from types import SimpleNamespace as Version
-from typing import List, cast, overload
+from typing import List, Optional, cast, overload
 
 from pynvim.api import Nvim, NvimError
 from pynvim.msgpack_rpc import (ErrorResponse, Session, TTransportType, child_session,
@@ -28,7 +28,7 @@
            'ErrorResponse')
 
 
-def start_host(session: Session = None) -> None:
+def start_host(session: Optional[Session] = None) -> None:
     """Promote the current process into python plugin host for Nvim.
 
     Start msgpack-rpc event loop for `session`, listening for Nvim requests
@@ -101,10 +101,10 @@ def attach(session_type: Literal['stdio']) -> Nvim: ...
 
 def attach(
     session_type: TTransportType,
-    address: str = None,
+    address: Optional[str] = None,
     port: int = 7450,
-    path: str = None,
-    argv: List[str] = None,
+    path: Optional[str] = None,
+    argv: Optional[List[str]] = None,
     decode: Literal[True] = True
 ) -> Nvim:
     """Provide a nicer interface to create python api sessions.

pynvim/api/buffer.py

@@ -13,7 +13,7 @@
 
 
 @overload
-def adjust_index(idx: int, default: int = None) -> int:
+def adjust_index(idx: int, default: Optional[int] = None) -> int:
     ...
 
 
@@ -23,11 +23,11 @@ def adjust_index(idx: Optional[int], default: int) -> int:
 
 
 @overload
-def adjust_index(idx: Optional[int], default: int = None) -> Optional[int]:
+def adjust_index(idx: Optional[int], default: Optional[int] = None) -> Optional[int]:
     ...
 
 
-def adjust_index(idx: Optional[int], default: int = None) -> Optional[int]:
+def adjust_index(idx: Optional[int], default: Optional[int] = None) -> Optional[int]:
     """Convert from python indexing convention to nvim indexing convention."""
     if idx is None:
         return default
@@ -161,7 +161,7 @@ def add_highlight(
         col_start: int = 0,
         col_end: int = -1,
         src_id: int = -1,
-        async_: bool = None,
+        async_: Optional[bool] = None,
         **kwargs: Any
     ) -> int:
         """Add a highlight to the buffer."""
@@ -181,7 +181,7 @@ def clear_highlight(
         src_id: int,
         line_start: int = 0,
         line_end: int = -1,
-        async_: bool = None,
+        async_: Optional[bool] = None,
         **kwargs: Any
     ) -> None:
         """Clear highlights from the buffer."""
@@ -301,7 +301,7 @@ def __iter__(self) -> Iterator[str]:
             yield self._buffer[i]
 
     def append(
-        self, lines: Union[str, bytes, List[Union[str, bytes]]], i: int = None
+        self, lines: Union[str, bytes, List[Union[str, bytes]]], i: Optional[int] = None
     ) -> None:
         i = self._normalize_index(i)
         if i is None:

pynvim/api/common.py

@@ -123,8 +123,8 @@ def __init__(
         self,
         obj: IRemote,
         get_method: str,
-        set_method: str = None,
-        del_method: str = None
+        set_method: Optional[str] = None,
+        del_method: Optional[str] = None
     ):
         """Initialize a RemoteMap with session, getter/setter."""
         self._get = functools.partial(obj.request, get_method)

pynvim/api/nvim.py

@@ -112,7 +112,7 @@ def __init__(
         metadata: Dict[str, Any],
         types: Dict[int, Any],
         decode: TDecodeMode = True,
-        err_cb: Callable[[str], None] = None
+        err_cb: Optional[Callable[[str], None]] = None
     ):
         """Initialize a new Nvim instance. This method is module-private."""
         self._session = session
@@ -142,7 +142,7 @@ def __init__(
             self._err_cb = err_cb
         self.loop = self._session.loop._loop
 
-    def _from_nvim(self, obj: Any, decode: TDecodeMode = None) -> Any:
+    def _from_nvim(self, obj: Any, decode: Optional[TDecodeMode] = None) -> Any:
         if decode is None:
             decode = self._decode
         if type(obj) is ExtType:
@@ -213,8 +213,8 @@ def run_loop(
         self,
         request_cb: Optional[Callable[[str, List[Any]], Any]],
         notification_cb: Optional[Callable[[str, List[Any]], Any]],
-        setup_cb: Callable[[], None] = None,
-        err_cb: Callable[[str], Any] = None
+        setup_cb: Optional[Callable[[], None]] = None,
+        err_cb: Optional[Callable[[str], Any]] = None
     ) -> None:
         """Run the event loop to receive requests and notifications from Nvim.
 
@@ -275,7 +275,7 @@ def with_decode(self, decode: Literal[True] = True) -> 'Nvim':
                     self.metadata, self.types, decode, self._err_cb)
 
     def ui_attach(
-        self, width: int, height: int, rgb: bool = None, **kwargs: Any
+        self, width: int, height: int, rgb: Optional[bool] = None, **kwargs: Any
     ) -> None:
         """Register as a remote UI.
 
@@ -375,14 +375,7 @@ def chdir(self, dir_path: str) -> None:
         return self.request('nvim_set_current_dir', dir_path)
 
     def feedkeys(self, keys: str, options: str = '', escape_csi: bool = True) -> None:
-        """Push `keys` to Nvim user input buffer.
-
-        Options can be a string with the following character flags:
-        - 'm': Remap keys. This is default.
-        - 'n': Do not remap keys.
-        - 't': Handle keys as if typed; otherwise they are handled as if coming
-               from a mapping. This matters for undo, opening folds, etc.
-        """
+        """Push `keys` to Nvim user input buffer."""
         return self.request('nvim_feedkeys', keys, options, escape_csi)
 
     def input(self, bytes: AnyStr) -> int:

pynvim/compat.py

@@ -21,6 +21,7 @@ def find_module(fullname, path):  # type: ignore
             else:
                 newpath.append(element)
         path = newpath
+    from imp import find_module as original_find_module
     return original_find_module(fullname, path)
 
 

pynvim/msgpack_rpc/event_loop/asyncio.py

@@ -23,7 +23,7 @@
 
 loop_cls = asyncio.SelectorEventLoop
 if os.name == 'nt':
-    from asyncio.windows_utils import PipeHandle
+    from asyncio.windows_utils import PipeHandle  # type: ignore[attr-defined]
     import msvcrt
 
     # On windows use ProactorEventLoop which support pipes and is backed by the
@@ -114,7 +114,7 @@ def _connect_stdio(self) -> None:
             )
         else:
             pipe = os.fdopen(rename_stdout, 'wb')
-        coroutine = self._loop.connect_write_pipe(self._fact, pipe)
+        coroutine = self._loop.connect_write_pipe(self._fact, pipe)  # type: ignore[assignment]
         self._loop.run_until_complete(coroutine)
         debug("native stdout connection successful")
 

pynvim/msgpack_rpc/session.py

@@ -140,7 +140,7 @@ def request(self, method: AnyStr, *args: Any, **kwargs: Any) -> Any:
     def run(self,
             request_cb: Callable[[str, List[Any]], None],
             notification_cb: Callable[[str, List[Any]], None],
-            setup_cb: Callable[[], None] = None) -> None:
+            setup_cb: Optional[Callable[[], None]] = None) -> None:
         """Run the event loop to receive requests and notifications from Nvim.
 
         Like `AsyncSession.run()`, but `request_cb` and `notification_cb` are

pynvim/plugin/decorators.py

@@ -3,7 +3,7 @@
 import inspect
 import logging
 import sys
-from typing import Any, Callable, Dict, TypeVar, Union
+from typing import Any, Callable, Dict, Optional, TypeVar, Union
 
 from pynvim.compat import unicode_errors_default
 
@@ -52,14 +52,14 @@ def dec(f: F) -> F:
 def command(
     name: str,
     nargs: Union[str, int] = 0,
-    complete: str = None,
-    range: Union[str, int] = None,
-    count: int = None,
+    complete: Optional[str] = None,
+    range: Optional[Union[str, int]] = None,
+    count: Optional[int] = None,
     bang: bool = False,
     register: bool = False,
     sync: bool = False,
     allow_nested: bool = False,
-    eval: str = None
+    eval: Optional[str] = None
 ) -> Callable[[F], F]:
     """Tag a function or plugin method as a Nvim command handler."""
     def dec(f: F) -> F:
@@ -112,7 +112,7 @@ def autocmd(
     pattern: str = '*',
     sync: bool = False,
     allow_nested: bool = False,
-    eval: str = None
+    eval: Optional[str] = None
 ) -> Callable[[F], F]:
     """Tag a function or plugin method as a Nvim autocommand handler."""
     def dec(f: F) -> F:
@@ -150,7 +150,7 @@ def function(
     range: Union[bool, str, int] = False,
     sync: bool = False,
     allow_nested: bool = False,
-    eval: str = None
+    eval: Optional[str] = None
 ) -> Callable[[F], F]:
     """Tag a function or plugin method as a Nvim function handler."""
     def dec(f: F) -> F: