Fixed component graph validation to allow dangling components #1205
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
Previously, a strict tree (connected acyclic undirected graph) structure was required, but now components can exist without being connected to anything. Signed-off-by: Elzbieta Kotulska <[email protected]>
github-actions
bot
added
part:docs
There was a problem hiding this comment.
Pull Request Overview
This PR updates the component graph validation to allow dangling components by modifying the error handling for unconnected components and adjusting error messages.
- Update error message for cycle detection to more clearly indicate the presence of cycles.
- Replace the exception for unconnected components with a logging warning to support dangling components.
- Update release notes to reflect the changes.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/frequenz/sdk/microgrid/component_graph.py | Modified validation logic to allow dangling components by logging warnings instead of raising errors, and updated error messages. |
| RELEASE_NOTES.md | Updated release notes to include the change in component graph validation. |
Comments suppressed due to low confidence (1)
src/frequenz/sdk/microgrid/component_graph.py:919
- Fix the grammatical error by changing 'a least one connection' to 'at least one connection'.
raise InvalidGraphError("Graph must have a least one connection!")
| raise InvalidGraphError("Graph must have a least one component!") | ||
| if sum(1 for _ in self.connections()) <= 0: | ||
| raise InvalidGraphError("Graph must have a least one connection!") | ||
|
|
There was a problem hiding this comment.
[nitpick] Consider adding a comment explaining why unconnected components now only trigger a warning rather than an exception, to clarify that dangling components are allowed.
Suggested change
| # Allow dangling components (components with no connections) in the graph. | |
| # These components are ignored during validation but logged as warnings | |
| # to inform the user. This behavior is intentional to support use cases | |
| # where some components might not be connected but are still part of the | |
| # microgrid configuration. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Previously, a strict tree (connected acyclic undirected graph) structure was required, but now components can exist without being connected to anything.