Merge pull request #158 from satra/enh/et

enh: add etelemetry support

Author: effigies

.et

@@ -0,0 +1,2 @@
+{ "bad_versions" : []
+}

.gitignore

@@ -14,3 +14,4 @@ cov.xml
 
 .*.swp
 *~
+.idea

min-requirements.txt

@@ -1,3 +1,4 @@
 # Auto-generated by tools/update_min_requirements.py
 cloudpickle == 0.8.0
 filelock == 3.0.0
+etelemetry

pydra/__init__.py

@@ -5,3 +5,60 @@
 
 from .engine import Submitter, Workflow, AuditFlag, ShellCommandTask, DockerTask, specs
 from . import mark
+
+
+def check_latest_version(raise_exception=False):
+    """Check for the latest version of the library
+
+    parameters:
+    raise_exception: boolean
+        Raise a RuntimeError if a bad version is being used
+    """
+    import etelemetry
+    import logging
+    from pkg_resources import parse_version
+
+    logger = logging.getLogger("pydra")
+
+    INIT_MSG = "Running {packname} version {version} (latest: {latest})".format
+
+    latest = {"version": "Unknown", "bad_versions": []}
+    result = None
+    try:
+        result = etelemetry.get_project("nipype/pydra")
+    except Exception as e:
+        logger.warning("Could not check for version updates: \n%s", e)
+    finally:
+        if result:
+            latest.update(**result)
+            if parse_version(__version__) != parse_version(latest["version"]):
+                logger.info(
+                    INIT_MSG(
+                        packname="pydra", version=__version__, latest=latest["version"]
+                    )
+                )
+            if latest["bad_versions"] and any(
+                [
+                    parse_version(__version__) == parse_version(ver)
+                    for ver in latest["bad_versions"]
+                ]
+            ):
+                message = (
+                    "You are using a version of Pydra with a critical "
+                    "bug. Please use a different version."
+                )
+                if raise_exception:
+                    raise RuntimeError(message)
+                else:
+                    logger.critical(message)
+    return latest
+
+
+# Run telemetry on import for interactive sessions, such as IPython, Jupyter notebooks, Python REPL
+import __main__
+
+if not hasattr(__main__, "__file__"):
+    from .engine.core import TaskBase
+
+    if TaskBase._etelemetry_version_data is None:
+        TaskBase._etelemetry_version_data = check_latest_version()

pydra/engine/core.py

@@ -39,6 +39,7 @@
 
 class TaskBase:
     _api_version: str = "0.0.1"  # Should generally not be touched by subclasses
+    _etelemetry_version_data = None  # class variable to store etelemetry information
     _version: str  # Version of tool being wrapped
     _task_version: ty.Optional[
         str
@@ -77,6 +78,11 @@ def __init__(
         inputs : dictionary (input name, input value or list of values)
             States this node's input names
         """
+        from .. import check_latest_version
+
+        if TaskBase._etelemetry_version_data is None:
+            TaskBase._etelemetry_version_data = check_latest_version()
+
         self.name = name
         if not self.input_spec:
             raise Exception("No input_spec in class: %s" % self.__class__.__name__)

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 url = https://github.com/nipype/pydra
-author = nipype developers 
+author = nipype developers
 author_email = [email protected]
 maintainer = nipype developers
 maintainer_email = [email protected]
@@ -25,6 +25,8 @@ python_requires = >= 3.7
 install_requires =
     cloudpickle >= 0.8.0
     filelock >= 3.0.0
+    etelemetry
+
 test_requires =
     pytest >= 4.4.0
     pytest-cov
@@ -60,7 +62,7 @@ test =
     jupyter_contrib_nbextensions
 tests =
     %(test)s
-dev = 
+dev =
     %(test)s
     black
     pre-commit