Argparser auto-completion and colored help

[jnoortheen]

TODO:

• update completer to handle options and nargs
• add coloring

sub PRs:

I think it is better to split this PR

• support callable objects - feat: support var-args signature for aliases #4379
• argparser colored help and auto-completions - Argparser/color+completion #4391
• dirstack - Ap/dirstack #4446
• xonfig - ArgparserAlias - xonfig2 #4436
• xontrib - feat: use ArgparserAlias for xontrib #4441
• vox - argparserAlias - vox #4437
• run-tests.xsh - feat: use cli_utils to scaffold run-tests.xsh #4434

For community

⬇️ Please click the 👍 reaction instead of leaving a +1 or 👍 comment

[jnoortheen]

added motivation here #4284

[daniel-shimon]

Hey @jnoortheen - can you explain a bit which improvements this PR does? It's a bit hard to get from the code

[jnoortheen]

It generates parser.add_argument parameters from the function signature. I was thinking of using Annotated to pass the metadata that will make it more clear. Is it Ok to add https://pypi.org/project/typing-extensions/ ?

[daniel-shimon]

AFAIK all of xonsh's requirements need to be optional
So maybe it can be used optionally with fallbacking to Any

[jnoortheen]

AFAIK all of xonsh's requirements need to be optional
So maybe it can be used optionally with fallbacking to Any

Yes I was also hesitant adding another dependency. But this comes from Python core repo. Also I dont find any other way to pass the metadata that passes type-checker.

[daniel-shimon]

Since the type checker only runs in the CI, you can use this package and add it to the dev requirements file with a fallback to Any on import error. We don't really need the annotations in production anyway

[jnoortheen]

Since the type checker only runs in the CI, you can use this package and add it to the dev requirements file with a fallback to Any on import error. We don't really need the annotations in production anyway

Ok that is better.

[codecov-commenter]

Codecov Report

Merging #4267 (a864467) into main (db99b64) will increase coverage by 0.31%.
The diff coverage is 66.58%.

@@            Coverage Diff             @@
##             main    #4267      +/-   ##
==========================================
+ Coverage   57.13%   57.44%   +0.31%     
==========================================
  Files         138      136       -2     
  Lines       22178    22243      +65     
  Branches     4068     4096      +28     
==========================================
+ Hits        12671    12778     +107     
+ Misses       8454     8394      -60     
- Partials     1053     1071      +18     

Impacted Files	Coverage Δ
xonsh/dirstack.py	30.35% <30.00%> (-3.83%)	⬇️
xontrib/voxapi.py	26.06% <50.00%> (+4.84%)	⬆️
xonsh/xontribs.py	52.67% <62.50%> (+5.15%)	⬆️
xonsh/completers/completer.py	58.47% <67.18%> (+11.63%)	⬆️
xonsh/cli_utils.py	71.50% <67.30%> (-21.23%)	⬇️
xonsh/xonfig.py	35.35% <73.68%> (-2.48%)	⬇️
xontrib/vox.py	44.30% <74.28%> (+44.30%)	⬆️
xonsh/completers/tools.py	86.99% <81.57%> (-2.42%)	⬇️
xonsh/aliases.py	54.56% <100.00%> (+0.62%)	⬆️
xonsh/completers/init.py	100.00% <100.00%> (ø)
... and 6 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update db99b64...a864467. Read the comment docs.

[jnoortheen]

after coloring it looks like this

[jnoortheen]

@daniel-shimon are there any other things to check?

[anki-code]

The coloring is working for me:

[jnoortheen]

@anki-code this PR is outdated. I will close it after the related PRs get closed.

please check the one in here #4437