google/python-fire

Display dict of namedtuples

Open

#230 opened on Mar 3, 2020

View on GitHub
 (6 comments) (1 reaction) (0 assignees)Python (26,214 stars) (1,418 forks)batch import
enhancementhelp wanted

Description

Fire nicely prints a dict of dicts using one line per inner dict. When I try to do the same with dict of namedtuples (which otherwise behave like dicts after #161), I just get a help page listing all the dict keys. When I specify a dict key, then that namedtuple is printed. I would prefer all namedtuples in the dict to be printed when no key is specified.

Contributor guide

Tech stack
python
Domain
clitooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
PythonPython Fire basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue is about displaying a dict of namedtuples in Python Fire. Currently, Fire prints a help page listing keys instead of each namedtuple's fields. To fix, examine how Fire renders dicts and namedtuples, likely in the `Display` or `Print` modules. The user references PR #161 which added namedtuple support for dict keys. Look at how dict of dicts is handled and adapt for namedtuples. Check the repository's handling of namedtuples, possibly in `core.py` or `display.py`. Consider using `collections.abc.Mapping` or ` dict ` to iterate over namedtuple fields. The issue is clear but requires understanding of Fire's rendering logic.