Merge pull request #65 from AnswerDotAI/download

Feat: plash_download can overwrite empty dirs

Author: ncoop57

nbs/00_cli.ipynb

@@ -106,8 +106,8 @@
    "outputs": [],
    "source": [
     "#| export\n",
-    "def _mk_auth_req(url:str, method:str='get', **kwargs):\n",
-    "    r = getattr(_get_client(PLASH_CONFIG_HOME), method)(url, **kwargs)\n",
+    "def _mk_auth_req(url:str, method:str='get', timeout=300., **kwargs):\n",
+    "    r = getattr(_get_client(PLASH_CONFIG_HOME), method)(url, timeout=timeout, **kwargs)\n",
     "    if r.status_code == 200: return r\n",
     "    else: print(f'Failure: {r.headers[\"X-Plash-Error\"]}')"
    ]
@@ -406,7 +406,7 @@
     "        plash_app.write_text(f'export PLASH_APP_NAME={name}')\n",
     "    \n",
     "    tarz, _ = create_tar_archive(path, force_data)\n",
-    "    r = _mk_auth_req(_endpoint(rt=\"/upload\"), \"post\", files={'file': tarz}, timeout=300.0, \n",
+    "    r = _mk_auth_req(_endpoint(rt=\"/upload\"), \"post\", files={'file': tarz},\n",
     "                     data={'name': name, 'force_data': force_data})\n",
     "    if r:\n",
     "        print('✅ Upload complete! Your app is currently being built.')\n",
@@ -434,9 +434,9 @@
       "usage: plash_deploy [-h] [--path PATH] [--name NAME] [--force_data]\n",
       "\n",
       "Deploys app to production. By default, this command erases all files in your app which are not in data/. Then uploads\n",
-      "all files and folders, except paths starting with '.' and except the local data/ directory. If `--force data` is used,\n",
+      "all files and folders, except paths starting with `.` and except the local data/ directory. If `--force_data` is used,\n",
       "then it erases all files in production. Then it uploads all files and folders, including `data/`, except paths starting\n",
-      "with '.'.\n",
+      "with `.`.\n",
       "\n",
       "options:\n",
       "  -h, --help    show this help message and exit\n",
@@ -739,6 +739,55 @@
     "plash_logs --help"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "b8959fc4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#| hide\n",
+    "import tempfile\n",
+    "temp_dir = tempfile.TemporaryDirectory()\n",
+    "td = Path(temp_dir.name)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "f8441125",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#| export\n",
+    "@patch\n",
+    "def _is_dir_empty(self:Path): return next(self.iterdir(), None) is None"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "c18149e1",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#| hide\n",
+    "test_eq(td.is_dir_empty(), True)\n",
+    "(td/'.temp').write_text('Hello, world!')\n",
+    "test_eq(d.is_dir_empty(), False)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "e54db8a2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#| hide\n",
+    "temp_dir.cleanup()"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -754,13 +803,11 @@
     "    save_path:Path=Path(\"./download/\")): # Save path (optional)\n",
     "    'Download your deployed app'\n",
     "    if not name: name = _get_app_name(path)\n",
-    "    try: save_path.mkdir(exist_ok=False)\n",
-    "    except: print(f\"ERROR: Save path ({save_path}) already exists. Please rename or delete this folder to avoid accidental overwrites.\")\n",
-    "    else:\n",
-    "        if r := _mk_auth_req(_endpoint(rt=f'/download?name={name}')):\n",
-    "            file_bytes = io.BytesIO(r.content)\n",
-    "            with tarfile.open(fileobj=file_bytes, mode=\"r:gz\") as tar: tar.extractall(path=save_path)\n",
-    "            print(f\"Downloaded your app to: {save_path}\")        "
+    "    save_path.mkdir(exist_ok=True)\n",
+    "    if not save_path._is_dir_empty(): return print(f'ERROR: Save path ({save_path}) is not empty.')\n",
+    "    if r := _mk_auth_req(_endpoint(rt=f'/download?name={name}')):\n",
+    "        with tarfile.open(fileobj=io.BytesIO(r.content), mode=\"r:gz\") as tar: tar.extractall(path=save_path)\n",
+    "        print(f\"Downloaded your app to: {save_path}\")        "
    ]
   },
   {

plash_cli/_modidx.py

@@ -10,7 +10,8 @@
                                 'plash_cli.auth._signin_url': ('auth.html#_signin_url', 'plash_cli/auth.py'),
                                 'plash_cli.auth.goog_id_from_signin_reply': ('auth.html#goog_id_from_signin_reply', 'plash_cli/auth.py'),
                                 'plash_cli.auth.mk_signin_url': ('auth.html#mk_signin_url', 'plash_cli/auth.py')},
