Merge pull request #305 from mszhanyi/master

windows compatibility for run

Author: jph00

fastcore/xtras.py

@@ -162,10 +162,20 @@ def repo_details(url):
     return res.split('/')[-2:]
 
 # Cell
-def run(cmd, *rest, ignore_ex=False, as_bytes=False, stderr=False):
+def run(cmd, *rest, same_in_win=False, ignore_ex=False, as_bytes=False, stderr=False):
     "Pass `cmd` (splitting with `shlex` if string) to `subprocess.run`; return `stdout`; raise `IOError` if fails"
-    if rest: cmd = (cmd,)+rest
-    elif isinstance(cmd,str): cmd = shlex.split(cmd)
+    # Even the command is same on Windows, we have to add `cmd /c `"
+    import logging
+    if rest:
+        if sys.platform == 'win32' and same_in_win:
+            cmd = ('cmd', '/c', cmd, *rest)
+        else:
+            cmd = (cmd,)+rest
+    elif isinstance(cmd, str):
+        if sys.platform == 'win32' and same_in_win: cmd = 'cmd /c ' + cmd
+        cmd = shlex.split(cmd)
+    elif isinstance(cmd, list):
+        if sys.platform == 'win32' and same_in_win: cmd = ['cmd', '/c'] + cmd
     res = subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
     stdout = res.stdout
     if stderr and res.stderr: stdout += b' ;; ' + res.stderr

nbs/03_xtras.ipynb

@@ -618,7 +618,7 @@
     {
      "data": {
       "text/plain": [
-       "['c', 'f', 'e', 'g', 'h', 'b', 'd', 'a']"
+       "['c', 'h', 'f', 'a', 'g', 'd', 'b', 'e']"
       ]
      },
      "execution_count": null,
@@ -1045,10 +1045,20 @@
    "outputs": [],
    "source": [
     "#export\n",
-    "def run(cmd, *rest, ignore_ex=False, as_bytes=False, stderr=False):\n",
+    "def run(cmd, *rest, same_in_win=False, ignore_ex=False, as_bytes=False, stderr=False):\n",
     "    \"Pass `cmd` (splitting with `shlex` if string) to `subprocess.run`; return `stdout`; raise `IOError` if fails\"\n",
-    "    if rest: cmd = (cmd,)+rest\n",
-    "    elif isinstance(cmd,str): cmd = shlex.split(cmd)\n",
+    "    # Even the command is same on Windows, we have to add `cmd /c `\"\n",
+    "    import logging\n",
+    "    if rest: \n",
+    "        if sys.platform == 'win32' and same_in_win: \n",
+    "            cmd = ('cmd', '/c', cmd, *rest)\n",
+    "        else:\n",
+    "            cmd = (cmd,)+rest\n",
+    "    elif isinstance(cmd, str):\n",
+    "        if sys.platform == 'win32' and same_in_win: cmd = 'cmd /c ' + cmd\n",
+    "        cmd = shlex.split(cmd)\n",
+    "    elif isinstance(cmd, list):\n",
+    "        if sys.platform == 'win32' and same_in_win: cmd = ['cmd', '/c'] + cmd\n",
     "    res = subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)\n",
     "    stdout = res.stdout\n",
     "    if stderr and res.stderr: stdout += b' ;; ' + res.stderr\n",
@@ -1069,7 +1079,54 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "popenargs (['cmd', '/c', 'echo'],)\n",
+      "kwargs {'stdout': -1, 'stderr': -1}\n",
+      "popenargs (('cmd', '/c', 'pip', '--version'),)\n",
+      "kwargs {'stdout': -1, 'stderr': -1}\n",
+      "popenargs (['cmd', '/c', 'pip', '--version'],)\n",
+      "kwargs {'stdout': -1, 'stderr': -1}\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'pip 21.0.1 from D:\\\\programs\\\\envs\\\\nbdev\\\\lib\\\\site-packages\\\\pip (python 3.8)'"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "run('echo', same_in_win=True)\n",
+    "run('pip', '--version', same_in_win=True)\n",
+    "run(['pip', '--version'], same_in_win=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "popenargs (['cmd', '/c', 'dir', '/p'],)\n",
+      "kwargs {'stdout': -1, 'stderr': -1}\n",
+      "popenargs (['cmd', '/c', 'dir', '/p'],)\n",
+      "kwargs {'stdout': -1, 'stderr': -1}\n",
+      "popenargs (('cmd', '/c', 'dir', '/p'),)\n",
+      "kwargs {'stdout': -1, 'stderr': -1}\n"
+     ]
+    }
+   ],
    "source": [
     "if sys.platform == 'win32':\n",
     "    assert 'ipynb' in run('cmd /c dir /p')\n",
@@ -1092,7 +1149,16 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "popenargs (['cmd', '/c', 'findstr', 'asdfds', '00_test.ipynb'],)\n",
+      "kwargs {'stdout': -1, 'stderr': -1}\n"
+     ]
+    }
+   ],
    "source": [
     "if sys.platform == 'win32':\n",
     "    test_eq(run('cmd /c findstr asdfds 00_test.ipynb', ignore_ex=True)[0], 1)\n",
@@ -1111,10 +1177,19 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "popenargs (['cmd', '/c', 'echo', 'hi'],)\n",
+      "kwargs {'stdout': -1, 'stderr': -1}\n"
+     ]
+    }
+   ],
    "source": [
     "if sys.platform == 'win32':\n",
-    "    # why I ignore as_types, because every time nbdev_clean_nbs will update \\n to \\nn\n",
+    "    # why I ignore as_types, because every time nbdev_clean_nbs will update \\n to \\r\\n\n",
     "    test_eq(run('cmd /c echo hi'), 'hi')\n",
     "else:\n",
     "    test_eq(run('echo hi', as_bytes=True), b'hi\\n')"
@@ -1298,7 +1373,7 @@
     {
      "data": {
       "text/plain": [
-       "(Path('../fastcore/__init__.py'), Path('01_basics.ipynb'))"
+       "(Path('../fastcore/all.py'), Path('00_test.ipynb'))"
       ]
      },
      "execution_count": null,
@@ -1575,8 +1650,8 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Num Events: 8, Freq/sec: 423.0\n",
-      "Most recent:  ▂▂▁▁▇ 318.5 319.0 266.9 275.6 427.7\n"
+      "Num Events: 1, Freq/sec: 62.9\n",
+      "Most recent:  ▃▇▃▁▃ 31.3 31.9 31.4 30.8 31.3\n"
      ]
     }
    ],
@@ -1725,7 +1800,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "2000-01-01 12:00:00 UTC is 2000-01-01 12:00:00+00:00 local time\n"
+      "2000-01-01 12:00:00 UTC is 2000-01-01 04:00:00-08:00 local time\n"
      ]
     }
    ],
@@ -1755,7 +1830,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "2000-01-01 12:00:00 local is 2000-01-01 12:00:00+00:00 UTC time\n"
+      "2000-01-01 12:00:00 local is 2000-01-01 20:00:00+00:00 UTC time\n"
      ]
     }
    ],