Removed disabled & offline options, added mode instead

Author: alahiff

simvue/run.py

@@ -126,8 +126,8 @@ class Run(object):
     """
     Track simulation details based on token and URL
     """
-    def __init__(self, disabled=False):
-        self._disabled = disabled
+    def __init__(self, mode='online'):
+        self._mode = mode
         self._name = None
         self._suppress_errors = False
         self._queue_blocking = False
@@ -144,7 +144,6 @@ def __init__(self, disabled=False):
         self._url, self._token = get_auth()
         self._headers = {"Authorization": f"Bearer {self._token}"}
         self._simvue = None
-        self._offline = False
 
     def __enter__(self):
         return self
@@ -157,7 +156,7 @@ def _start(self, reconnect=False):
         """
         Start a run
         """
-        if self._disabled:
+        if self._mode == 'disabled':
             return True
 
         data = {'name': self._name, 'status': self._status}
@@ -171,7 +170,7 @@ def _start(self, reconnect=False):
 
         self._metrics_queue = multiprocessing.Manager().Queue(maxsize=self._queue_size)
         self._events_queue = multiprocessing.Manager().Queue(maxsize=self._queue_size)
-        self._worker = Worker(self._metrics_queue, self._events_queue, self._name, self._url, self._headers, self._offline)
+        self._worker = Worker(self._metrics_queue, self._events_queue, self._name, self._url, self._headers, self._mode)
 
         if multiprocessing.current_process()._parent_pid is None:
             self._worker.start()
@@ -187,11 +186,11 @@ def _error(self, message):
         else:
             logger.error(message)
 
-    def init(self, name=None, metadata={}, tags=[], description=None, folder='/', running=True, offline=False):
+    def init(self, name=None, metadata={}, tags=[], description=None, folder='/', running=True):
         """
         Initialise a run
         """
-        if self._disabled:
+        if self._mode == 'disabled':
             return True
 
         if not name:
@@ -210,7 +209,6 @@ def init(self, name=None, metadata={}, tags=[], description=None, folder='/', ru
             self._error('metadata must be a dict')
 
         self._name = name
-        self._offline = offline
 
         if running:
             self._status = 'running'
@@ -236,7 +234,7 @@ def init(self, name=None, metadata={}, tags=[], description=None, folder='/', ru
         if self._status == 'running':
             data['system'] = get_system()
 
-        self._simvue = Simvue(self._name, self._offline, self._suppress_errors)
+        self._simvue = Simvue(self._name, self._mode, self._suppress_errors)
         if not self._simvue.create_run(data):
             return False
 
@@ -252,17 +250,16 @@ def name(self):
         """
         return self._name
 
-    def reconnect(self, name, offline=False):
+    def reconnect(self, name):
         """
         Reconnect to a run in the created state
         """
-        if self._disabled:
+        if self._mode == 'disabled':
             return True
 
         self._status = 'running'
-        self._offline = offline
         self._name = name
-        self._simvue = Simvue(self._name, self._offline, self._suppress_errors)
+        self._simvue = Simvue(self._name, self._mode, self._suppress_errors)
         self._start(reconnect=True)
 
     def config(self,
@@ -288,7 +285,7 @@ def update_metadata(self, metadata):
         """
         Add/update metadata
         """
-        if self._disabled:
+        if self._mode == 'disabled':
             return True
 
         if not self._name:
@@ -314,7 +311,7 @@ def update_tags(self, tags):
         """
         Add/update tags
         """
-        if self._disabled:
+        if self._mode == 'disabled':
             return True
 
         if not self._name:
@@ -336,7 +333,7 @@ def log_event(self, message, timestamp=None):
         """
         Write event
         """
-        if self._disabled:
+        if self._mode == 'disabled':
             return True
 
         if not self._name:
@@ -373,7 +370,7 @@ def log_metrics(self, metrics, step=None, time=None, timestamp=None):
         """
         Write metrics
         """
-        if self._disabled:
+        if self._mode == 'disabled':
             return True
 
         if not self._name:
@@ -424,7 +421,7 @@ def save(self, filename, category, filetype=None, preserve_path=False):
         """
         Upload file
         """
-        if self._disabled:
+        if self._mode == 'disabled':
             return True
 
         if not self._name:
@@ -483,7 +480,7 @@ def save_directory(self, directory, category, filetype=None, preserve_path=False
         """
         Upload a whole directory
         """
-        if self._disabled:
+        if self._mode == 'disabled':
             return True
 
         if not self._name:
@@ -518,7 +515,7 @@ def save_all(self, items, category, filetype=None, preserve_path=False):
         """
         Save the list of files and/or directories
         """
-        if self._disabled:
+        if self._mode == 'disabled':
             return True
 
         for item in items:
@@ -533,7 +530,7 @@ def set_status(self, status):
         """
         Set run status
         """
-        if self._disabled:
+        if self._mode == 'disabled':
             return True
 
         if not self._name:
@@ -559,7 +556,7 @@ def close(self):
         """
         Close the run
         """
-        if self._disabled:
+        if self._mode == 'disabled':
             return True
 
         if not self._name:
@@ -576,7 +573,7 @@ def set_folder_details(self, path, metadata={}, tags=[], description=None):
         """
         Add metadata to the specified folder
         """
-        if self._disabled:
+        if self._mode == 'disabled':
             return True
 
         if not self._name:
@@ -626,7 +623,7 @@ def add_alert(self,
         """
         Creates an alert with the specified name (if it doesn't exist) and applies it to the current run
         """
-        if self._disabled:
+        if self._mode == 'disabled':
             return True
 
         if not self._name:

simvue/simvue.py

@@ -1,8 +1,8 @@
 from .remote import Remote
 from .offline import Offline
 
-def Simvue(name, offline=False, suppress_errors=False):
-    if offline:
+def Simvue(name, mode, suppress_errors=False):
+    if mode == 'offline':
         return Offline(name, suppress_errors=False)
     else:
         return Remote(name, suppress_errors=False)

simvue/worker.py

@@ -13,7 +13,7 @@
 MAX_BUFFER_SEND = 5000
 
 class Worker(threading.Thread):
-    def __init__(self, metrics_queue, events_queue, name, url, headers, offline=False):
+    def __init__(self, metrics_queue, events_queue, name, url, headers, mode):
         threading.Thread.__init__(self)
         self._parent_thread = threading.currentThread()
         self._metrics_queue = metrics_queue
@@ -23,15 +23,15 @@ def __init__(self, metrics_queue, events_queue, name, url, headers, offline=Fals
         self._headers = headers
         self._headers_mp = headers.copy()
         self._headers_mp['Content-Type'] = 'application/msgpack'
-        self._offline = offline
+        self._mode = mode
         self._directory = os.path.join(get_offline_directory(), get_directory_name(name))
 
     @retry(wait=wait_exponential(multiplier=1, min=4, max=10), stop=stop_after_attempt(5))
     def heartbeat(self):
         """
         Send a heartbeat, with retries
         """
-        if not self._offline:
+        if mode == 'online':
             response = requests.put(f"{self._url}/api/runs/heartbeat",
                                     headers=self._headers,
                                     json={'name': self._name})
@@ -44,7 +44,7 @@ def post(self, endpoint, data):
         """
         Send the supplied data, with retries
         """
-        if not self._offline:
+        if mode == 'online':
             response = requests.post(f"{self._url}/api/{endpoint}",
                                      headers=self._headers_mp,
                                      data=data)