ENH: add option to silence printing

Author: mgxd

.github/workflows/pythonpackage.yml

@@ -55,7 +55,7 @@ jobs:
         source /tmp/install_sdist/bin/activate
         python -m pip install "setuptools ~= 42.0" "pip>=10.0.1"
         python -m pip install dist/templateflow*.tar.gz
-        INSTALLED_VERSION=$(python -c 'import templateflow as tf; print(tf.__version__, end="")' | tail -1)
+        INSTALLED_VERSION=$(python -c 'import templateflow as tf; print(tf.__version__, end="")')
         echo "VERSION: \"${THISVERSION}\""
         echo "INSTALLED: \"${INSTALLED_VERSION}\""
         test "${INSTALLED_VERSION}" = "${THISVERSION}"
@@ -87,7 +87,7 @@ jobs:
         source /tmp/install_wheel/bin/activate
         python -m pip install "setuptools ~= 42.0" "pip>=10.0.1"
         python -m pip install dist/templateflow*.whl
-        INSTALLED_VERSION=$(python -c 'import templateflow as tf; print(tf.__version__, end="")' | tail -1)
+        INSTALLED_VERSION=$(python -c 'import templateflow as tf; print(tf.__version__, end="")')
         echo "INSTALLED: \"${INSTALLED_VERSION}\""
         test "${INSTALLED_VERSION}" = "${THISVERSION}"
 
@@ -121,7 +121,7 @@ jobs:
         python -m pip install "setuptools ~= 42.0" wheel "setuptools_scm[toml] >= 3.4" \
                               setuptools_scm_git_archive "pip>=10.0.1"
         python setup.py install
-        INSTALLED_VERSION=$(python -c 'import templateflow as tf; print(tf.__version__, end="")' | tail -1)
+        INSTALLED_VERSION=$(python -c 'import templateflow as tf; print(tf.__version__, end="")')
         echo "INSTALLED: \"${INSTALLED_VERSION}\""
         test "${INSTALLED_VERSION}" = "${THISVERSION}"
 
@@ -153,7 +153,7 @@ jobs:
         python -m pip install "setuptools ~= 42.0" wheel "setuptools_scm[toml] >= 3.4" \
                               setuptools_scm_git_archive "pip>=10.0.1"
         python setup.py develop
-        INSTALLED_VERSION=$(python -c 'import templateflow as tf; print(tf.__version__, end="")' | tail -1)
+        INSTALLED_VERSION=$(python -c 'import templateflow as tf; print(tf.__version__, end="")')
         echo "INSTALLED: \"${INSTALLED_VERSION}\""
         test "${INSTALLED_VERSION}" = "${THISVERSION}"
 

.travis.yml

@@ -66,7 +66,7 @@ script:
       INTENDED_VERSION="$(python setup.py --version)"
       mkdir for_testing
       cd for_testing
-      INSTALLED_VERSION="$(python -c 'import templateflow; print(templateflow.__version__)' | tail -1)"
+      INSTALLED_VERSION="$(python -c 'import templateflow; print(templateflow.__version__)')"
       python -c 'import templateflow; print(templateflow.__file__)'
       echo "Intended: $INTENDED_VERSION"
       echo "Installed: $INSTALLED_VERSION"

templateflow/__init__.py

@@ -27,8 +27,7 @@
     "n",
 ):
     # trigger skeleton autoupdate
-    update(local=True, overwrite=False)
-
+    update(local=True, overwrite=False, silent=True)
 
 __all__ = [
     '__copyright__',

templateflow/conf/__init__.py

@@ -42,14 +42,14 @@
         _update_s3(TF_HOME, local=True, overwrite=True)
 
 
-def update(local=False, overwrite=True):
+def update(local=False, overwrite=True, silent=False):
     """Update an existing DataLad or S3 home."""
     if TF_USE_DATALAD and _update_datalad():
         return True
 
     from ._s3 import update as _update_s3
 
-    return _update_s3(TF_HOME, local=local, overwrite=overwrite)
+    return _update_s3(TF_HOME, local=local, overwrite=overwrite, silent=silent)
 
 
 def setup_home(force=False):

templateflow/conf/_s3.py

@@ -13,11 +13,11 @@
 ).read_text()
 
 
-def update(dest, local=True, overwrite=True):
+def update(dest, local=True, overwrite=True, silent=False):
     """Update an S3-backed TEMPLATEFLOW_HOME repository."""
     skel_file = Path((_get_skeleton_file() if not local else None) or TF_SKEL_PATH)
 
-    retval = _update_skeleton(skel_file, dest, overwrite=overwrite)
+    retval = _update_skeleton(skel_file, dest, overwrite=overwrite, silent=silent)
     if skel_file != TF_SKEL_PATH:
         skel_file.unlink()
     return retval
@@ -45,7 +45,7 @@ def _get_skeleton_file():
             return skel_file
 
 
-def _update_skeleton(skel_file, dest, overwrite=True):
+def _update_skeleton(skel_file, dest, overwrite=True, silent=False):
     from zipfile import ZipFile
 
     dest = Path(dest)
@@ -62,11 +62,12 @@ def _update_skeleton(skel_file, dest, overwrite=True):
         ]
         newfiles = sorted(set(allfiles) - set(existing))
         if newfiles:
-            print(
-                "Updating TEMPLATEFLOW_HOME using S3. "
-                "Adding: \n%s" % "\n".join(newfiles)
-            )
+            if not silent:
+                print(
+                    "Updating TEMPLATEFLOW_HOME using S3. Adding:\n%s" % '\n'.join(newfiles)
+                )
             zipref.extractall(str(dest), members=newfiles)
             return True
-    print("TEMPLATEFLOW_HOME directory (S3 type) was up-to-date.")
+    if not silent:
+        print("TEMPLATEFLOW_HOME directory (S3 type) was up-to-date.")
     return False