feat: inform function for printing information

Author: machow

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

@@ -11,6 +11,8 @@
 
 from .config import get_cache_dir
 
+_log = logging.getLogger(__name__)
+
 
 # used if needed to preserve board path structure in the cache
 PLACEHOLDER_VERSION = "v"
@@ -65,7 +67,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 +202,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,7 +215,7 @@ 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"

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: