Merge branch '19.09'

Author: achimnol

.gitignore

@@ -38,3 +38,4 @@ env_*.sh
 .ipynb_checkpoints
 
 .vscode/
+.mypy_cache/

CHANGELOG.rst

@@ -48,6 +48,17 @@ Changes
 * BREAKING CHANGE: Now the client SDK runs on Python 3.6, 3.7, and 3.8 and
   dropped support for Python 3.5.
 
+19.09.7 (2020-03-31)
+--------------------
+
+* FIX: Not-implemented-error in ``backend.ai app`` command on Windows, due
+  to manually set event loop UNIX signal handlers. (#93)
+
+* FIX: Now *all* CLI commands set exit codes correctly for interrupts
+  (Ctrl+C on Windows or SIGINT on POSIX systems) so that batch/shell
+  scripts that use ``backend.ai`` commands get interrupted properly.
+  (#93)
+
 19.09.6 (2020-03-16)
 --------------------
 

setup.py

@@ -7,16 +7,16 @@
 ]
 install_requires = [
     'backend.ai-cli~=0.3',
-    'Click>=7.0',
-    'PyYAML~=5.1.2',
-    'appdirs~=1.4.3',
     'aiohttp~=3.6.2',
+    'appdirs~=1.4.3',
     'async_timeout~=3.0',  # to avoid pip10 resolver issue
     'attrs>=19.3',         # to avoid pip10 resolver issue
+    'click~=7.1.1',
     'colorama~=0.4.3',
     'humanize~=1.0.0',
     'multidict~=4.7.4',
     'python-dateutil~=2.8.1',
+    'PyYAML~=5.1.2',
     'tabulate~=0.8.6',
     'tqdm~=4.42',
     'yarl~=1.4.2',
@@ -86,6 +86,7 @@ def read_src_version():
         'Programming Language :: Python :: 3.8',
         'Operating System :: POSIX',
         'Operating System :: MacOS :: MacOS X',
+        'Operating System :: Microsoft :: Windows',
         'Environment :: No Input/Output (Daemon)',
         'Topic :: Scientific/Engineering',
         'Topic :: Software Development',

src/ai/backend/client/cli/__init__.py

@@ -1,9 +1,13 @@
 from pathlib import Path
+import os
+import signal
 import sys
 import warnings
 
 import click
+from click.exceptions import ClickException, Abort
 
+from .. import __version__
 from ..config import APIConfig, set_config
 from ai.backend.cli.extensions import AliasGroup
 
@@ -13,7 +17,7 @@
 @click.option('--skip-sslcert-validation',
               help='Skip SSL certificate validation for all API requests.',
               is_flag=True)
-@click.version_option()
+@click.version_option(version=__version__)
 def main(skip_sslcert_validation):
     """
     Backend.AI command line interface.
@@ -40,7 +44,7 @@ def run_alias():
     sys.argv.insert(1, 'run')
     if help:
         sys.argv.append('--help')
-    main.main(prog_name='backend.ai')
+    run_main()
 
 
 def _attach_command():
@@ -51,3 +55,48 @@ def _attach_command():
 
 
 _attach_command()
+
+
+def run_main():
+    try:
+        _interrupted = False
+        main.main(
+            standalone_mode=False,
+            prog_name='backend.ai',
+        )
+    except KeyboardInterrupt:
+        # For interruptions outside the Click's exception handling block.
+        print("Interrupted!", end="", file=sys.stderr)
+        sys.stderr.flush()
+        _interrupted = True
+    except Abort as e:
+        # Click wraps unhandled KeyboardInterrupt with a plain
+        # sys.exit(1) call and prints "Aborted!" message
+        # (which would look non-sense to users).
+        # This is *NOT* what we want.
+        # Instead of relying on Click, mark the _interrupted
+        # flag to perform our own exit routines.
+        if isinstance(e.__context__, KeyboardInterrupt):
+            print("Interrupted!", end="", file=sys.stderr)
+            sys.stderr.flush()
+            _interrupted = True
+        else:
+            print("Aborted!", end="", file=sys.stderr)
+            sys.stderr.flush()
+            sys.exit(1)
+    except ClickException as e:
+        e.show()
+        sys.exit(e.exit_code)
+    finally:
+        if _interrupted:
+            # Override the exit code when it's interrupted,
+            # referring https://github.com/python/cpython/pull/11862
+            if sys.platform.startswith('win'):
+                # Use STATUS_CONTROL_C_EXIT to notify cmd.exe
+                # for interrupted exit
+                sys.exit(-1073741510)
+            else:
+                # Use the default signal handler to set the exit
+                # code properly for interruption.
+                signal.signal(signal.SIGINT, signal.SIG_DFL)
+                os.kill(os.getpid(), signal.SIGINT)

src/ai/backend/client/cli/__main__.py

@@ -1,3 +1,4 @@
-from . import main
+from . import run_main
 
-main()
+
+run_main()

src/ai/backend/client/cli/app.py

@@ -274,8 +274,7 @@ def app(session_name, app, protocol, bind, arg, env):
         args=arg,
         envs=env,
     )
-    stop_signals = {signal.SIGINT, signal.SIGTERM}
-    asyncio_run_forever(proxy_ctx, stop_signals=stop_signals)
+    asyncio_run_forever(proxy_ctx)
     sys.exit(proxy_ctx.exit_code)
 
 

src/ai/backend/client/compat.py

@@ -3,7 +3,6 @@
 '''
 
 import asyncio
-import signal
 
 
 if hasattr(asyncio, 'get_running_loop'):  # Python 3.7+
@@ -49,6 +48,7 @@ def _asyncio_run(coro, *, debug=False):
             if hasattr(loop, 'shutdown_asyncgens'):  # Python 3.6+
                 loop.run_until_complete(loop.shutdown_asyncgens())
         finally:
+            loop.stop()
             loop.close()
             asyncio.set_event_loop(None)
 
@@ -59,8 +59,7 @@ def _asyncio_run(coro, *, debug=False):
     asyncio_run = _asyncio_run
 
 
-def asyncio_run_forever(server_context, *,
-                        stop_signals={signal.SIGINT}, debug=False):
+def asyncio_run_forever(server_context, *, debug=False):
     '''
     A proposed-but-not-implemented asyncio.run_forever() API based on
     @vxgmichel's idea.
@@ -79,9 +78,6 @@ async def _run_forever():
             except asyncio.CancelledError:
                 pass
 
-    for stop_sig in stop_signals:
-        loop.add_signal_handler(stop_sig, forever.cancel)
-
     try:
         return loop.run_until_complete(_run_forever())
     finally:
@@ -90,5 +86,6 @@ async def _run_forever():
             if hasattr(loop, 'shutdown_asyncgens'):  # Python 3.6+
                 loop.run_until_complete(loop.shutdown_asyncgens())
         finally:
+            loop.stop()
             loop.close()
             asyncio.set_event_loop(None)