✨ Add ability to show sub-commands

[rickwporter]

Rationale

When creating complex CLI programs, it is useful to see all the options available from/below a command.

Changes

Add Typer(command_tree=False) parameter to the constructor. When command_tree=True, there is a --show-sub-commands option available to see all the commands below the current one.

Example

See tests/assets/subcommand_tree.py for code. Here's an example of the output:

(.venv) ~/typer-rickwporter/tests/assets> ./subcommand_tree.py --help
                                                                                                
 Usage: subcommand_tree.py [OPTIONS] COMMAND [ARGS]...                                          
                                                                                                
 Random help                                                                                    
                                                                                                
╭─ Options ────────────────────────────────────────────────────────────────────────────────────╮
│ --show-sub-commands           Show sub-command tree                                          │
│ --install-completion          Install completion for the current shell.                      │
│ --show-completion             Show completion for the current shell, to copy it or customize │
│                               the installation.                                              │
│ --help                        Show this message and exit.                                    │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────╮
│ version   Print CLI version and exit                                                         │
│ users     Manage users                                                                       │
│ pets                                                                                         │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯

(.venv) ~/typer-rickwporter/tests/assets> ./subcommand_tree.py --show-sub-commands
╭─ Sub-Commands ───────────────────────────────────────────────────────────────────────────────╮
│ version*                       Print CLI version and exit                                    │
│ users                          Manage users                                                  │
│   add*                         Short help                                                    │
│   delete*                                                                                    │
│   update                       Update user info                                              │
│     name*                      change name                                                   │
│     address*                   change address                                                │
│ pets                                                                                         │
│   add*                         add pet                                                       │
│   list*                                                                                      │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯
* denotes commands without subcommands
(.venv) ~/typer-rickwporter/tests/assets> ./subcommand_tree.py version
My CLI Version 1.0
(.venv) ~/typer-rickwporter/tests/assets> ./subcommand_tree.py version --help
                                                                                                
 Usage: subcommand_tree.py version [OPTIONS]                                                    
                                                                                                
 Print CLI version and exit                                                                     
                                                                                                
╭─ Options ────────────────────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                                  │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯

(.venv) ~/typer-rickwporter/tests/assets> ./subcommand_tree.py users --help
                                                                                                
 Usage: subcommand_tree.py users [OPTIONS] COMMAND [ARGS]...                                    
                                                                                                
 Manage users                                                                                   
                                                                                                
╭─ Options ────────────────────────────────────────────────────────────────────────────────────╮
│ --show-sub-commands          Show sub-command tree                                           │
│ --help                       Show this message and exit.                                     │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────╮
│ add      Short help                                                                          │
│ delete                                                                                       │
│ update   Update user info                                                                    │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯

(.venv) ~/typer-rickwporter/tests/assets> ./subcommand_tree.py users --show-sub-commands
╭─ Sub-Commands ───────────────────────────────────────────────────────────────────────────────╮
│ add*                                  Short help                                             │
│ delete*                                                                                      │
│ update                                Update user info                                       │
│   name*                               change name                                            │
│   address*                            change address                                         │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯
* denotes commands without subcommands
(.venv) ~/typer-rickwporter/tests/assets> ./subcommand_tree.py users update --show-sub-commands
╭─ Sub-Commands ───────────────────────────────────────────────────────────────────────────────╮
│ name*                               change name                                              │
│ address*                            change address                                           │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯
* denotes commands without subcommands
(.venv) ~/typer-rickwporter/tests/assets>