Merge pull request #105 from machow/chore-prompts-logs

Chore prompts logs

Author: machow

pins/__init__.py

@@ -10,7 +10,7 @@
 
 # Imports ----
 from .boards import BaseBoard
-from .cache import PinsCache, PinsUrlCache, cache_prune
+from .cache import PinsCache, PinsUrlCache, cache_prune, cache_info
 from .constructors import (
     board_deparse,
     board_folder,

pins/boards.py

@@ -15,6 +15,10 @@
 from .meta import Meta, MetaRaw, MetaFactory
 from .errors import PinsError
 from .drivers import load_data, save_data, default_title
+from .utils import inform
+
+
+_log = logging.getLogger(__name__)
 
 
 # Note that once we drop python 3.7, we can make this a Protocol
@@ -292,6 +296,8 @@ def pin_write(
                     "but that directory already exists."
                 )
 
+            inform(_log, f"Writing to pin {repr(pin_name)}")
+
             res = self.fs.put(tmp_dir, dst_version_path, recursive=True)
 
         if dst_version_path == dst_pin_path:
@@ -391,9 +397,9 @@ def pin_versions_prune(
         # TODO(question): how to pin_inform? Log or warning?
         if to_delete:
             str_vers = ", ".join([v.version for v in to_delete])
-            logging.info(f"Deleting versions: {str_vers}.")
+            inform(_log, f"Deleting versions: {str_vers}.")
         if not to_delete:
-            logging.info("No old versions to delete")
+            inform(_log, "No old versions to delete")
 
         for version in to_delete:
             self.pin_version_delete(name, version.version)

pins/cache.py

@@ -10,6 +10,9 @@
 from pathlib import Path
 
 from .config import get_cache_dir
+from .utils import inform
+
+_log = logging.getLogger(__name__)
 
 
 # used if needed to preserve board path structure in the cache
@@ -65,7 +68,7 @@ def _make_local_details(self, path):
         # note that this is called in ._open(), at the point it's known the file
         # will be cached
         fn = super()._make_local_details(path)
-        logging.info(f"cache file: {fn}")
+        _log.info(f"cache file: {fn}")
         Path(fn).parent.mkdir(parents=True, exist_ok=True)
 
         return fn
@@ -200,7 +203,7 @@ def prune(self, days=30):
             for path in to_prune:
                 delete_version(to_prune)
 
-        logging.info("Skipping cache deletion")
+        _log.info("Skipping cache deletion")
 
 
 def delete_version(path: "str | Path"):
@@ -213,10 +216,28 @@ def disk_usage(path):
 
 
 def prompt_cache_prune(to_prune, size) -> bool:
-    logging.info(f"Pruning items: {to_prune}")
+    _log.info(f"Pruning items: {to_prune}")
     human_size = humanize.naturalsize(size, binary=True)
-    resp = input(f"Delete {len(to_prune)} pin versions, freeing {human_size}?")
-    return resp == "yes"
+    resp = input(
+        f"Delete {len(to_prune)} pin versions, freeing {human_size}?"
+        "\n1: Yes"
+        "\n2: No"
+        "\n\nSelection: "
+    )
+    return resp == "1"
+
+
+def cache_info():
+    cache_root = get_cache_dir()
+
+    cache_boards = list(Path(cache_root).glob("*"))
+
+    print(f"Cache info: {cache_root}")
+    for p_board in cache_boards:
+        du = disk_usage(p_board)
+        human_size = humanize.naturalsize(du, binary=True)
+        rel_path = p_board.relative_to(cache_root)
+        print(f"* {rel_path}: {human_size}")
 
 
 def cache_prune(days=30, cache_root=None, prompt=True):
@@ -230,32 +251,21 @@ def cache_prune(days=30, cache_root=None, prompt=True):
 
     size = sum(map(disk_usage, final_delete))
 
+    if not final_delete:
+        inform(_log, "No stale pins found")
+
     if prompt:
         confirmed = prompt_cache_prune(final_delete, size)
     else:
         confirmed = True
+
     if confirmed:
+        inform(_log, "Deleting pins from cache.")
         for p in final_delete:
             delete_version(p)
+    else:
+        inform(_log, "Skipping deletion of pins from cache.")
 
 
-# def prune_files(days = 30, path = None):
-#     if path is None:
-#         for p_cache in Path(get_cache_dir()).glob("*"):
-#             return prune_files(days=days, path=str(p_cache.absolute()))
-#
-#     expiry_time_sec = days * 60 * 60 * 24
-#     fs_cache = PinsCache(
-#         target_protocol=None,
-#         cache_storage=path,
-#         check_files=True,
-#         expiry_time=expiry_time_sec
-#     )
-#
-#     # note that fsspec considers only the last entry in cached_files deletable
-#     for hash_path, entry in fs_cache.cached_files[-1].items():
-#         if time.time() - detail["time"] > self.expiry:
-#             fs_cache.pop_from_cache(entry["original"])
-
 # TODO: swap to use entrypoint
 register_implementation("pinscache", PinsCache)

pins/config.py

@@ -1,11 +1,15 @@
 import appdirs
 import os
 
+from types import SimpleNamespace
+
 PINS_NAME = "pins-py"
 PINS_ENV_DATA_DIR = "PINS_DATA_DIR"
 PINS_ENV_CACHE_DIR = "PINS_CACHE_DIR"
 PINS_ENV_INSECURE_READ = "PINS_ALLOW_PICKLE_READ"
 
+pins_options = SimpleNamespace(quiet=False)
+
 
 def get_data_dir():
     return os.environ.get(PINS_ENV_DATA_DIR, appdirs.user_data_dir(PINS_NAME))
@@ -29,12 +33,3 @@ def get_allow_pickle_read(flag):
         flag = bool(env_int)
 
     return flag
-
-
-def _enable_logs():
-    import logging
-
-    format = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
-    handlers = [logging.FileHandler("filename.log"), logging.StreamHandler()]
-
-    logging.basicConfig(level=logging.INFO, format=format, handlers=handlers)

pins/rsconnect/api.py

@@ -18,6 +18,8 @@
 RSC_CODE_OBJECT_DOES_NOT_EXIST = 4
 RSC_CODE_INVALID_NUMERIC_PATH = 3
 
+_log = logging.getLogger(__name__)
+
 
 def _download_file(response, local_fname):
     """Download a potentially large file. Note that this mutates the response.
@@ -222,7 +224,7 @@ def _raw_query(self, url, method="GET", return_request=False, **kwargs):
 
         headers = self._get_headers()
 
-        logging.info(f"RSConnect API {method}: {url} -- {kwargs}")
+        _log.debug(f"RSConnect API {method}: {url} -- {kwargs}")
         r = self.session.request(method, url, headers=headers, **kwargs)
 
         if return_request:

pins/tests/test_utils.py

@@ -0,0 +1,25 @@
+import pytest
+
+from pins.utils import inform
+from pins.config import pins_options
+
+
+@pytest.fixture
+def quiet():
+    orig = pins_options.quiet
+    pins_options.quiet = True
+    yield
+    pins_options.quiet = orig
+
+
+def test_inform(capsys):
+    msg = "a message"
+    inform(None, msg)
+    captured = capsys.readouterr()
+    assert captured.err == msg + "\n"
+
+
+def test_inform_quiet(quiet, capsys):
+    inform(None, "a message")
+    captured = capsys.readouterr()
+    assert captured.err == ""

pins/utils.py

@@ -0,0 +1,11 @@
+import sys
+
+from .config import pins_options
+
+
+def inform(log, msg):
+    if log is not None:
+        log.info(msg)
+
+    if not pins_options.quiet:
+        print(msg, file=sys.stderr)