Merge pull request #704 from koordinates/helper-support-shell-detection

CHANGELOG.md

@@ -8,6 +8,7 @@ _When adding new entries to the changelog, please include issue/PR numbers where
 
 - Install tab completion using `kart install tab-completion` instead of `kart config --install-tab-completion`. [#701](https://github.com/koordinates/kart/issues/701)
 - "Primary key conflicts" - conflicts caused by reusing a primary key which is already assigned to a feature outside the spatial filter - are renamed to "spatial filter conflicts" for future proofing with other dataset types. Consequently, commit option `--allow-pk-conflicts` is renamed to `--allow-spatial-filter-conflicts`.
+- Support shell detection for tab completion installation when running in helper mode. [#704](https://github.com/koordinates/kart/pull/704)
 - Bugfix: directing geojson diff output to the console didn't work in a multi-dataset repo, even if only one dataset had changed. [#702](https://github.com/koordinates/kart/issues/702)
 
 ## 0.11.5

kart.spec

@@ -115,6 +115,8 @@ pyi_analysis = Analysis(
         '_cffi_backend',
         # via a cython module ???
         'csv',
+        'shellingham.posix',
+        'shellingham.nt',
         *collect_submodules('kart'),
         *collect_submodules('sqlalchemy'),
     ],

kart/completion.py

@@ -15,6 +15,12 @@
 except ImportError:
     shellingham = None
 
+def provide_default_shell():
+    if os.name == 'posix':
+        return os.environ.get('SHELL', '')
+    elif os.name == 'nt':
+        return os.environ.get('COMSPEC', '')
+    raise NotImplementedError(f'OS {os.name!r} support not available')
 
 class Shells(str, Enum):
     bash = "bash"
@@ -187,7 +193,10 @@ def install_tab_completion(
     if complete_var is None:
         complete_var = "_{}_COMPLETE".format(prog_name.replace("-", "_").upper())
     if shell is None and shellingham is not None:
-        shell, _ = shellingham.detect_shell()
+        try:
+            shell, _ = shellingham.detect_shell()
+        except shellingham.ShellDetectionFailure:
+            shell = os.path.basename(provide_default_shell())
     if shell == "bash":
         installed_path = install_bash(
             prog_name=prog_name, complete_var=complete_var, shell=shell

kart/helper.py

@@ -5,6 +5,7 @@
 import io
 import os
 import sys
+import traceback
 
 import click
 
@@ -204,8 +205,9 @@ class struct_semun(ctypes.Union):
 
                     except Exception as e:
                         print(
-                            f"kart helper: unhandled exception [{e}]"
+                            f"kart helper: unhandled exception"
                         )  # TODO - should ext-run capture/handle this?
+                        traceback.print_exc(file=sys.stderr)
                         libc.semctl(semid, 0, SETVAL, struct_semun(val=1001))
                     try:
                         # send a signal to caller that we are done

tests/scripts/e2e-1.ps1

@@ -50,6 +50,7 @@ $SQLITE=(Join-Path $KART_PREFIX 'sqlite3.exe')
 New-Item -ItemType Directory -Path "${TMP_PATH}\test"
 Push-Location "${TMP_PATH}\test"
 try {
+    Exec { kart -vvvv install tab-completion --shell auto }
     Exec { kart init --initial-branch=main . }
     Exec { kart -v config --local 'user.name' 'Kart E2E Test 1' }
     Exec { kart -v config --local 'user.email' 'kart-e2e-test-1@email.invalid' }

tests/scripts/e2e-1.sh

@@ -33,6 +33,8 @@ set -x
 
 echo "Using helper mode: ${KART_USE_HELPER:-0}"
 
+kart -vvvv install tab-completion --shell auto
+
 kart init --initial-branch=main .
 kart config user.name "Kart E2E Test 1"
 kart config user.email "kart-e2e-test-1@email.invalid"