1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
|
# Nested SubCommands
We'll now see how these same ideas can be extended for deeply nested commands.
Let's imagine that the same *CLI program* from the previous examples now needs to handle `lands`.
But a land could be a `reign` or `town`.
And each of those could have their own commands, like `create` and `delete`.
## A CLI app for reigns
Let's start with a file `reigns.py`:
{* docs_src/subcommands/tutorial003/reigns.py *}
This is already a simple *CLI program* to manage reigns:
<div class="termy">
```console
// Check the help
$ python reigns.py --help
Usage: reigns.py [OPTIONS] COMMAND [ARGS]...
Options:
--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:
conquer
destroy
// Try it
$ python reigns.py conquer Cintra
Conquering reign: Cintra
$ python reigns.py destroy Mordor
Destroying reign: Mordor
```
</div>
## A CLI app for towns
And now the equivalent for managing towns in `towns.py`:
{* docs_src/subcommands/tutorial003/towns.py *}
With it, you can manage towns:
<div class="termy">
```console
// Check the help
$ python towns.py --help
Usage: towns.py [OPTIONS] COMMAND [ARGS]...
Options:
--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:
burn
found
// Try it
$ python towns.py found "New Asgard"
Founding town: New Asgard
$ python towns.py burn Vizima
Burning town: Vizima
```
</div>
## Manage the land in a CLI app
Now let's put the `reigns` and `towns` together in the same *CLI program* in `lands.py`:
{* docs_src/subcommands/tutorial003/lands.py *}
And now we have a single *CLI program* with a command (or command group) `reigns` that has its own commands. And another command `towns` with its own subcommands.
Check it:
<div class="termy">
```console
// Check the help
$ python lands.py --help
Usage: lands.py [OPTIONS] COMMAND [ARGS]...
Options:
--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:
reigns
towns
// We still have the help for reigns
$ python lands.py reigns --help
Usage: lands.py reigns [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
conquer
destroy
// And the help for towns
$ python lands.py towns --help
Usage: lands.py towns [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
burn
found
```
</div>
Now try it, manage the lands through the CLI:
<div class="termy">
```console
// Try the reigns command
$ python lands.py reigns conquer Gondor
Conquering reign: Gondor
$ python lands.py reigns destroy Nilfgaard
Destroying reign: Nilfgaard
// Try the towns command
$ python lands.py towns found Springfield
Founding town: Springfield
$ python lands.py towns burn Atlantis
Burning town: Atlantis
```
</div>
## Deeply nested subcommands
Now let's say that all these commands in the `lands.py` *CLI program* should be part of the previous *CLI program* we built in the first example.
We want our *CLI program* to have these commands/command groups:
* `users`:
* `create`
* `delete`
* `items`:
* `create`
* `delete`
* `sell`
* `lands`:
* `reigns`:
* `conquer`
* `destroy`
* `towns`:
* `found`
* `burn`
This already is a quite deeply nested "tree" of commands/command groups.
But to achieve that, we just have to add the `lands` **Typer** app to the same `main.py` file we already had:
{* docs_src/subcommands/tutorial003/main.py hl[4,10] *}
And now we have everything in a single *CLI program*:
<div class="termy">
```console
// Check the main help
$ python main.py --help
Usage: main.py [OPTIONS] COMMAND [ARGS]...
Options:
--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:
items
lands
users
// Try some users commands
$ python main.py users create Camila
Creating user: Camila
// Now try some items commands
$ python main.py items create Sword
Creating item: Sword
// And now some lands commands for reigns
$ python main.py lands reigns conquer Gondor
Conquering reign: Gondor
// And for towns
$ python main.py lands towns found Cartagena
Founding town: Cartagena
```
</div>
## Review the files
Here are all the files if you want to review/copy them:
`reigns.py`:
{* docs_src/subcommands/tutorial003/reigns.py *}
`towns.py`:
{* docs_src/subcommands/tutorial003/towns.py *}
`lands.py`:
{* docs_src/subcommands/tutorial003/lands.py *}
`users.py`:
{* docs_src/subcommands/tutorial003/users.py *}
`items.py`:
{* docs_src/subcommands/tutorial003/items.py *}
`main.py`:
{* docs_src/subcommands/tutorial003/main.py *}
/// tip
All these files have an `if __name__ == "__main__"` block just to demonstrate how each of them can also be an independent *CLI app*.
But for your final application, only `main.py` would need it.
///
## Recap
That's it, you can just add **Typer** applications one inside another as much as you want and create complex *CLI programs* while writing simple code.
You can probably achieve a simpler *CLI program* design that's easier to use than the example here. But if your requirements are complex, **Typer** helps you build your *CLI app* easily.
/// tip
Auto completion helps a lot, specially with complex programs.
Check the docs about adding auto completion to your *CLI apps*.
///
|