#29 enables controlled logging (snakesay) in cli path commands, moves path sanitizing to PAPath; minor fixes

Author: caseneuve

cli/path.py

@@ -1,37 +1,44 @@
-import getpass
 import re
 import sys
+from typing import Tuple
 
 from collections import namedtuple
 from pprint import pprint
 
 import typer
 
 from pythonanywhere.files import PAPath
+from pythonanywhere.scripts_commons import get_logger
 
 app = typer.Typer()
 
 
-def standarize_path(path):
-    return path.replace("~", f"/home/{getpass.getuser()}") if path.startswith("~") else path
+def setup(path: str, quiet: bool) -> Tuple[str, PAPath]:
+    logger = get_logger(set_info=True)
+    if quiet:
+        logger.disabled = True
+    return PAPath(path)
 
 
 @app.command()
 def get(
-    path: str          = typer.Argument(..., help="Path to PythonAnywhere file or directory"),
-    only_files: bool   = typer.Option(False, "-f", "--files",   help="List only files"),
-    only_dirs: bool    = typer.Option(False, "-d", "--dirs",    help="List only directories"),
-    sort_by_type: bool = typer.Option(False, "-t", "--type",    help="Sort by type"),
+    path: str = typer.Argument(..., help="Path to PythonAnywhere file or directory"),
+    only_files: bool = typer.Option(False, "-f", "--files", help="List only files"),
+    only_dirs: bool = typer.Option(False, "-d", "--dirs", help="List only directories"),
+    sort_by_type: bool = typer.Option(False, "-t", "--type", help="Sort by type"),
     sort_reverse: bool = typer.Option(False, "-r", "--reverse", help="Sort in reverse order"),
-    raw: bool          = typer.Option(False, "-a", "--raw",     help="Print API response (if PATH is file that's the only option)"),
+    raw: bool = typer.Option(
+        False, "-a", "--raw", help="Print API response (if PATH is file that's the only option)"
+    ),
+    quiet: bool = typer.Option(False, "-q", "--quiet", help="Disable additional logging"),
 ):
     """
     Get contents of PATH.
     If PATH points to a directory, show list of it's contents.
     If PATH points to a file, print it's contents.
     """
-    path = standarize_path(path)
-    contents = PAPath(path).contents
+    pa_path = setup(path, quiet)
+    contents = pa_path.contents
 
     if contents is None:
         sys.exit(1)
@@ -47,7 +54,7 @@ def get(
     if sort_reverse or sort_by_type:
         data.sort(key=lambda x: x.type if sort_by_type else x.name, reverse=sort_reverse)
 
-    typer.echo(f"{path}:")
+    typer.echo(f"{pa_path.path}:")
     for name, type_ in data:
         if item == "every":
             typer.echo(f"{type_[0].upper()}  {name}")
@@ -79,14 +86,19 @@ def _format_tree(data, current):
 
 
 @app.command()
-def tree(path: str = typer.Argument(..., help="Path to PythonAnywhere file or directory")):
-    path = standarize_path(path)
-    tree = PAPath(path).tree
+def tree(
+    path: str = typer.Argument(..., help="Path to PythonAnywhere file or directory"),
+    quiet: bool = typer.Option(False, "-q", "--quiet", help="Disable additional logging")
+):
+    pa_path = setup(path, quiet)
+    tree = pa_path.tree
 
     if tree is not None:
-        typer.echo(f"{path}:")
+        typer.echo(f"{pa_path.path}:")
         typer.echo(".")
-        typer.echo(_format_tree(tree, path))
+        typer.echo(_format_tree(tree, pa_path.path))
+    else:
+        sys.exit(1)
 
 
 @app.command()
@@ -104,47 +116,44 @@ def upload(
         "--contents",
         help="Path to exisitng file or stdin stream that should be uploaded to PATH"
     ),
+    quiet: bool = typer.Option(False, "-q", "--quiet", help="Disable additional logging")
 ):
-    path = standarize_path(path)
-    pa_path = PAPath(path)
-
+    pa_path = setup(path, quiet)
     success = pa_path.upload(file)
-
     sys.exit(0 if success else 1)
 
 
 @app.command()
 def delete(
     path: str = typer.Argument(..., help="Path to PythonAnywhere file or directory to be deleted"),
+    quiet: bool = typer.Option(False, "-q", "--quiet", help="Disable additional logging")
 ):
