Merge pull request #153 from simvue-io/feature/148-add-checkextra-decorator

Use `check_extra` decorator as user alert

Author: alahiff

simvue/client.py

@@ -5,7 +5,7 @@
 import requests
 
 from .serialization import Deserializer
-from .utilities import get_auth, get_server_version
+from .utilities import get_auth, get_server_version, check_extra
 from .converters import to_dataframe, metrics_to_dataframe
 
 CONCURRENT_DOWNLOADS = 10
@@ -433,7 +433,8 @@ def get_metrics_multiple(self, runs, names, xaxis, max_points=0, aggregate=False
             return data
 
         raise Exception(response.text)
-        
+    
+    @check_extra("plot")
     def plot_metrics(self, runs, names, xaxis, max_points=0):
         """
         Plot time series metrics from multiple runs and/or metrics

simvue/serialization.py

@@ -1,6 +1,8 @@
 from io import BytesIO
 import pickle
-import plotly
+
+
+from .utilities import check_extra
 
 class Serializer:
     def serialize(self, data, allow_pickle=False):
@@ -51,16 +53,27 @@ def get_serializer(data, allow_pickle):
         return _serialize_pickle
     return None
 
+@check_extra("plot")
 def _serialize_plotly_figure(data):
+    try:
+        import plotly
+    except ImportError:
+        return
     mimetype = 'application/vnd.plotly.v1+json'
     data = plotly.io.to_json(data, 'json')
     return data, mimetype
 
+@check_extra("plot")
 def _serialize_matplotlib_figure(data):
+    try:
+        import plotly
+    except ImportError:
+        return None
     mimetype = 'application/vnd.plotly.v1+json'
     data = plotly.io.to_json(plotly.tools.mpl_to_plotly(data), 'json')
     return data, mimetype
 
+@check_extra("dataset")
 def _serialize_numpy_array(data):
     try:
         import numpy as np
@@ -75,6 +88,7 @@ def _serialize_numpy_array(data):
     data = mfile.read()
     return data, mimetype
 
+@check_extra("dataset")
 def _serialize_dataframe(data):
     mimetype = 'application/vnd.simvue.df.v1'
     mfile = BytesIO()
@@ -83,6 +97,7 @@ def _serialize_dataframe(data):
     data = mfile.read()
     return data, mimetype
 
+@check_extra("torch")
 def _serialize_torch_tensor(data):
     try:
         import torch
@@ -127,14 +142,25 @@ def get_deserializer(mimetype, allow_pickle):
         return _deserialize_pickle
     return None
 
+@check_extra("plot")
 def _deserialize_plotly_figure(data):
+    try:
+        import plotly
+    except ImportError:
+        return None
     data = plotly.io.from_json(data)
     return data
 
+@check_extra("plot")
 def _deserialize_matplotlib_figure(data):
+    try:
+        import plotly
+    except ImportError:
+        return None
     data = plotly.io.from_json(data)
     return data
 
+@check_extra("dataset")
 def _deserialize_numpy_array(data):
     try:
         import numpy as np
@@ -147,6 +173,7 @@ def _deserialize_numpy_array(data):
     data = np.load(mfile, allow_pickle=False)
     return data
 
+@check_extra("dataset")
 def _deserialize_dataframe(data):
     try:
         import pandas as pd
@@ -159,6 +186,7 @@ def _deserialize_dataframe(data):
     data = pd.read_csv(mfile, index_col=0)
     return data
 
+@check_extra("torch")
 def _deserialize_torch_tensor(data):
     try:
         import torch

simvue/utilities.py

@@ -3,9 +3,36 @@
 import logging
 import os
 import requests
+import typing
 
 logger = logging.getLogger(__name__)
 
+def check_extra(extra_name: str) -> typing.Callable:
+    def decorator(class_func: typing.Callable) -> typing.Callable:
+        def wrapper(self, *args, **kwargs) -> typing.Any:
+            if extra_name == "plot":
+                try:
+                    import matplotlib
+                    import plotly
+                except ImportError:
+                    raise RuntimeError(f"Plotting features require the '{extra_name}' extension to Simvue")
+            elif extra_name == "torch":
+                try:
+                    import torch
+                except ImportError:
+                    raise RuntimeError(f"PyTorch features require the '{extra_name}' extension to Simvue")
+            elif extra_name == "pandas":
+                try:
+                    import pandas
+                    import numpy
+                except ImportError:
+                    raise RuntimeError(f"Dataset features require the '{extra_name}' extension to Simvue")
+            else:
+                raise RuntimeError(f"Unrecognised extra '{extra_name}'")
+            return class_func(self, *args, **kwargs)
+        return wrapper
+    return decorator
+
 def get_auth():
     """
     Get the URL and access token