Support for tcsh completion by simaoafonso-pwt · Pull Request #57 · iterative/shtab

simaoafonso-pwt · 2021-11-05T20:44:11Z

This is incomplete due to tcsh limitations, but functional.

Here are some examples generated with this:

#!/usr/bin/env tcsh
# AUTOMATICALLY GENERATED by `shtab`


# Custom Preamble
set autolist
# End Custom Preamble


complete customcomplete \
        'c/--/(output-name input-file help)/' \
        'c/-/(h i o -)/' \
        'n/-i/f/' \
        'n/--input-file/f/' \
        'n/-o/d/' \
        'n/--output-name/d/' \
        'p/1/(completion process)/' \
        'p@2@`set cmd=($COMMAND_LINE); ( [ "$cmd[2]" == "completion" ] && echo "bash\nzsh\ntcsh" || false ) || ( echo "oa\nob" || false )`@' \
        'p/*/()/'
#!/usr/bin/env tcsh
# AUTOMATICALLY GENERATED by `shtab`



complete pathcomplete \
        'c/--/(help dir print-completion)/' \
        'c/-/(s h -)/' \
        'n/-s/(bash zsh tcsh)/' \
        'n/--print-completion/(bash zsh tcsh)/' \
        'n/--dir/d/' \
        'p/1/f/' \
        'p/*/()/'
#!/usr/bin/env tcsh
# AUTOMATICALLY GENERATED by `shtab`



complete shtab \
        'c/--/(error-unimportable shell preamble verbose prog prefix help version)/' \
        'c/-/(s v u h -)/' \
        'n/-s/(bash zsh tcsh)/' \
        'n/--shell/(bash zsh tcsh)/' \
        'p/*/()/'

simaoafonso-pwt · 2021-11-08T11:27:40Z

Pinging @casperdcl from #56.

simaoafonso-pwt · 2021-11-15T12:28:25Z

Friendly ping @casperdcl

casperdcl

