Skip to content

fix: preserve graph types and metadata in sorting and splitting utilities#116

Open
AdMub wants to merge 2 commits intomllam:mainfrom
AdMub:fix/preserve-graph-attributes
Open

fix: preserve graph types and metadata in sorting and splitting utilities#116
AdMub wants to merge 2 commits intomllam:mainfrom
AdMub:fix/preserve-graph-attributes

Conversation

@AdMub
Copy link
Copy Markdown
Contributor

@AdMub AdMub commented Mar 24, 2026

Describe your changes

This PR fixes a silent data-loss bug in the core networkx_utils functions: sort_nodes_internally and sort_nodes_in_graph.

Previously, these functions hardcoded the output as a standard networkx.DiGraph(). This meant that if a user passed in a different graph type (e.g., an undirected Graph or a MultiDiGraph), or if the graph contained critical global metadata (such as coordinate reference systems graph['crs'] or mesh spacing graph['dx']), that data was completely stripped and lost during the sort operation.

Changes:

  • Replaced hardcoded networkx.DiGraph() with dynamic typing (type(graph)()) to preserve the original graph's class.
  • Added graph.update(input.graph) to ensure all top-level graph attributes are safely carried over to the newly returned graphs.

Issue Link

N/A - This addresses a silent bug found during codebase review.

Type of change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📖 Documentation (Addition or improvements to documentation)

Checklist before requesting a review

  • My branch is up-to-date with the target branch - if not update your fork with the changes from the target branch (use pull with --rebase option if possible).
  • I have performed a self-review of my code
  • For any new/modified functions/classes I have added docstrings that clearly describe its purpose, expected inputs and returned values
  • I have placed in-line comments to clarify the intent of any hard-to-understand passages of my code
  • I have updated the documentation to cover introduced code changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have given the PR a name that clearly describes the change, written in imperative form (context).
  • I have requested a reviewer and an assignee (assignee is responsible for merging)

Checklist for reviewers

Each PR comes with its own improvements and flaws. The reviewer should check the following:

  • the code is readable
  • the code is well tested
  • the code is documented (including return types and parameters)
  • the code is easy to maintain

Author checklist after completed review

  • I have added a line to the CHANGELOG describing this change, in a section
    reflecting type of change (add section where missing):
    • added: when you have added new functionality
    • changed: when default behaviour of the code has been changed
    • fixes: when your contribution fixes a bug

Checklist for assignee

  • PR is up to date with the base branch
  • the tests pass
  • author has added an entry to the changelog (and designated the change as added, changed or fixed)
  • Once the PR is ready to be merged, squash commits and merge the PR.

@AdMub AdMub force-pushed the fix/preserve-graph-attributes branch from 73c2ae6 to ce4509f Compare March 24, 2026 08:47
@AdMub
Copy link
Copy Markdown
Contributor Author

AdMub commented Mar 24, 2026

Hi @mllam, I've resolved the linting failures and all CI checks are now passing. This fix ensures that graph-level metadata (like CRS) is preserved during sorting and splitting. Ready for your feedback!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant