Fix mypy windows type not defined errors

pyinvoke · achekery · Mar 12, 2024 · Mar 12, 2024 · Mar 12, 2024 · Mar 12, 2024
commit b9d50e4903d87a74095658bff870091ba009e2ae
diff --git a/invoke/terminals.py b/invoke/terminals.py
@@ -249,6 +249,36 @@
     return 1
 
 
+if sys.platform == "win32":
+
+    def _get_short_path_name(long_path: str) -> str:
+        # Access `GetShortPathNameW()` function from `kernel32.dll`.
+        GetShortPathNameW = windll.kernel32.GetShortPathNameW
+        GetShortPathNameW.argtypes = [
+            wintypes.LPCWSTR,
+            wintypes.LPWSTR,
+            wintypes.DWORD,
+        ]
+        GetShortPathNameW.restype = wintypes.DWORD
+        # Call function to get short path form.
+        buffer_size = 0
+        while True:
+            buffer_array = create_unicode_buffer(buffer_size)
+            required_size = GetShortPathNameW(
+                long_path,
+                buffer_array,
+                buffer_size,
+            )
+            if required_size > buffer_size:
+                buffer_size = required_size
+            else:
+                return buffer_array.value
+
+else:
+
+    def _get_short_path_name(long_path: str) -> str:
+        return long_path
+
 def get_short_path_name(long_path: str) -> str:
     """
     Get short path form for long path.
@@ -263,22 +293,4 @@
 
     :returns: `str` Short path form of the long path.
     """
-    if not WINDOWS:
-        return long_path
-    # Access `GetShortPathNameW()` function from `kernel32.dll`.
-    GetShortPathNameW = windll.kernel32.GetShortPathNameW
-    GetShortPathNameW.argtypes = [
-        wintypes.LPCWSTR,
-        wintypes.LPWSTR,
-        wintypes.DWORD,
-    ]
-    GetShortPathNameW.restype = wintypes.DWORD
-    # Call function to get short path form.
-    buffer_size = 0
-    while True:
-        buffer_array = create_unicode_buffer(buffer_size)
-        required_size = GetShortPathNameW(long_path, buffer_array, buffer_size)
-        if required_size > buffer_size:
-            buffer_size = required_size
-        else:
-            return buffer_array.value
+    return _get_short_path_name(long_path)
diff --git a/invoke/runners.py b/invoke/runners.py
        if self.opts["echo"]:
            self.echo(command)
        if WINDOWS:
            self.opts["shell"] = get_short_path_name(self.opts["shell"])
        # Prepare common result args.
        # TODO: I hate this. Needs a deeper separate think about tweaking
        # Runner.generate_result in a way that isn't literally just this same
diff --git a/tests/_util.py b/tests/_util.py
    def wrapper(*args, **kwargs):
        if not WINDOWS:
            skip()
        return fn(*args, **kwargs)

    return wrapper

diff --git a/tests/runners.py b/tests/runners.py

        @skip_if_posix
        def may_be_configured_with_short_path_on_windows(self):
            runner = self._runner(
                run={"shell": "C:\\Program Files\\PowerShell\\7\\pwsh.exe"}
            )
            assert runner.run(_).shell == "C:\\PROGRA~1\\POWERS~1\\7\\pwsh.exe"

        @skip_if_windows
        def may_be_configured_with_passthru_on_posix(self):
	if self.opts["echo"]:
	self.echo(command)
	if WINDOWS:
	self.opts["shell"] = get_short_path_name(self.opts["shell"])
Check warning on line 420 in invoke/runners.py Codecov / codecov/patch invoke/runners.py#L420 `Added line #L420 was not covered by tests`
	# Prepare common result args.
	# TODO: I hate this. Needs a deeper separate think about tweaking
	# Runner.generate_result in a way that isn't literally just this same
	def wrapper(args, *kwargs):
	if not WINDOWS:
	skip()
	return fn(args, *kwargs)
Check warning on line 40 in tests/_util.py Codecov / codecov/patch tests/_util.py#L40 `Added line #L40 was not covered by tests`

	return wrapper

	@skip_if_posix
	def may_be_configured_with_short_path_on_windows(self):
	runner = self._runner(
Check warning on line 237 in tests/runners.py Codecov / codecov/patch tests/runners.py#L237 `Added line #L237 was not covered by tests`
	run={"shell": "C:\\Program Files\\PowerShell\\7\\pwsh.exe"}
	)
	assert runner.run(_).shell == "C:\\PROGRA~1\\POWERS~1\\7\\pwsh.exe"
Check warning on line 240 in tests/runners.py Codecov / codecov/patch tests/runners.py#L240 `Added line #L240 was not covered by tests`

	@skip_if_windows
	def may_be_configured_with_passthru_on_posix(self):