Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Workflow: Better io #735

Merged
merged 9 commits into from
Jun 22, 2023
Merged

Workflow: Better io #735

merged 9 commits into from
Jun 22, 2023

Conversation

liamhuber
Copy link
Member

This is docs and type hints except that now the key under which a channel is stored in an IO collection doesn't need to be that channel's label.

The rationale for this is that workflows should dynamically be creating IO collections with keys like f"{node.label}_{channel.label}", but I don't want them to be altering the underlying channel label. Right now Workflow does this by just making a (dot)dict out of the channel objects, but it would be nice to use the formal IO class for the collection so we get access to its helper methods and can have consistent typing between Workflow and Node for what inputs and outputs look like.

@samwaseda, because this is almost just doc changes, and I want the functional change for us in #729, I'll probably merge it without review. But if you want to take a peek anyhow and leave some comments where anything is unclear/poorly worded, I would be happy to open a patching PR to polish it up.

This will allow Workflows to have io with labels that combine the node and channel labels, without modifying the underlying channel label
Start by testing things that are forbidden, and move to successful stuff
@liamhuber liamhuber changed the title Better io Workflow: Better io Jun 22, 2023
@github-actions
Copy link
Contributor

Binder 👈 Launch a binder notebook on branch pyiron/pyiron_contrib/better_io

@liamhuber liamhuber added the format_black Invoke a black formatting commit label Jun 22, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jun 22, 2023

Pull Request Test Coverage Report for Build 5350236287

  • 33 of 33 (100.0%) changed or added relevant lines in 2 files are covered.
  • 2 unchanged lines in 1 file lost coverage.
  • Overall coverage remained the same at 11.887%

Files with Coverage Reduction New Missed Lines %
pyiron_contrib/workflow/channels.py 2 89.1%
Totals Coverage Status
Change from base Build 5347569066: 0.0%
Covered Lines: 1671
Relevant Lines: 14057

💛 - Coveralls

@liamhuber liamhuber merged commit a9fc0fc into main Jun 22, 2023
@delete-merged-branch delete-merged-branch bot deleted the better_io branch June 22, 2023 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
format_black Invoke a black formatting commit
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants