renamed task_class_to/from_dict to un/serialize_task_class

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.task_class_as_dict`\n",
+    "YAML format). The dictionary form of a class can be generated by the `pydra.utils.serialize_task_class`\n",
     "function. For example, the following shell command"
    ]
   },
@@ -278,9 +278,9 @@
    "outputs": [],
    "source": [
     "from pprint import pprint\n",
-    "from pydra.utils import task_class_as_dict\n",
+    "from pydra.utils import serialize_task_class\n",
     "\n",
-    "my_cmd_dict = task_class_as_dict(MyCmd)\n",
+    "my_cmd_dict = serialize_task_class(MyCmd)\n",
     "\n",
     "pprint(my_cmd_dict)"
    ]
@@ -301,7 +301,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "cp_with_size_dict = task_class_as_dict(CpFileWithSize)\n",
+    "cp_with_size_dict = serialize_task_class(CpFileWithSize)\n",
     "\n",
     "pprint(cp_with_size_dict)"
    ]
@@ -311,7 +311,7 @@
    "metadata": {},
    "source": [
     "To unserialize the general dictionary form back into a Task class, you can use the\n",
-    "`pydra.utils.task_class_from_dict` method"
+    "`pydra.utils.unserialize_task_class` method"
    ]
   },
   {
@@ -320,9 +320,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from pydra.utils import task_class_from_dict\n",
+    "from pydra.utils import unserialize_task_class\n",
     "\n",
-    "ReloadedCpFileWithSize = task_class_from_dict(cp_with_size_dict)"
+    "ReloadedCpFileWithSize = unserialize_task_class(cp_with_size_dict)"
    ]
   },
   {

pydra/compose/base/helpers.py

@@ -414,7 +414,7 @@ def extract_fields_from_class(
 
     input_helps, _ = parse_doc_string(klass.__doc__)
 
-    def get_fields(klass, field_type, auto_attribs, helps) -> dict[str, Field]:
+    def extract_fields(klass, field_type, auto_attribs, helps) -> dict[str, Field]:
         """Get the fields from a class"""
         fields_dict = {}
         # Get fields defined in base classes if present
@@ -468,7 +468,7 @@ def get_fields(klass, field_type, auto_attribs, helps) -> dict[str, Field]:
             f"tasks, {klass} must inherit from {spec_type}"
         )
 
-    inputs = get_fields(klass, arg_type, auto_attribs, input_helps)
+    inputs = extract_fields(klass, arg_type, auto_attribs, input_helps)
 
     try:
         outputs_klass = klass.Outputs
@@ -483,7 +483,7 @@ def get_fields(klass, field_type, auto_attribs, helps) -> dict[str, Field]:
         )
 
     output_helps, _ = parse_doc_string(outputs_klass.__doc__)
-    outputs = get_fields(outputs_klass, out_type, auto_attribs, output_helps)
+    outputs = extract_fields(outputs_klass, out_type, auto_attribs, output_helps)
 
     return inputs, outputs
 

pydra/utils/__init__.py

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

pydra/utils/general.py

@@ -587,7 +587,7 @@ def get_plugin_classes(namespace: types.ModuleType, class_name: str) -> dict[str
     }
 
 
-def task_class_as_dict(
+def serialize_task_class(
     task_class: "type[Task]",
     filter: ty.Callable[[attrs.Attribute, ty.Any], bool] | None = None,
     value_serializer: (
@@ -666,8 +666,8 @@ def task_class_as_dict(
     return dct
 
 
-def task_class_from_dict(task_class_dict: dict[str, ty.Any]) -> type["Task"]:
-    """Unserializes a task definition from a dictionary created by `task_class_as_dict`
+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`
 
     Parameters
     ----------

pydra/utils/tests/test_general.py

@@ -2,7 +2,11 @@
 import attrs
 from pydra.compose import python, workflow, shell
 from fileformats.text import TextFile
-from pydra.utils.general import task_class_as_dict, task_class_from_dict, task_fields
+from pydra.utils.general import (
+    serialize_task_class,
+    unserialize_task_class,
+    task_fields,
+)
 from pydra.utils.tests.utils import Concatenate
 
 
@@ -26,28 +30,28 @@ 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_task_class_as_dict(tmp_path):
+def test_python_serialize_task_class(tmp_path):
 
-    dct = task_class_as_dict(Add)
-    Reloaded = task_class_from_dict(dct)
+    dct = serialize_task_class(Add)
+    Reloaded = unserialize_task_class(dct)
     assert task_fields(Add) == task_fields(Reloaded)
 
     add = Reloaded(a=1, b=2)
     assert add(cache_root=tmp_path / "cache").out_int == 3
 
 
-def test_shell_task_class_as_dict():
+def test_shell_serialize_task_class():
 
     MyCmd = shell.define(
         "my-cmd <in_file> <out|out_file> --an-arg <an_arg:int=2> --a-flag<a_flag>"
     )
 
-    dct = task_class_as_dict(MyCmd)
-    Reloaded = task_class_from_dict(dct)
+    dct = serialize_task_class(MyCmd)
+    Reloaded = unserialize_task_class(dct)
     assert task_fields(MyCmd) == task_fields(Reloaded)
 
 
-def test_workflow_task_class_as_dict(tmp_path):
+def test_workflow_serialize_task_class(tmp_path):
 
     @workflow.define(outputs=["out_file"])
     def AWorkflow(in_file: TextFile, a_param: int) -> TextFile:
@@ -56,8 +60,8 @@ def AWorkflow(in_file: TextFile, a_param: int) -> TextFile:
         )
         return concatenate.out_file
 
-    dct = task_class_as_dict(AWorkflow)
-    Reloaded = task_class_from_dict(dct)
+    dct = serialize_task_class(AWorkflow)
+    Reloaded = unserialize_task_class(dct)
     assert task_fields(AWorkflow) == task_fields(Reloaded)
 
     foo_file = tmp_path / "file1.txt"
@@ -67,7 +71,7 @@ def AWorkflow(in_file: TextFile, a_param: int) -> TextFile:
     assert outputs.out_file.contents == "foo\nfoo\nfoo\nfoo"
 
 
-def test_task_class_as_dict_with_value_serializer():
+def test_serialize_task_class_with_value_serializer():
 
     def frozen_set_to_list_serializer(
         mock_class: ty.Any, atr: attrs.Attribute, value: ty.Any
@@ -79,5 +83,5 @@ def frozen_set_to_list_serializer(
             )
         return value
 
-    dct = task_class_as_dict(Add, value_serializer=frozen_set_to_list_serializer)
+    dct = serialize_task_class(Add, value_serializer=frozen_set_to_list_serializer)
     assert dct["xor"] == [["b", "c"]] or dct["xor"] == [["c", "b"]]