Show the default for switch options in transport CLI

[sphuber]

The autogenerated command line interfaces for transport plugins were not
setting show_default to True, even if a non_interactive_default is
specified, which means that the help string would not say which of the
two switch values is the default.

[ltalirz]

thanks @sphuber !

I can't say I fully understand what's going on with the different defaults here but I've checked that it fixes the help strings (and that interactive configuration still works as well).

[ltalirz]

could this then not just move outside the if/else?

[codecov]

Codecov Report

Merging #4223 into develop will increase coverage by 0.01%.
The diff coverage is 87.50%.

@@             Coverage Diff             @@
##           develop    #4223      +/-   ##
===========================================
+ Coverage    79.17%   79.17%   +0.01%     
===========================================
  Files          468      468              
  Lines        34467    34464       -3     
===========================================
- Hits         27285    27284       -1     
+ Misses        7182     7180       -2     

Flag	Coverage Δ
#django	71.09% <87.50%> (+0.01%)	⬆️
#sqlalchemy	71.93% <87.50%> (+0.01%)	⬆️

Impacted Files	Coverage Δ
aiida/transports/plugins/ssh.py	76.39% <ø> (ø)
aiida/transports/cli.py	93.34% <87.50%> (+0.87%)	⬆️
aiida/transports/plugins/local.py	80.47% <0.00%> (+0.26%)	⬆️

---

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 5e5d5e0...66bc488. Read the comment docs.

[sphuber]

I can't say I fully understand what's going on with the different defaults here but I've checked that it fixes the help strings (and that interactive configuration still works as well).

I agree that the non_interactive_default key was not very clear, it also took me quite a while to figure out the original intention. I have updated the code and docstrings a bit to hopefully clarify its functioning. I have dismissed your first review since the code changed quite a bit. Would be good if you could test again that help strings are correct and that interactive works.

[ltalirz]

Thanks @sphuber , the code has certainly gotten a lot more readable.

I checked that the defaults are still shown and that the configuration still works.

I wonder whether we would like to show the default values also for a couple of other options that now seem treated differently

$ verdi computer configure ssh -h
Usage: verdi computer configure ssh [OPTIONS] COMPUTER

  Configure COMPUTER for ssh transport.

Options:
...
  -P, --port INTEGER              Port number.
...
  --key-filename FILE             Absolute path to your private SSH key. Leave
                                  empty to use the path set in the SSH config.

  --timeout INTEGER               Time in seconds to wait for connection
                                  before giving up. Leave empty to use default
                                  value.
...

...
  --safe-interval FLOAT           Minimum time interval in seconds between
                                  opening new connections.