-            'plash_cli.cli': { 'plash_cli.cli.PlashError': ('cli.html#plasherror', 'plash_cli/cli.py'),
+            'plash_cli.cli': { 'plash_cli.cli.Path._is_dir_empty': ('cli.html#path._is_dir_empty', 'plash_cli/cli.py'),
+                               'plash_cli.cli.PlashError': ('cli.html#plasherror', 'plash_cli/cli.py'),
                                'plash_cli.cli._deps': ('cli.html#_deps', 'plash_cli/cli.py'),
                                'plash_cli.cli._endpoint': ('cli.html#_endpoint', 'plash_cli/cli.py'),
                                'plash_cli.cli._gen_app_name': ('cli.html#_gen_app_name', 'plash_cli/cli.py'),

plash_cli/cli.py

@@ -32,8 +32,8 @@ def _get_client(cookie_file):
     return client
 
 # %% ../nbs/00_cli.ipynb 8
-def _mk_auth_req(url:str, method:str='get', **kwargs):
-    r = getattr(_get_client(PLASH_CONFIG_HOME), method)(url, **kwargs)
+def _mk_auth_req(url:str, method:str='get', timeout=300., **kwargs):
+    r = getattr(_get_client(PLASH_CONFIG_HOME), method)(url, timeout=timeout, **kwargs)
     if r.status_code == 200: return r
     else: print(f'Failure: {r.headers["X-Plash-Error"]}')
 
@@ -167,7 +167,7 @@ def deploy(
         plash_app.write_text(f'export PLASH_APP_NAME={name}')
 
     tarz, _ = create_tar_archive(path, force_data)
-    r = _mk_auth_req(_endpoint(rt="/upload"), "post", files={'file': tarz}, timeout=300.0, 
+    r = _mk_auth_req(_endpoint(rt="/upload"), "post", files={'file': tarz},
                      data={'name': name, 'force_data': force_data})
     if r:
         print('✅ Upload complete! Your app is currently being built.')
@@ -240,23 +240,25 @@ def logs(
             except KeyboardInterrupt: return "\nExiting"
     if r := _mk_auth_req(_endpoint(rt=f"/logs?name={name}&mode={mode}")): return r.text
 
-# %% ../nbs/00_cli.ipynb 43
+# %% ../nbs/00_cli.ipynb 44
+@patch
+def _is_dir_empty(self:Path): return next(self.iterdir(), None) is None
+
+# %% ../nbs/00_cli.ipynb 47
 @call_parse
 def download(
     path:Path=Path('.'),                 # Path to project
     name:str=None,                       # Overrides the .plash file in project root if provided
     save_path:Path=Path("./download/")): # Save path (optional)
     'Download your deployed app'
     if not name: name = _get_app_name(path)
-    try: save_path.mkdir(exist_ok=False)
-    except: print(f"ERROR: Save path ({save_path}) already exists. Please rename or delete this folder to avoid accidental overwrites.")
-    else:
-        if r := _mk_auth_req(_endpoint(rt=f'/download?name={name}')):
-            file_bytes = io.BytesIO(r.content)
-            with tarfile.open(fileobj=file_bytes, mode="r:gz") as tar: tar.extractall(path=save_path)
-            print(f"Downloaded your app to: {save_path}")        
+    save_path.mkdir(exist_ok=True)
+    if not save_path._is_dir_empty(): return print(f'ERROR: Save path ({save_path}) is not empty.')
+    if r := _mk_auth_req(_endpoint(rt=f'/download?name={name}')):
+        with tarfile.open(fileobj=io.BytesIO(r.content), mode="r:gz") as tar: tar.extractall(path=save_path)
+        print(f"Downloaded your app to: {save_path}")        
 
-# %% ../nbs/00_cli.ipynb 46
+# %% ../nbs/00_cli.ipynb 50
 @call_parse
 def apps(verbose:bool=False):
     "List your deployed apps (verbose shows status table: 1=running, 0=stopped)"