'task_label' renamed to 'label'

Author: Johannes Otepka

docs/source/examples/basic_task_label.py

@@ -24,24 +24,24 @@ def wait(t):
     # use load balanced view
     dview = rc.load_balanced_view()
     ar_list = [
-        dview.map_async(wait, [2], task_label=f"task_label_{i:02}") for i in range(10)
+        dview.map_async(wait, [2], label=f"mylabel_{i:02}") for i in range(10)
     ]
     dview.wait(ar_list)
 else:
     # use direct view
     dview = rc[:]
     ar_list = [
-        dview.apply_async(wait, 2, task_label=f"task_label_{i:02}") for i in range(10)
+        dview.apply_async(wait, 2, label=f"mylabel_{i:02}") for i in range(10)
     ]
     dview.wait(ar_list)
 
 # query database
 data = rc.db_query(
-    {'task_label': {"$nin": ""}}, keys=['msg_id', 'task_label', 'engine_uuid']
+    {'label': {"$nin": ""}}, keys=['msg_id', 'label', 'engine_uuid']
 )
 for d in data:
     print(
-        f"msg_id={d['msg_id']}; task_label={d['task_label']}; engine_uuid={d['engine_uuid']}"
+        f"msg_id={d['msg_id']}; label={d['label']}; engine_uuid={d['engine_uuid']}"
     )
 
 cluster.stop_cluster_sync()

ipyparallel/client/remotefunction.py

@@ -195,14 +195,14 @@ def __init__(
         chunksize=None,
         ordered=True,
         return_exceptions=False,
-        task_label=None,
+        label=None,
         **flags,
     ):
         super().__init__(view, f, block=block, **flags)
         self.chunksize = chunksize
         self.ordered = ordered
         self.return_exceptions = return_exceptions
-        self.task_label = task_label
+        self.label = label
 
         mapClass = Map.dists[dist]
         self.mapObject = mapClass()
@@ -296,8 +296,8 @@ def __call__(self, *sequences, **kwargs):
             view = self.view if balanced else client[t]
             with view.temp_flags(block=False, **self.flags):
                 ar = view.apply(
-                    f, *args, task_label=self.task_label
-                )  # is this the right place to insert the task_label?
+                    f, *args, label=self.label
+                )  # is this the right place to insert the label?
                 ar.owner = False
 
             msg_id = ar.msg_ids[0]

ipyparallel/client/view.py

@@ -566,10 +566,10 @@ def _really_apply(
         _idents, _targets = self.client._build_targets(targets)
         futures = []
 
-        task_label = (
-            kwargs.pop("task_label") if "task_label" in kwargs else None
-        )  # is this the correct/best way of retieving task_label?
-        metadata = dict(task_label=task_label)
+        label = (
+            kwargs.pop("label") if "label" in kwargs else None
+        )  # is this the correct/best way of retieving label?
+        metadata = dict(label=label)
 
         pf = PrePickled(f)
         pargs = [PrePickled(arg) for arg in args]
@@ -610,7 +610,7 @@ def map(
         block=None,
         track=False,
         return_exceptions=False,
-        task_label=None,
+        label=None,
     ):
         """Parallel version of builtin `map`, using this View's `targets`.
 
@@ -1062,7 +1062,7 @@ def map(
         block=None,
         track=False,
         return_exceptions=False,
-        task_label=None,
+        label=None,
     ):
         """Parallel version of builtin `map`, using this View's `targets`.
 
@@ -1382,9 +1382,9 @@ def _really_apply(
             # ensure *not* bytes
             idents = [ident.decode() for ident in idents]
 
-        task_label = (
-            kwargs.pop("task_label") if "task_label" in kwargs else None
-        )  # is this the correct/best way of retieving task_label?
+        label = (
+            kwargs.pop("label") if "label" in kwargs else None
+        )  # is this the correct/best way of retieving label?
 
         after = self._render_dependency(after)
         follow = self._render_dependency(follow)
@@ -1394,7 +1394,7 @@ def _really_apply(
             timeout=timeout,
             targets=idents,
             retries=retries,
-            task_label=task_label,
+            label=label,
         )
 
         future = self.client.send_apply_request(
@@ -1425,7 +1425,7 @@ def map(
         chunksize=1,
         ordered=True,
         return_exceptions=False,
-        task_label=None,
+        label=None,
     ):
         """Parallel version of builtin `map`, load-balanced by this View.
 
@@ -1480,7 +1480,7 @@ def map(
             chunksize=chunksize,
             ordered=ordered,
             return_exceptions=return_exceptions,
-            task_label=task_label,
+            label=label,
         )
         return pf.map(*sequences)
 

ipyparallel/controller/hub.py

@@ -75,7 +75,7 @@ def empty_record():
         'error': None,
         'stdout': '',
         'stderr': '',
-        'task_label': None,
+        'label': None,
     }
 
 
@@ -112,7 +112,7 @@ def init_record(msg):
         'error': None,
         'stdout': '',
         'stderr': '',
-        'task_label': msg['metadata'].get('task_label', None),
+        'label': msg['metadata'].get('label', None),
     }
 
 

ipyparallel/engine/kernel.py

@@ -76,7 +76,7 @@ def init_metadata(self, parent):
             'is_broadcast': parent_metadata.get('is_broadcast', False),
             'is_coalescing': parent_metadata.get('is_coalescing', False),
             'original_msg_id': parent_metadata.get('original_msg_id', ''),
-            'task_label': parent_metadata.get('task_label', None),
+            'label': parent_metadata.get('label', None),
         }
 
     def finish_metadata(self, parent, metadata, reply_content):