powershell completion is working #156

Author: bckohan

django_typer/management/commands/shellcompletion.py

@@ -22,6 +22,7 @@
 import contextlib
 import io
 import os
+import platform
 import re
 import sys
 import typing as t
@@ -47,7 +48,7 @@
 from django_typer.completers import these_strings
 from django_typer.management import TyperCommand, command, get_command, initialize
 from django_typer.types import COMMON_PANEL
-from django_typer.utils import get_usage_script
+from django_typer.utils import get_usage_script, get_win_shell
 
 DETECTED_SHELL = None
 
@@ -392,6 +393,11 @@ def shell(self, shell: t.Optional[str]):
                     "autocompletion for. Unable to detect shell."
                 )
             )
+        elif self._shell == "cmd" and platform.system() == "Windows":
+            try:
+                self._shell = get_win_shell()
+            except ShellDetectionFailure:
+                pass
 
     @property
     def shell_class(self):

django_typer/management/commands/shells/powershell.py

@@ -10,9 +10,21 @@
 class PowerShellComplete(DjangoTyperShellCompleter):
     name = "powershell"
     template = "shell_complete/powershell.ps1"
+    supports_scripts = False
 
     def format_completion(self, item: CompletionItem) -> str:
-        return f"{item.value}:::{item.help or ' '}"
+        return ":::".join(
+            [
+                item.type,
+                self.process_rich_text(item.value),
+                " ".join(
+                    [
+                        ln.strip()
+                        for ln in self.process_rich_text(item.help or " ").splitlines()
+                    ]
+                ),
+            ]
+        )
 
     def set_execution_policy(self) -> None:
         subprocess.run(
@@ -50,7 +62,7 @@ def install(self) -> Path:
             f.writelines([self.source()])
         return profile
 
-    def uninstall(self):
+    def uninstall(self) -> None:
         # annoyingly, powershell has one profile script for all completion commands
         # so we have to find our entry and remove it
         assert self.prog_name

django_typer/templates/shell_complete/bash.sh

@@ -39,7 +39,7 @@
         elif [[ $type == 'file' ]]; then
             COMPREPLY=()
             compopt -o default
-        elif [[ $type == 'plain' ]]; then
+        else
             COMPREPLY+=($value)
         fi
     done

django_typer/templates/shell_complete/powershell.ps1

@@ -22,10 +22,15 @@ $scriptblock = {
 
     {{ manage_script_name }} {{ django_command }} $settingsOption $pythonPathOption --shell {{ shell }} {{ color }} complete "$($commandText)" | ForEach-Object {
         $commandArray = $_ -Split ":::"
-        $command = $commandArray[0]
-        $helpString = $commandArray[1]
-        [System.Management.Automation.CompletionResult]::new(
-            $command, $command, 'ParameterValue', $helpString)
+        $type = $commandArray[0]
+        $value = $commandArray[1]
+        $help = $commandArray[2]
+        if ($help -eq "") {
+            [System.Management.Automation.CompletionResult]::new($value)
+        } else {
+            [System.Management.Automation.CompletionResult]::new(
+                $value, $value, 'ParameterValue', $help)
+        }
     }
 }
 Register-ArgumentCompleter -Native -CommandName {{ manage_script_name }} -ScriptBlock $scriptblock

django_typer/templates/shell_complete/zsh.sh

@@ -38,16 +38,16 @@
     response=("${(@f)$("${manage}" {{ django_command }} --shell zsh ${settings_option:+${settings_option}} ${pythonpath_option:+${pythonpath_option}} {{ color }} complete "${words[*]}")}")
 
     for type key descr in ${response}; do
-        if [[ "$type" == "plain" ]]; then
+        if [[ "$type" == "dir" ]]; then
+            _path_files -/
+        elif [[ "$type" == "file" ]]; then
+            _path_files -f
+        else
             if [[ "$descr" == "_" ]]; then
                 completions+=("$key")
             else
                 completions_with_descriptions+=("$key":"$descr")
             fi
-        elif [[ "$type" == "dir" ]]; then
-            _path_files -/
-        elif [[ "$type" == "file" ]]; then
-            _path_files -f
         fi
     done
 

django_typer/utils.py

@@ -218,3 +218,54 @@ def accepted_kwargs(
         return kwargs
     param_names = set(inspect.signature(func).parameters.keys())
     return {k: v for k, v in kwargs.items() if k in param_names}
+
+
+def get_win_shell() -> str:
+    """
+    The way installed python scripts are wrapped on Windows means shellingham will detect
+    cmd.exe as the shell. This function will attempt to detect the correct shell, usually
+    either powershell (<=v5) or pwsh (>=v6).
+
+    :raises ShellDetectionFailure: If the shell cannot be detected
+    :return: The name of the shell, either 'powershell' or 'pwsh'
+    """
+    import json
+    import platform
+    import subprocess
+
+    from shellingham import ShellDetectionFailure
+
+    assert platform.system() == "Windows"
+    pwsh = shutil.which("pwsh")
+    powershell = shutil.which("powershell")
+    if pwsh and not powershell:
+        return "pwsh"
+    elif powershell and not pwsh:
+        return "powershell"
+    try:
+        ps_command = """
+        $parent = Get-CimInstance -Query "SELECT * FROM Win32_Process WHERE ProcessId = {pid}";
+        $parentPid = $parent.ParentProcessId;
+        $parentInfo = Get-CimInstance -Query "SELECT * FROM Win32_Process WHERE ProcessId = $parentPid";
+        $parentInfo | Select-Object Name, ProcessId | ConvertTo-Json -Depth 1
+        """
+        pid = os.getpid()
+        while True:
+            result = subprocess.run(
+                ["pwsh", "-NoProfile", "-Command", ps_command.format(pid=pid)],
+                capture_output=True,
+                text=True,
+            ).stdout.strip()
+            if not result:
+                break
+            process = json.loads(result)
+            if "pwsh" in process.get("Name", ""):
+                return "pwsh"
+            elif "powershell" in process.get("Name", ""):
+                return "powershell"
+            pid = process["ProcessId"]
+
+        raise ShellDetectionFailure("Unable to detect windows shell")
+
+    except Exception as e:
+        raise ShellDetectionFailure("Unable to detect windows shell") from e

tests/test_parser_completers.py

@@ -32,7 +32,7 @@ def get_values(completion):
     elif SHELL == "bash":
         return [line.split(",")[1] for line in completion.split("\n") if line]
     elif SHELL in ["pwsh", "powershell"]:
-        return [line.split(":::")[0] for line in completion.splitlines() if line]
+        return [line.split(":::")[1] for line in completion.splitlines() if line]
     elif SHELL == "fish":
         raise NotImplementedError("Fish completion not implemented")
     raise NotImplementedError(f"get_values for shell {SHELL} not implemented")