-    path = standarize_path(path)
-    pa_path = PAPath(path)
-
+    pa_path = setup(path, quiet)
     success = pa_path.delete()
-
     sys.exit(0 if success else 1)
 
 
 @app.command()
 def share(
     path: str = typer.Argument(..., help="Path to PythonAnywhere file to be shared"),
-    check: bool = typer.Option(False, "-c", "--check", help="Check sharing status")
+    check: bool = typer.Option(False, "-c", "--check", help="Check sharing status"),
+    porcelain: bool = typer.Option(False, "-p", "--porcelain", help="Return sharing url in easy-to-parse format"),
+    quiet: bool = typer.Option(False, "-q", "--quiet", help="Disable logging"),
 ):
-    path = standarize_path(path)
-    pa_path = PAPath(path)
-
+    pa_path = setup(path, quiet or porcelain)
     link = pa_path.get_sharing_url() if check else pa_path.share()
 
     if not link:
         sys.exit(1)
-    typer.echo(link)
+    if porcelain:
+        typer.echo(link)
 
 
 @app.command()
-def unshare(path: str = typer.Argument(..., help="Path to PythonAnywhere file to be unshared")):
-    path = standarize_path(path)
-    pa_path = PAPath(path)
-
+def unshare(
+    path: str = typer.Argument(..., help="Path to PythonAnywhere file to be unshared"),
+    quiet: bool = typer.Option(False, "-q", "--quiet", help="Disable additional logging")
+):
+    pa_path = setup(path, quiet)
     success = pa_path.unshare()
-
     sys.exit(0 if success else 1)

pythonanywhere/api/files_api.py

@@ -3,7 +3,6 @@
 `pythonanywhere.files.Path` class instead."""
 
 import getpass
-from os import path
 from urllib.parse import urljoin
 
 from pythonanywhere.api.base import call_api, get_api_endpoint

pythonanywhere/files.py

@@ -2,13 +2,14 @@
 Provides a class `PAPath` which should be used by helper scripts
 providing features for programmatic handling of user's files."""
 
+import getpass
 import logging
 from urllib.parse import urljoin
 
 from pythonanywhere.api.files_api import Files
 from pythonanywhere.snakesay import snakesay
 
-logger = logging.getLogger(name=__name__)
+logger = logging.getLogger("pythonanywhere")
 
 
 class PAPath:
@@ -37,7 +38,7 @@ class PAPath:
     be created with :method:`PAPath.upload`."""
 
     def __init__(self, path):
-        self.path = path
+        self.path = self._standarize_path(path)
         self.api = Files()
 
     def __repr__(self):
@@ -46,6 +47,10 @@ def __repr__(self):
     def _make_sharing_url(self, path):
         return urljoin(self.api.base_url.split("api")[0], path)
 
+    def _standarize_path(self, path):
+        return path.replace("~", f"/home/{getpass.getuser()}") if path.startswith("~") else path
+
+
     @property
     def url(self):
         """Returns url to PythonAnywhere for `self.path`.  Does not
@@ -135,25 +140,28 @@ def get_sharing_url(self):
 
         url = self.api.sharing_get(self.path)
         if url:
-            logger.info(snakesay(f"{self.path} is shared at {url}"))
-            return self._make_sharing_url(url)
+            sharing_url = self._make_sharing_url(url)
+            logger.info(snakesay(f"{self.path} is shared at {sharing_url}"))
+            return sharing_url
 
         logger.info(snakesay(f"{self.path} has not been shared"))
+
         return ""
 
     def share(self):
         """Returns PythonAnywhere sharing link for `self.path` or an
         empty string when share not successful."""
 
         try:
-            code, shared_url = self.api.sharing_post(self.path)
+            code, url = self.api.sharing_post(self.path)
         except Exception as e:
             logger.warning(snakesay(str(e)))
             return ""
 
         msg = {200: "was already", 201: "successfully"}[code]
-        logger.info(snakesay(f"{self.path} {msg} shared at {shared_url}"))
-        return self._make_sharing_url(shared_url)
+        sharing_url = self._make_sharing_url(url)
+        logger.info(snakesay(f"{self.path} {msg} shared at {sharing_url}"))
+        return sharing_url
 
     def unshare(self):
         """Returns `True` when file unshared or has not been shared,