google/python-fire

completion option for zsh

Open

#64 opened on Apr 14, 2017

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

Description

I'm using zsh 5.0.8 on OSX 10.11.6.

When I tried to run the generated completion bash for the basic example in README, I got the following error.

_complete-calculatorpy:4: unrecognized modifier C'`

I finally resolved this issue by replacing the : in the bash script with : .

An extra option for completion command will be helpful for zsh user.

Contributor guide

Tech stack
pythonshell
Domain
cli
Issue type
feature
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
familiarity with zsh completion scriptsunderstanding of python fire's existing completion generation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate how python fire currently generates bash completions (likely in the codebase). Understand the difference between bash and zsh completion syntax. The issue mentions replacing ':' with ': ' to fix an error, suggesting a simple patch. Look at the existing shell completion generation code and add an option to specify shell type (bash or zsh) or auto detect. The PR #64 comments may have further insights. Implement and test with zsh 5.0.8.