Add shell completions by shtab

[Freed-Wu]

gpustat --print-completion bash | sudo tee /usr/share/bash-completion/completions/gpustat
gpustat --print-completion tcsh | sudo tee /etc/profile.d/gpustat.completion.csh
gpustat --print-completion zsh | sudo tee /usr/share/zsh/site-functions/_gpustat

% gpustat -i <TAB>
float
% gpustat -i -<TAB>
option
-a                   Display all gpu properties above
...

[Freed-Wu]

I fixed the conflict.

[wookayin]

Thanks, I think the feature works nice but there are some corner cases.

[wookayin]

Another corner case: if we execute gpustat as python -m gpustat, the completion file will start with #compdef __main__.py instead of #compdef gpustat. It might be an issue of shtab itself, but do you have any idea about how we can force the program name to be gpustat?

[Freed-Wu]

Another corner case: if we execute gpustat as python -m gpustat, the completion file will start with #compdef __main__.py instead of #compdef gpustat. It might be an issue of shtab itself, but do you have any idea about how we can force the program name to be gpustat?

Fixed. 😄

    parser = argparse.ArgumentParser(prog='gpustat')

[Freed-Wu]

Any other problems? It still displays 1 review requesting changes.

[wookayin]

Looks good, thank you. I will merge it soon and write docs for this.

[wookayin]

I have rebased your commit due to conflicts. Let me add some minor touches.

[Freed-Wu]

Good. When can it be accepted?

[wookayin]

@Freed-Wu Thank you for your contribution!

[wookayin]

For those who do not have root privileges, you can do like

$ pip install gpustat[completion]  # or do pip install shtab

$ gpustat --print-completion zsh > ~/.local/share/zsh/site-functions/_gpustat
$ gpustat --print-completion bash > ~/.bash_completion.d/gpustat

and add $HOME/.local/share/zsh/site-functions to $fpath (for zsh), or source the completion file (for bash).