thanks! Just not sure about the test (seems to imply complete_tcsh doesn't really do much?)

examples/customcomplete.py

README.rst

shtab/__init__.py

shtab/main.py

tests/test_shtab.py

simaoafonso-pwt · 2021-11-15T16:05:12Z

I can squash everything into a single commit in the end, if you prefer.

casperdcl · 2021-11-16T00:14:10Z

I can squash everything into a single commit in the end, if you prefer.

no need, it's ok :)

casperdcl

awesome! can you update docs/use.md (used to generate https://docs.iterative.ai/shtab/use/) with installation instructions for tcsh?

See iterative#57 (comment)

casperdcl

minor improvements

docs/use.md

This is incomplete due to tcsh limitations, but functional (iterative#56) Make customcomplete herder to parser Mixup main parser positionals and sub-parser positionals on the same "position".

Tweak customcomplete completion See iterative#57 (comment)

casperdcl

awesome, thanks!

casperdcl · 2021-11-16T16:54:22Z

/tag v1.5.0 25e3e44

simaoafonso-pwt · 2021-11-16T17:14:18Z

Thanks for the quick review.

simaoafonso-pwt · 2021-11-16T17:30:21Z

https://github.com/iterative/shtab/runs/4227856457?check_suite_focus=true#step:5:31

Oops, I did not run the tests on python 2.7, and nether did the actions run when I pushed.

shtab/shtab/__init__.py

Line 644 in 46302c5

recurse_parser(subparser, positional_idx, [*requirements, subcmd])

shtab/shtab/__init__.py

Line 661 in 46302c5

' && '.join([*checks, '']), # Append the separator

Unpacking lists doesn't work. Did a quick test, you can apply this patch:

diff --git i/shtab/__init__.py w/shtab/__init__.py
index d3747f7..da279b4 100644
--- i/shtab/__init__.py
+++ w/shtab/__init__.py
@@ -641,7 +641,7 @@ def complete_tcsh(parser, root_prefix=None, preamble="", choice_functions=None):
                 if not requirements and isinstance(positional.choices, dict):
                     for subcmd, subparser in positional.choices.items():
                         log.debug('%s| | SubParser: %s', log_prefix, subcmd)
-                        recurse_parser(subparser, positional_idx, [*requirements, subcmd])
+                        recurse_parser(subparser, positional_idx, [r for r in requirements] + [subcmd])

     recurse_parser(parser, 0)

@@ -658,7 +658,7 @@ def complete_tcsh(parser, root_prefix=None, preamble="", choice_functions=None):
                     '[ "$cmd[{}]" == "{}" ]'.format(iidx, n) for iidx, n in enumerate(nn, start=2)]
                 if arg.choices:
                     nlist.append('( {}echo "{}" || false )'.format(
-                        ' && '.join([*checks, '']),                 # Append the separator
+                        ' && '.join([c for c in checks] + ['']),                 # Append the separator
                         '\\n'.join(arg.choices),
                     ))

casperdcl · 2021-11-16T18:44:13Z

yes I think misconfigured tests also meant they didn't run pre-merge

simaoafonso-pwt · 2021-11-16T18:45:48Z

yes I think misconfigured tests also meant they didn't run pre-merge

The main problem is that it needs a new tag, since the existing tag failed halfway. The tests pass with that tag.

- follow-up to #57

simaoafonso-pwt · 2021-11-16T19:20:24Z

Oops, I was testing this on a large parser, and I missed skipping the argparse.SUPRESS optional arguments. The positional are correctly skipped.

shtab/shtab/__init__.py

Lines 628 to 634 in 3aca487

    
           for optional_str in optional.option_strings: 
        
               log.debug('%s| | %s', log_prefix, optional_str) 
        
               if optional_str.startswith('--'): 
        
                   optionals_double.add(optional_str[2:]) 
        
               elif optional_str.startswith('-'): 
        
                   optionals_single.add(optional_str[1:]) 
        
               specials.extend(get_specials(optional, 'n', optional_str))

It's a matter of gating that with if optional.help != SUPRESS:. Should I open a PR for this oneline change?

casperdcl · 2021-11-16T19:30:01Z

Should I open a PR for this oneline change?

yes please do 🙏

See iterative#57

casperdcl self-requested a review November 8, 2021 15:33

casperdcl added the enhancement New feature or request label Nov 8, 2021

casperdcl reviewed Nov 15, 2021

View reviewed changes

examples/customcomplete.py Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

shtab/__init__.py Outdated Show resolved Hide resolved

shtab/main.py Outdated Show resolved Hide resolved

tests/test_shtab.py Show resolved Hide resolved

casperdcl added the shell-tcsh label Nov 16, 2021

casperdcl assigned simaoafonso-pwt Nov 16, 2021

casperdcl force-pushed the tcsh branch 3 times, most recently from 0461bf9 to b2e5a2c Compare November 16, 2021 00:52

casperdcl reviewed Nov 16, 2021

View reviewed changes

simaoafonso-pwt added a commit to simaoafonso-pwt/shtab that referenced this pull request Nov 16, 2021

Tweak customcomplete completion

4084ce2

See iterative#57 (comment)

casperdcl requested changes Nov 16, 2021

View reviewed changes

docs/use.md Outdated Show resolved Hide resolved

docs/use.md Outdated Show resolved Hide resolved

docs/use.md Outdated Show resolved Hide resolved

simaoafonso-pwt requested a review from casperdcl November 16, 2021 15:28

simaoafonso-pwt and others added 5 commits November 16, 2021 16:50

Initial support for tcsh

9f1db35

This is incomplete due to tcsh limitations, but functional (iterative#56) Make customcomplete herder to parser Mixup main parser positionals and sub-parser positionals on the same "position".

Support changing the verbosity on the cli

cfc7355

misc tidy, update examples/customcomplete.py, basic docs

1a79b86

Include usage documentation

3f5d078

Tweak customcomplete completion See iterative#57 (comment)

misc tidy

d5743cd

casperdcl force-pushed the tcsh branch from 032ba1a to d5743cd Compare November 16, 2021 16:52

casperdcl merged commit 46302c5 into iterative:master Nov 16, 2021

casperdcl reviewed Nov 16, 2021

View reviewed changes

simaoafonso-pwt mentioned this pull request Nov 16, 2021

Support for tcsh completion #56

Closed

casperdcl linked an issue Nov 16, 2021 that may be closed by this pull request

Support for tcsh completion #56

Closed

casperdcl added a commit that referenced this pull request Nov 16, 2021

docs: tcsh

3aca487

- follow-up to #57

simaoafonso-pwt added a commit to simaoafonso-pwt/shtab that referenced this pull request Nov 16, 2021

Skip suppressed optional arguments on tcsh

edbe807

See iterative#57

simaoafonso-pwt mentioned this pull request Nov 16, 2021

Skip suppressed optional arguments on tcsh #58

Merged

casperdcl pushed a commit to simaoafonso-pwt/shtab that referenced this pull request Nov 23, 2021

Skip suppressed optional arguments on tcsh

feda5b9

See iterative#57

simaoafonso-pwt mentioned this pull request Oct 28, 2022

tcsh: Fix autocompletion for no single-hyphen args #112

Merged

Comments

Conversation

simaoafonso-pwt commented Nov 5, 2021

Uh oh!

simaoafonso-pwt commented Nov 8, 2021

Uh oh!

simaoafonso-pwt commented Nov 15, 2021

Uh oh!

casperdcl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

simaoafonso-pwt commented Nov 15, 2021

Uh oh!

casperdcl commented Nov 16, 2021

Uh oh!

casperdcl left a comment

Choose a reason for hiding this comment

Uh oh!

casperdcl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

casperdcl left a comment

Choose a reason for hiding this comment

Uh oh!

casperdcl commented Nov 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

simaoafonso-pwt commented Nov 16, 2021

Uh oh!

simaoafonso-pwt commented Nov 16, 2021

Uh oh!

casperdcl commented Nov 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

simaoafonso-pwt commented Nov 16, 2021

Uh oh!

simaoafonso-pwt commented Nov 16, 2021

Uh oh!

casperdcl commented Nov 16, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

casperdcl commented Nov 16, 2021 •

edited

Loading

casperdcl commented Nov 16, 2021 •

edited

Loading