0xPlaygrounds / 0xPlaygrounds/subgrounds

Enhance auto selection of FieldPaths with filters on field names

Open
#31 0 comments 0 reactions 0 assignees View on GitHub
enhancement good first issue
Dominant language
Python
Stars
73
Forks
12
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**
Yes! Currently, Sugrounds supports auto-selection of FieldPaths. This means that if you use one of the querying methods (e.g.: `sg.query_df`) with a FieldPath that does not select a scalar value, then Subgrounds will automatically grab all scalar fields available from that partial selection (see code snippet below).

However, especially during the data exploration phase, this is too much data to be useful (users have to go through dozens of columns to find the data that interests them. The other option, to individually select all fields of interest, is tedious and verbose. What is missing is a middle ground between both cases.

Introducing, filtered auto-selections! (not to be confused with filters _on_ selections, i.e.: with the `where` argument). The idea is simple, it would work the same as the regular autocompletion of FieldPaths, while allowing users to specify a filter for the fields they want to select.

**Describe the solution you'd like**
```python
from subgrounds import Subgrounds

sg = Subgrounds()

subgraph = sg.load_subgraph("https://api.thegraph.com/subgraphs/name/messari/uniswap-v3-ethereum")

# Select individual fields
sg.query_df([
subgraph.Query.financialsDailySnapshots.timestamp,
subgraph.Query.financialsDailySnapshots.totalValueLockedUSD,
])

# Auto-select all fields
sg.query_df([
subgraph.Query.financialsDailySnapshots
])

# NEW: Select all fields starting with `cumulative`
sg.query_df([
subgraph.Query.financialsDailySnapshots._select("cumulative*")
])
```

**Describe alternatives you've considered**
None.

**Additional context**
For consistency, `subgraph.Query.financialsDailySnapshots._select("*")` should be equivalent to selecting all the fields (the second case).

**Implementation checklist**
- [ ] Update `FieldPath._select` to be able to handle widlcards

Contributor guide

Open the contributing guide

Research direction

The issue is about enhancing FieldPath._select in Subgrounds to support wildcard filters. Start by examining the FieldPath class in the codebase, likely in a file like fieldpath.py. Look for the existing _select method and understand how auto-selection currently works. Then, implement wildcard matching (e.g., 'cumulative*') to filter field names. Test with the provided example using subgraph.Query.financialsDailySnapshots._select("cumulative*") to ensure it selects only fields starting with 'cumulative'.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, pandas, python
Domain
backend-api-design, data
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.