Rename ParamLink to ParamRef which is less ambiguous

Change-Id: I82c498efef06f9adcd075e69fa331a6b01984b98
BlueBrain · Nov 27, 2020 · f0c4d77 · f0c4d77
1 parent ab657d5
commit f0c4d77
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 20 deletions.
diff --git a/luigi_tools/tasks.py b/luigi_tools/tasks.py
@@ -125,7 +125,7 @@ def __setattr__(self, name, value):
         return super().__setattr__(name, value)
 
 
-class ParamLink:
+class ParamRef:
     """Class to store parameter linking informations."""
 
     def __init__(self, cls, name=None, default=_no_default_value):
@@ -154,25 +154,25 @@ class copy_params:
         class AnotherTask(luigi.Task):
             m = luigi.IntParameter(default=1)
 
-        @copy_params(m=ParamLink(AnotherTask))
+        @copy_params(m=ParamRef(AnotherTask))
         class MyFirstTask(luigi.Task):
             def run(self):
                print(self.m) # this will be defined and print 1
                # ...
 
-        @copy_params(another_m=ParamLink(AnotherTask, "m"))
+        @copy_params(another_m=ParamRef(AnotherTask, "m"))
         class MySecondTask(luigi.Task):
             def run(self):
                print(self.another_m) # this will be defined and print 1
                # ...
 
-        @copy_params(another_m=ParamLink(AnotherTask, "m", 5))
+        @copy_params(another_m=ParamRef(AnotherTask, "m", 5))
         class MyFirstTask(luigi.Task):
             def run(self):
                print(self.another_m) # this will be defined and print 5
                # ...
 
-        @copy_params(another_m=ParamLink(AnotherTask, "m"))
+        @copy_params(another_m=ParamRef(AnotherTask, "m"))
         class MyFirstTask(GlobalParamMixin, luigi.Task):
             def run(self):
                # this will be defined and print 1 if self.another_m is not explicitely set

diff --git a/tests/test_tasks.py b/tests/test_tasks.py
@@ -35,10 +35,10 @@ def output(self):
             return luigi.LocalTarget(tmpdir)
 
     @luigi_tools.tasks.copy_params(
-        a=luigi_tools.tasks.ParamLink(TaskA),
-        aa=luigi_tools.tasks.ParamLink(TaskA, "a"),
-        a_default=luigi_tools.tasks.ParamLink(TaskA, "a", "given_default_value"),
-        a_none=luigi_tools.tasks.ParamLink(TaskA, "a", None),
+        a=luigi_tools.tasks.ParamRef(TaskA),
+        aa=luigi_tools.tasks.ParamRef(TaskA, "a"),
+        a_default=luigi_tools.tasks.ParamRef(TaskA, "a", "given_default_value"),
+        a_none=luigi_tools.tasks.ParamRef(TaskA, "a", None),
     )
     class TaskB(luigi.Task):
         """"""
@@ -85,7 +85,7 @@ class TaskC(luigi.Task):
     with pytest.raises(DuplicatedParameterError):
 
         @luigi_tools.tasks.copy_params(
-            a=luigi_tools.tasks.ParamLink(TaskA),
+            a=luigi_tools.tasks.ParamRef(TaskA),
         )
         class TaskD(luigi.Task):
             """"""
@@ -107,8 +107,8 @@ def output(self):
             return luigi.LocalTarget("not_existing_file")
 
     @luigi_tools.tasks.copy_params(
-        a_copy=luigi_tools.tasks.ParamLink(TaskWithListDictParams, "a"),
-        b_copy=luigi_tools.tasks.ParamLink(TaskWithListDictParams, "b"),
+        a_copy=luigi_tools.tasks.ParamRef(TaskWithListDictParams, "a"),
+        b_copy=luigi_tools.tasks.ParamRef(TaskWithListDictParams, "b"),
     )
     class TaskCopyListDictParams(luigi.Task):
         """"""
@@ -158,9 +158,9 @@ def output(self):
             return luigi.LocalTarget("not_existing_file")
 
     @luigi_tools.tasks.copy_params(
-        aa=luigi_tools.tasks.ParamLink(TaskA, "a_cfg"),
-        a_default=luigi_tools.tasks.ParamLink(TaskA, "a", "given_default_value"),
-        a_none=luigi_tools.tasks.ParamLink(TaskA, "a", None),
+        aa=luigi_tools.tasks.ParamRef(TaskA, "a_cfg"),
+        a_default=luigi_tools.tasks.ParamRef(TaskA, "a", "given_default_value"),
+        a_none=luigi_tools.tasks.ParamRef(TaskA, "a", None),
     )
     class TaskB(luigi_tools.tasks.GlobalParamMixin, luigi.Task):
         """"""
@@ -224,7 +224,7 @@ class TaskC(luigi.Task):
     with pytest.raises(DuplicatedParameterError):
 
         @luigi_tools.tasks.copy_params(
-            a=luigi_tools.tasks.ParamLink(TaskA),
+            a=luigi_tools.tasks.ParamRef(TaskA),
         )
         class TaskD(luigi_tools.tasks.GlobalParamMixin, luigi.Task):
             """"""
@@ -248,7 +248,7 @@ def output(self):
 
     # Global parameter with _no_default_value should raise GlobalParameterNoValueError
     @luigi_tools.tasks.copy_params(
-        a=luigi_tools.tasks.ParamLink(TaskA),
+        a=luigi_tools.tasks.ParamRef(TaskA),
     )
     class TaskF(luigi_tools.tasks.GlobalParamMixin, luigi.Task):
         """"""
@@ -322,7 +322,7 @@ def output(self):
             return luigi.LocalTarget(luigi_tools_working_directory / "TaskI_output.test")
 
     @luigi_tools.tasks.copy_params(
-        i=luigi_tools.tasks.ParamLink(TaskI),
+        i=luigi_tools.tasks.ParamRef(TaskI),
     )
     class TaskJ(luigi.Task):
         """"""
@@ -369,8 +369,8 @@ def output(self):
             return luigi.LocalTarget("not_existing_file")
 
     @luigi_tools.tasks.copy_params(
-        a_copy=luigi_tools.tasks.ParamLink(GlobalParamTaskWithListDictParams, "a"),
-        b_copy=luigi_tools.tasks.ParamLink(GlobalParamTaskWithListDictParams, "b"),
+        a_copy=luigi_tools.tasks.ParamRef(GlobalParamTaskWithListDictParams, "a"),
+        b_copy=luigi_tools.tasks.ParamRef(GlobalParamTaskWithListDictParams, "b"),
     )
     class GlobalParamTaskCopyListDictParams(luigi_tools.tasks.GlobalParamMixin, luigi.Task):
         """"""