Add FlowContainer for inputs/outputs #587
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…s done:
Summary
1. Created FlowContainer Class (structure.py)
- Added FlowContainer class that extends ContainerMixin
- Uses flow.label_full as the key (e.g., 'Boiler(Q_th)')
- Supports index-based access: inputs[0]
- Supports label-based access: inputs['Boiler(Q_th)']
- Added __add__ method to ContainerMixin for concatenation
2. Updated Component Class (elements.py)
- Changed inputs and outputs from list[Flow] to FlowContainer
- Modified __init__ to accept both list[Flow] and dict[str, Flow] (for deserialization)
- Updated _check_unique_flow_labels() and _connect_flows() to accept lists as parameters
- FlowContainers are created after connecting flows (so label_full is correct)
3. Updated Bus Class (elements.py)
- Changed inputs and outputs from list[Flow] to FlowContainer
4. Updated Iteration Patterns
All iteration patterns were updated from:
- for flow in self.inputs: → for flow in self.inputs.values():
- for flow in self.inputs + self.outputs: → for flow in (self.inputs + self.outputs).values():
Files updated:
- elements.py (Component, Bus, BusModel, ComponentModel)
- components.py (TransmissionModel, LinearConverterModel)
- flow_system.py (flow population and network connection)
- io.py (format_flow_details)
- statistics_accessor.py (various plotting methods)
- tests/deprecated/test_integration.py
Usage Examples
boiler = Boiler(label='Boiler', inputs=[Flow('Q_th', bus=heat_bus)])
# Both access methods work
assert boiler.inputs[0] == boiler.inputs['Boiler(Q_th)']
assert len(boiler.inputs) == 1
# Iteration requires .values()
for flow in boiler.inputs.values():
print(flow.label_full)
# Concatenation works
all_flows = boiler.inputs + boiler.outputs
for flow in all_flows.values():
print(flow.label)
All 1570 tests passed.
Added all_flows property to Component and Bus classes using itertools.chain: @Property def all_flows(self) -> Iterator[Flow]: """Iterate over all flows (inputs and outputs) without creating intermediate containers.""" return chain(self.inputs.values(), self.outputs.values()) Performance Improvement ┌─────────┬──────────────────────────────┬───────────────────────┐ │ Pattern │ Before │ After │ ├─────────┼──────────────────────────────┼───────────────────────┤ │ Memory │ O(n) - creates new container │ O(1) - iterator only │ ├─────────┼──────────────────────────────┼───────────────────────┤ │ Time │ O(n) - copies all elements │ O(1) - lazy iteration │ └─────────┴──────────────────────────────┴───────────────────────┘ Usage # Efficient iteration (no allocation) for flow in component.all_flows: ... # When you need a list (e.g., reusing multiple times) all_flows = list(component.all_flows) # Container concatenation still available when needed combined = component.inputs + component.outputs # Creates new FlowContainer Files Updated - elements.py - Added property, updated 8 iteration patterns - components.py - Updated 1 pattern - flow_system.py - Updated 3 patterns - statistics_accessor.py - Updated 1 pattern All 1570 tests pass.
1. FlowContainer now supports short-label access
When all flows in a container belong to the same component, you can access by short label:
# Both work for component.inputs, component.outputs, and component.flows:
component.inputs['Boiler(Q_th)'] # Full label
component.inputs['Q_th'] # Short label ✓
# The `in` operator also supports short labels:
if 'Q_th' in component.flows: # Works!
...
2. Component.flows is now a FlowContainer (cached property)
# Before (dict keyed by short label):
component.flows: dict[str, Flow]
# After (FlowContainer with full/short label access):
component.flows: FlowContainer # cached_property
API Summary
┌─────────────────────┬──────────────────────────────────────┐
│ Access Pattern │ Example │
├─────────────────────┼──────────────────────────────────────┤
│ Full label │ component.flows['Boiler(Q_th)'] │
├─────────────────────┼──────────────────────────────────────┤
│ Short label │ component.flows['Q_th'] │
├─────────────────────┼──────────────────────────────────────┤
│ Index │ component.flows[0] │
├─────────────────────┼──────────────────────────────────────┤
│ Membership │ 'Q_th' in component.flows │
├─────────────────────┼──────────────────────────────────────┤
│ Iteration │ for flow in component.flows.values() │
├─────────────────────┼──────────────────────────────────────┤
│ Efficient iteration │ for flow in component.all_flows │
└─────────────────────┴──────────────────────────────────────┘
Note: Short-label access only works when all flows in the container share the same component (which is always true for component.inputs,
component.outputs, and component.flows).
Contributor
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughUnifies flow collections by introducing FlowContainer and replacing list-based Changes
Sequence Diagram(s)(omitted) Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
FBumann
changed the title
Member
Author
|
@coderabbitai review |
Contributor
✅ Actions performedReview triggered.
|
FBumann
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Replaces
list[Flow]withFlowContainerforinputs,outputs, andflowsattributes. Provides dual access by index (inputs[0]) or label (inputs['Q_th']).Breaking Change
Use
.values()for flow iteration:for flow in component.inputs.values():Summary by CodeRabbit
New Features
inputs[0]orinputs['Q_th'])Refactor
✏️ Tip: You can customize this high-level summary in your review settings.