pydata / pydata/xarray

Auto-complete datatree paths containing . or ../

Open
#9,440 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

  • #217 by @TomNicholas — closed without merging
enhancement topic-DataTree upstream issue
Dominant language
Python
Stars
4.2k
Forks
1.4k
Avg merge
2d 15h
Merged PRs (30d)
14

Description

What is your issue?

Copying over from https://github.com/xarray-contrib/datatree/issues/189

Feature Request: Some form of path auto-completion

The more I play with datatree, the more I realize the huge potential of this package. Amazing work @TomNicholas.

I have been using dt for CMIP6 analysis and one of the things that is still fairly slow for me is to navigate into different specific leaves of the tree. Having some sort of incremental auto-complete of the path like this:

dt.['model/<click tab> --> dt.['model/experiment_a/]

similar to what happens in the bash shell with tab completion would be an absolute killer feature. Most users already know how to navigate this (from their terminal). For massive trees this would speed up the workflow tremendously.

On the other hand I have no idea how complex this is to implement. Just wanted to suggest this feature.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the linked datatree issue and closed pull request #217 first to understand the prior approach and remaining scope. Define how path completion should work for paths containing . and ../, including the interaction model and completion boundaries. Done means the feature has agreed behavior and coverage for the requested path-navigation cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.