Skip to content

Refactor filtering arguments in DFG functions to use 'whereNoun'#1215

Merged
Affie merged 3 commits intodevelopfrom
refac/whereNoun
Apr 1, 2026
Merged

Refactor filtering arguments in DFG functions to use 'whereNoun'#1215
Affie merged 3 commits intodevelopfrom
refac/whereNoun

Conversation

@Affie
Copy link
Copy Markdown
Member

@Affie Affie commented Apr 1, 2026

Reasons:

  • Autocomplete:
julia> listVariables(fg; where
whereLabel=
whereSolvable=
whereTags=
whereType=
  • natural language eg. listVariables(fg, whereLabel = startswith("x")) list variables where its label starts with "x"

@Affie Affie self-assigned this Apr 1, 2026
@Affie Affie added this to the v0.29.0 milestone Apr 1, 2026
@Affie Affie requested a review from Copilot April 1, 2026 09:18
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Refactors DFG listing/filtering APIs to use where*-prefixed keyword arguments (e.g. whereLabel, whereTags) to improve discoverability/autocomplete and make call sites read more naturally.

Changes:

  • Renamed filter keyword arguments across core list/find/state/blobentry APIs to where* variants.
  • Updated GraphsDFG implementations and related helpers (ls, lsf, getSubgraph, getBiadjacencyMatrix, blobentry accessors) to pass through the new keywords.
  • Updated tests and NEWS entry to reflect the renamed API.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
test/testBlocks.jl Updates test call sites from *Filter keywords to where*.
test/iifInterfaceTests.jl Updates interface tests to use where* filters.
src/services/list.jl Updates ls/lsf keyword API to where* and forwards to list*.
src/services/find.jl Updates findVariablesNearTimestamp filtering kwargs to where*.
src/services/DFGVariable.jl Updates listStates filtering kwargs to whereLabel / whereVariableLabel.
src/services/Bloblet.jl Updates TODO comment to reflect new whereLabel naming.
src/services/AbstractDFG.jl Updates docstrings and getSubgraph/getBiadjacencyMatrix internals to where*; updates filter examples.
src/GraphsDFG/services/GraphsDFG.jl Renames filtering kwargs for GraphsDFG CRUD/listing/neighborhood APIs to where*.
src/Deprecated.jl Renames filter kwargs used by deprecated helpers to where*.
src/DataBlobs/services/BlobEntry.jl Renames blobentry filtering kwargs to whereLabel/whereBlobid.
NEWS.md Documents the breaking keyword rename to where*.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Johannes Terblanche <6612981+Affie@users.noreply.github.com>
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 1, 2026

Codecov Report

❌ Patch coverage is 73.07692% with 14 lines in your changes missing coverage. Please review.
✅ Project coverage is 79.97%. Comparing base (cf1e85e) to head (e8a52bc).
⚠️ Report is 1 commits behind head on develop.

Files with missing lines Patch % Lines
src/GraphsDFG/services/GraphsDFG.jl 76.00% 6 Missing ⚠️
src/services/AbstractDFG.jl 0.00% 6 Missing ⚠️
src/Deprecated.jl 0.00% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1215   +/-   ##
========================================
  Coverage    79.97%   79.97%           
========================================
  Files           37       37           
  Lines         2522     2522           
========================================
  Hits          2017     2017           
  Misses         505      505           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Affie Affie merged commit eda3350 into develop Apr 1, 2026
6 of 9 checks passed
@Affie Affie deleted the refac/whereNoun branch April 1, 2026 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants