[patch] Dataclass transformer

liamhuber commented 1 month ago

Introduce a node for converting inputs to a dataclass instance. Contributes to #268.

TODO:

[x] Tests
[x] Think about naming; e.g. if we never have dataclass to outputs, we can drop the "inputsto" throughout
[x] Docs

Demo:

from dataclasses import dataclass, field

from pyiron_workflow import Workflow

def some_list():
    return [1, 2, 3]

@Workflow.wrap.as_dataclass_node
@dataclass
class Foo:
    necessary: str
    bar: str = "bar"
    answer: int = 42
    complex_: list = field(default_factory=some_list)

f = Foo()
print(f.readiness_report)
>>> InputsToDataclassFoo readiness: False
... STATE:
... running: False
... failed: False
... INPUTS:
... necessary ready: False
... bar ready: True
... answer ready: True
... complex_ ready: True

f(necessary="input as a node kwarg")
>>> Foo(necessary='input as a node kwarg', bar='bar', answer=42, complex_=[1, 2, 3])

EDIT: decorator name

github-actions[bot] commented 1 month ago

:point_left: Launch a binder notebook on branch _pyiron/pyiron_workflow/dataclasstransformer

codacy-production[bot] commented 1 month ago

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
:white_check_mark: +0.16% (target: -1.00%)	:white_check_mark: 95.12%

Coverage variation details

| | Coverable lines | Covered lines | Coverage | | ------------- | ------------- | ------------- | ------------- | | Common ancestor commit (efbf51428b39a819047f8e19592f33044e28276b) | 3761 | 3340 | 88.81% | | | Head commit (06634aae51f7c38687a0b14f00134e102b99a2e2) | 3797 (+36) | 3378 (+38) | 88.96% (**+0.16%**) | **Coverage variation** is the difference between the coverage for the head and common ancestor commits of the pull request branch: ` - `

Diff coverage details

| | Coverable lines | Covered lines | Diff coverage | | ------------- | ------------- | ------------- | ------------- | | Pull request (#308) | 41 | 39 | **95.12%** | **Diff coverage** is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: `/ * 100%`