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
|
============
User Classes
============
Cyclopts supports classically defined user classes, as well as classes defined by the following dataclass-like libraries:
* `attrs <https://www.attrs.org/en/stable/>`_
* `dataclass <https://docs.python.org/3/library/dataclasses.html>`_
* `pydantic <https://docs.pydantic.dev/latest/>`_
* `NamedTuple <https://docs.python.org/3/library/typing.html#typing.NamedTuple>`_
* `TypedDict <https://docs.python.org/3/library/typing.html#typing.TypedDict>`_
As an example, lets consider using the builtin :obj:`~dataclasses.dataclass` to make a CLI that manages a movie collection.
.. code-block:: python
from cyclopts import App
from dataclasses import dataclass
app = App(name="movie-maintainer")
@dataclass
class Movie:
title: str
year: int
@app.command
def add(movie: Movie):
print(f"Adding movie: {movie}")
app()
.. code-block:: console
$ movie-maintainer add --help
Usage: movie-maintainer add [ARGS] [OPTIONS]
╭─ Parameters ────────────────────────────────────────────────╮
│ * MOVIE.TITLE [required] │
│ --movie.title │
│ * MOVIE.YEAR --movie.year [required] │
╰─────────────────────────────────────────────────────────────╯
$ movie-maintainer add 'Mad Max: Fury Road' 2015
Adding movie: Movie(title='Mad Max: Fury Road', year=2015)
$ movie-maintainer add --movie.title 'Furiosa: A Mad Max Saga' --movie.year 2024
Adding movie: Movie(title='Furiosa: A Mad Max Saga', year=2024)
In most circumstances\*, Cyclopts will also parse a json-string for a dataclass-like parameter:
.. code-block:: console
$ movie-maintainer add --movie='{"title": "Mad Max: Fury Road", "year": 2024}'
Adding movie: Movie(title='Mad Max: Fury Road', year=2024)
Json parsing will be performed when:
1. The parameter has to be specified as a keyword option; e.g. ``--movie``.
2. The referenced parameter must be dataclass-like.
3. The referenced parameter **cannot** be union'd with a ``str``.
4. The first character must be a ``{``.
This behavior can be further configured via :class:`.Parameter`
.. _Namespace Flattening:
--------------------
Namespace Flattening
--------------------
It is likely that the actual movie class/object is not important to the CLI user, and the parameter names like ``--movie.title`` are unnecessarily verbose. We can remove ``movie`` from the name by giving the ``Movie`` type annotation the special name ``"*"``.
.. code-block:: python
from cyclopts import App, Parameter
from dataclasses import dataclass
from typing import Annotated
app = App(name="movie-maintainer")
@dataclass
class Movie:
title: str
year: int
@app.command
def add(movie: Annotated[Movie, Parameter(name="*")]):
print(f"Adding movie: {movie}")
app()
.. code-block:: console
$ movie-maintainer add --help
Usage: movie-maintainer add [ARGS] [OPTIONS]
╭─ Parameters ────────────────────────────────────────────────╮
│ * TITLE --title [required] │
│ * YEAR --year [required] │
╰─────────────────────────────────────────────────────────────╯
An alternative way of supplying the :class:`.Parameter` configuration is via a decorator.
This way can be cleaner and terser in many scenarios.
The :class:`.Parameter` configuration will also be inherited by subclasses.
.. code-block:: python
from cyclopts import App, Parameter
from dataclasses import dataclass
app = App(name="movie-maintainer")
@Parameter(name="*")
@dataclass
class Movie:
title: str
year: int
@app.command
def add(movie: Movie):
print(f"Adding movie: {movie}")
app()
.. _Sharing Parameters:
------------------
Sharing Parameters
------------------
A flattened dataclass provides a natural way of easily sharing a set of parameters between commands.
.. code-block:: python
from cyclopts import App, Parameter
from dataclasses import dataclass
app = App(name="movie-maintainer")
@Parameter(name="*")
@dataclass
class Config:
user: str
server: str = "media.sqlite"
@dataclass
class Movie:
title: str
year: int
@app.command
def add(movie: Movie, *, config: Config):
print(f"Config: {config}")
print(f"Adding movie: {movie}")
@app.command
def remove(movie: Movie, *, config: Config):
print(f"Config: {config}")
print(f"Removing movie: {movie}")
app()
.. code-block:: console
$ movie-maintainer remove --help
Usage: movie-maintainer remove [ARGS] [OPTIONS]
╭─ Parameters ────────────────────────────────────────────────╮
│ * MOVIE.TITLE [required] │
│ --movie.title │
│ * MOVIE.YEAR --movie.year [required] │
│ * --user [required] │
│ --server [default: media.sqlite] │
╰─────────────────────────────────────────────────────────────╯
$ movie-maintainer remove 'Mad Max: Fury Road' 2015 --user Guido
Config: Config(user='Guido', server='media.sqlite')
Removing movie: Movie(title='Mad Max: Fury Road', year=2015)
-----------
Config File
-----------
Having the user specify ``--user`` every single call is a bit cumbersome, especially if they're always going to provide the same value.
We can have Cyclopts fallback to a :ref:`toml configuration file <Config Files>`.
Consider the following toml data saved to ``config.toml``:
.. code-block:: toml
# config.toml
user = "Guido"
We can update our app to fill in missing CLI parameters from this file:
.. code-block:: python
from cyclopts import App, Parameter, config
from dataclasses import dataclass
from typing import Annotated
app = App(
name="movie-maintainer",
config=config.Toml("config.toml", use_commands_as_keys=False),
)
@Parameter(name="*")
@dataclass
class Config:
user: str
server: str = "media.sqlite"
@dataclass
class Movie:
title: str
year: int
@app.command
def add(movie: Movie, *, config: Config):
print(f"Config: {config}")
print(f"Adding movie: {movie}")
app()
.. code-block:: console
$ movie-maintainer add 'Mad Max: Fury Road' 2015
Config: Config(user='Guido', server='media.sqlite')
Adding movie: Movie(title='Mad Max: Fury Road', year=2015)
|