replaced serialize_task_class and unserialize_task_class with unstructure and structure, respectively, to match terminology used by attrs

Author: tclose

docs/source/tutorial/7-canonical-form.ipynb

@@ -246,7 +246,7 @@
     "\n",
     "As well as the dataclass-like canonical form, it is also possible to represent all tasks\n",
     "in a nested dictionary form, which could be written to a static file (e.g. in JSON or\n",
-    "YAML format). The dictionary form of a class can be generated by the `pydra.utils.serialize_task_class`\n",
+    "YAML format). The dictionary form of a class can be generated by the `pydra.utils.unstructure`\n",
     "function. For example, the following shell command"
    ]
   },
@@ -278,9 +278,9 @@
    "outputs": [],
    "source": [
     "from pprint import pprint\n",
-    "from pydra.utils import serialize_task_class\n",
+    "from pydra.utils import unstructure\n",
     "\n",
-    "my_cmd_dict = serialize_task_class(MyCmd)\n",
+    "my_cmd_dict = unstructure(MyCmd)\n",
     "\n",
     "pprint(my_cmd_dict)"
    ]
@@ -300,7 +300,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "cp_with_size_dict = serialize_task_class(CpFileWithSize)\n",
+    "cp_with_size_dict = unstructure(CpFileWithSize)\n",
     "\n",
     "pprint(cp_with_size_dict)"
    ]
@@ -310,7 +310,7 @@
    "metadata": {},
    "source": [
     "To unserialize the general dictionary form back into a Task class, you can use the\n",
-    "`pydra.utils.unserialize_task_class` method"
+    "`pydra.utils.structure` method"
    ]
   },
   {
@@ -319,9 +319,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from pydra.utils import unserialize_task_class\n",
+    "from pydra.utils import structure\n",
     "\n",
-    "ReloadedCpFileWithSize = unserialize_task_class(cp_with_size_dict)"
+    "ReloadedCpFileWithSize = structure(cp_with_size_dict)"
    ]
   },
   {

pydra/utils/__init__.py

@@ -5,8 +5,8 @@
     show_workflow,
     task_help,
     print_help,
-    serialize_task_class,
-    unserialize_task_class,
+    unstructure,
+    structure,
 )
 from ._version import __version__
 
@@ -18,6 +18,6 @@
     "show_workflow",
     "task_help",
     "print_help",
-    "serialize_task_class",
-    "unserialize_task_class",
+    "unstructure",
+    "structure",
 ]

pydra/utils/general.py

@@ -588,7 +588,7 @@ def get_plugin_classes(namespace: types.ModuleType, class_name: str) -> dict[str
     }
 
 
-def serialize_task_class(
+def unstructure(
     task_class: "type[Task]",
     filter: ty.Callable[[attrs.Attribute, ty.Any], bool] | None = None,
     value_serializer: (
@@ -685,8 +685,8 @@ def full_val_serializer(
     return dct
 
 
-def unserialize_task_class(task_class_dict: dict[str, ty.Any]) -> type["Task"]:
-    """Unserializes a task definition from a dictionary created by `serialize_task_class`
+def structure(task_class_dict: dict[str, ty.Any]) -> type["Task"]:
+    """Unserializes a task definition from a dictionary created by `unstructure`
 
     Parameters
     ----------

pydra/utils/tests/test_general.py

@@ -4,8 +4,8 @@
 from pydra.compose import python, workflow, shell
 from fileformats.text import TextFile
 from pydra.utils.general import (
-    serialize_task_class,
-    unserialize_task_class,
+    unstructure,
+    structure,
     get_fields,
     filter_out_defaults,
 )
@@ -49,33 +49,33 @@ def Add(a: int, b: int | None = None, c: int | None = None) -> int:
     return a + (b if b is not None else c)
 
 
-def test_python_serialize_task_class(tmp_path):
+def test_python_unstructure(tmp_path):
 
     assert Add(a=1, b=2)(cache_root=tmp_path / "cache1").out_int == 3
 
-    dct = serialize_task_class(Add)
+    dct = unstructure(Add)
     assert isinstance(dct, dict)
     check_dict_fully_serialized(dct)
-    Reloaded = unserialize_task_class(dct)
+    Reloaded = structure(dct)
     assert get_fields(Add) == get_fields(Reloaded)
 
     assert Reloaded(a=1, b=2)(cache_root=tmp_path / "cache2").out_int == 3
 
 
-def test_shell_serialize_task_class():
+def test_shell_unstructure():
 
     MyCmd = shell.define(
         "my-cmd <in_file> <out|out_file> --an-arg <an_arg:int=2> --a-flag<a_flag>"
     )
 
-    dct = serialize_task_class(MyCmd)
+    dct = unstructure(MyCmd)
     assert isinstance(dct, dict)
     check_dict_fully_serialized(dct)
-    Reloaded = unserialize_task_class(dct)
+    Reloaded = structure(dct)
     assert get_fields(MyCmd) == get_fields(Reloaded)
 
 
-def test_workflow_serialize_task_class(tmp_path):
+def test_workflow_unstructure(tmp_path):
 
     @workflow.define(outputs=["out_file"])
     def AWorkflow(in_file: TextFile, a_param: int) -> TextFile:
@@ -84,10 +84,10 @@ def AWorkflow(in_file: TextFile, a_param: int) -> TextFile:
         )
         return concatenate.out_file
 
-    dct = serialize_task_class(AWorkflow)
+    dct = unstructure(AWorkflow)
     assert isinstance(dct, dict)
     check_dict_fully_serialized(dct)
-    Reloaded = unserialize_task_class(dct)
+    Reloaded = structure(dct)
     assert get_fields(AWorkflow) == get_fields(Reloaded)
 
     foo_file = tmp_path / "file1.txt"
@@ -97,7 +97,7 @@ def AWorkflow(in_file: TextFile, a_param: int) -> TextFile:
     assert outputs.out_file.contents == "foo\nfoo\nfoo\nfoo"
 
 
-def test_serialize_task_class_with_value_serializer():
+def test_unstructure_with_value_serializer():
 
     @python.define
     def Identity(a: int) -> int:
@@ -121,13 +121,13 @@ def type_to_str_serializer(
             return value.__module__ + "." + value.__name__
         return value
 
-    dct = serialize_task_class(Identity, value_serializer=type_to_str_serializer)
+    dct = unstructure(Identity, value_serializer=type_to_str_serializer)
     assert isinstance(dct, dict)
     check_dict_fully_serialized(dct)
     assert dct["inputs"] == {"a": {"type": "builtins.int", "help": "the arg"}}
 
 
-def test_serialize_task_class_with_filter():
+def test_unstructure_with_filter():
 
     @python.define
     def Identity(a: int) -> int:
@@ -149,7 +149,7 @@ def no_helps_filter(atr: attrs.Attribute, value: ty.Any) -> bool:
             return False
         return filter_out_defaults(atr, value)
 
-    dct = serialize_task_class(Identity, filter=no_helps_filter)
+    dct = unstructure(Identity, filter=no_helps_filter)
     assert isinstance(dct, dict)
     check_dict_fully_serialized(dct)
     assert dct["inputs"] == {"a": {"type": int}}