Improving GDSII cli

[ThVerg]

Hey everyone,

here are some thoughts for improving the new GDSII flow cli commands.

1. When i press tab at gen_tile_macro i would like to see maybe a list of the available tiles and the options available ( --optimize and --override) and them with their options as well. Currently when i do it i get this :

FABulous> gen_tile_macro                   
EXCEPTION of type 'TypeError' occurred with message: FABulous_CLI.<lambda>() takes 1 positional argument but 5 were given
To enable full traceback, run the following command: 'set debug true' 

2. Here in this Hint i would also like to see the available optimization modes

FABulous> gen_tile_macro --optimise 
Hint:
  --optimise, -opt [OPTIMISE]
                        Optimize the GDS layout

3. Here this Hint is wrong i believe

FABulous> gen_tile_macro --override 
Hint:
  --override OVERRIDE  Optimize the GDS layout

4. Optimization modes are only acceptable with every letter in lowercase and will produce an error otherwise

FABulous> gen_tile_macro --optimise BALANCE
Usage: gen_tile_macro [-h] [--optimise [OPTIMISE]] [--override OVERRIDE] tile
Error: argument --optimise/-opt: invalid OptMode value: 'BALANCE'

[KelvinChung2000]

For 1. I have written something that should cover that, but it doesn't seem to be doing so atm. I need to add more test case to cover that.

FABulous/fabulous/fabulous_cli/fabulous_cli.py

Lines 1327 to 1329 in 7d11f8a

	if not args.tile:
	logger.error("Tile name must be specified")
	return

So this could also be a problem from the upstream cmd2. As that looks like it is hitting something from that side before even hitting our logic.

For 2. and 3., this depends on how argparse works, since we do the command parsing via the cmd2-provided argparse logic, and I don't think it's possible from the argparse side. If you would like to tab hint on flags, I think that might be possible? But flag parsing is actually a lot harder than it seems a lot of the time, specially when you need proper parsing. In the hinting case, this implies the parser needs to know you are now working on the flag and to use the flag completer, then a path completer, for example.

However, I do plan to migrate toward something more Typer-like (what we have in our start-up's CLI tool).
So you should be able to get a message like the following:

Which will show you that the create command is missing a project dir, and that all the good stuff provided by typer will work.
I have been doing a bit of work on this, actually, python-cmd2/cmd2#1530
And the cmd2 team has considered this as well python-cmd2/cmd2#1538
But probably not any time soon, or at least not for a while.

For 4., it's because the mode is a StrEnum, which now only supports lowercase, but I can add support to make it case-insensitive.