pydata / pydata/xarray

Set child nodes via DataTree.children

Open
#9,441 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement topic-DataTree
Dominant language
Python
Stars
4.2k
Forks
1.4k
Avg merge
2d 15h
Merged PRs (30d)
14

Description

What is your issue?

I realised that if you want to add new children to a DataTree object, then while this works

dt[name] = new_child

and you can examine the children using

dt.children # returns {'name': child1, ...}

then actually this does not currently work

dt.children[name] = new_child

It would be nice to make this work, as I think setting with .children makes the intent much clearer.

It doesn't work because .children is a property that returns a dict - the only way you can update the .children is by replacing it entirely using the property setter, i.e.

dt.children = {'name': new_child}

This problem is analogous to how Dataset has ds.coords, which returns a proxy mapping object which has a __setitem__ method that allow modification in-place.

sort of related to #9204 , and came up whilst doing #9297

cc @shoyer

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

Start by locating the DataTree.children property and comparing it with the Dataset.coords proxy mapping mentioned in the issue. Verify the existing dt[name] = new_child behavior, then confirm that dt.children[name] = new_child updates the tree in place and add coverage for that usage.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.