Skip to content

Reference

Console 

Console(theme: Optional[Theme] = None)

Parameters:

  • theme

    (Optional[Theme], default: None ) –

    The theme to use for the console output.

Methods:

Attributes:

Source code in saiuncli/console.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def __init__(self, theme: Optional["Theme"] = None):
    """Initialize the Console with a theme.

    Args:
        theme (Optional[Theme]): The theme to use for the console output.
    """
    self.theme = theme or Theme()

    class OptionHighlighter(RegexHighlighter):
        highlights = [r"(?P<short_flag>\-\w)", r"(?P<long_flag>\-\-[\w\-]+)"]

    self._highlighter = OptionHighlighter()
    self._console = RichConsole(
        theme=RichTheme(
            {
                "long_flag": self.theme.option_long,
                "short_flag": self.theme.option_short,
            }
        ),
        highlighter=self._highlighter,
    )

theme instance-attribute 

theme = theme or Theme()

display_arguments_table 

display_arguments_table(
    arguments: Optional[List[Argument]] = None,
) -> None

Display the arguments table for the CLI tool. Args: arguments (Optional[List[Argument]]): The arguments to display.

Source code in saiuncli/console.py 
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
def display_arguments_table(
    self,
    arguments: Optional[List[Argument]] = None,
) -> None:
    """Display the arguments table for the CLI tool.
    Args:
        arguments (Optional[List[Argument]]): The arguments to display.
    """
    if not arguments:
        return

    arguments_table = Table(highlight=True, box=None, show_header=False)
    for argument in arguments:
        help_message = ""
        if argument.description:
            help_message = Text.from_markup(argument.description)
            help_message.style = self.theme.argument_description

            argument_name = Text(argument.name, style=self.theme.argument)
            arguments_table.add_row(argument_name, help_message)
    self.print(
        Panel(arguments_table, border_style="dim", title_align="left", title="Arguments")
    )

display_header 

display_header(
    title: str,
    description: Optional[str] = None,
    version: Optional[str] = None,
) -> None

Display Header Information for a CLI tool. Args: title (str): The title of the CLI tool. description (Optional[str]): A brief description of the CLI tool. version (Optional[str]): The version of the CLI tool.

Source code in saiuncli/console.py 
 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
def display_header(
    self,
    title: str,
    description: Optional[str] = None,
    version: Optional[str] = None,
) -> None:
    """Display Header Information for a CLI tool.
    Args:
        title (str): The title of the CLI tool.
        description (Optional[str]): A brief description of the CLI tool.
        version (Optional[str]): The version of the CLI tool.
    """

    title = Text(title, style=self.theme.title)
    if version:
        version = Text(f"v{version}", style=self.theme.version)
        title.pad_right(1)
        title.append(version)
    self.print(
        title,
        justify="center",
    )
    self.print()
    if description:
        title_description = Text(description, style=self.theme.title_description)
        self.print(
            title_description,
            justify="center",
        )
        self.print()
    self.print()

display_help 

display_help(
    title: str = None,
    usage: str = None,
    description: Optional[str] = None,
    version: Optional[str] = None,
    options: Optional[str] = None,
    arguments: Optional[str] = None,
    subcommands: Optional[str] = None,
    show_header: bool = True,
    help_flags: Optional[List[str]] = None,
    version_flags: Optional[List[str]] = None,
) -> None

Display the help message for a CLI tool.

Parameters:

  • title

    (str, default: None ) –

    The title of the CLI tool.

  • usage

    (str, default: None ) –

    The usage information for the CLI tool.

  • description

    (Optional[str], default: None ) –

    A brief description of the CLI tool.

  • version

    (Optional[str], default: None ) –

    The version of the CLI tool.

  • options

    (Optional[List[Option]], default: None ) –

    The options available for the CLI tool.

  • arguments

    (Optional[List[Argument]], default: None ) –

    The arguments available for the CLI tool.

  • subcommands

    (Optional[List[Command]], default: None ) –

    The subcommands available for the CLI tool.

  • show_header

    (bool, default: True ) –

    Whether to display the header information.

  • help_flags

    (Optional[List[str]], default: None ) –

    The help flags for the CLI tool.

  • version_flags

    (Optional[List[str]], default: None ) –

    The version flags for the CLI tool.

Source code in saiuncli/console.py 
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
def display_help(
    self,
    title: str = None,
    usage: str = None,
    description: Optional[str] = None,
    version: Optional[str] = None,
    options: Optional[str] = None,
    arguments: Optional[str] = None,
    subcommands: Optional[str] = None,
    show_header: bool = True,
    help_flags: Optional[List[str]] = None,
    version_flags: Optional[List[str]] = None,
) -> None:
    """
    Display the help message for a CLI tool.

    Args:
        title (str): The title of the CLI tool.
        usage (str): The usage information for the CLI tool.
        description (Optional[str]): A brief description of the CLI tool.
        version (Optional[str]): The version of the CLI tool.
        options (Optional[List[Option]]): The options available for the CLI tool.
        arguments (Optional[List[Argument]]): The arguments available for the CLI tool.
        subcommands (Optional[List[Command]]): The subcommands available for the CLI tool.
        show_header (bool): Whether to display the header information.
        help_flags (Optional[List[str]]): The help flags for the CLI tool.
        version_flags (Optional[List[str]]): The version flags for the CLI tool.
    """
    if show_header and title:
        self.display_header(title, description, version)

    self.display_usage(usage)
    self.display_subcommands_table(subcommands=subcommands)
    self.display_options_table(
        options=options, version_flags=version_flags, help_flags=help_flags
    )
    self.display_arguments_table(arguments=arguments)

display_options_table 

display_options_table(
    options: Optional[List[Option]],
    version_flags: Optional[List[str]] = None,
    help_flags: Optional[List[str]] = None,
) -> None

Display the options table for the CLI tool.

Parameters:

  • options

    (Optional[List[Option]]) –

    The options to display.

  • version_flags

    (Optional[List[str]], default: None ) –

    The version flags for the CLI tool.

  • help_flags

    (Optional[List[str]], default: None ) –

    The help flags for the CLI tool.

Source code in saiuncli/console.py 
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
def display_options_table(
    self,
    options: Optional[List[Option]],
    version_flags: Optional[List[str]] = None,
    help_flags: Optional[List[str]] = None,
) -> None:
    """Display the options table for the CLI tool.

    Args:
        options (Optional[List[Option]]): The options to display.
        version_flags (Optional[List[str]]): The version flags for the CLI tool.
        help_flags (Optional[List[str]]): The help flags for the CLI tool.
    """
    if not options:
        return

    options_table = Table(highlight=True, box=None, show_header=False)
    for option in options:
        help_message = Text("")
        if option.description:
            help_message = Text.from_markup(option.description)
            help_message.style = self.theme.option_description
        if len(option.flags) == 2:
            opt1 = self._highlighter(option.flags[0])
            opt2 = self._highlighter(option.flags[1])
        else:
            opt1 = self._highlighter(option.flags[0])
            opt2 = Text("")
        opt2.pad_right(5)
        options_table.add_row(opt1, opt2, help_message)
    # Always add version flags to the bottom of Global Options table
    if len(version_flags) == 2:
        version_flag1 = self._highlighter(version_flags[0])
        version_flag2 = self._highlighter(version_flags[1])
    else:
        version_flag1 = self._highlighter(version_flags[0])
        version_flag2 = Text("")
    version_flag2.pad_right(5)
    options_table.add_row(
        version_flag1,
        version_flag2,
        Text("Display the version.", style=self.theme.option_description),
    )
    # Always add help flags to the bottom Global Options table
    if len(help_flags) == 2:
        help_flag1 = self._highlighter(help_flags[0])
        help_flag2 = self._highlighter(help_flags[1])
    else:
        help_flag1 = self._highlighter(help_flags[0])
        help_flag2 = Text("")
    help_flag2.pad_right(5)
    options_table.add_row(
        help_flag1,
        help_flag2,
        Text("Display this help message and exit.", style=self.theme.option_description),
    )
    self.print(Panel(options_table, border_style="dim", title_align="left", title="Options"))

display_subcommands_table 

display_subcommands_table(
    subcommands: Optional[List[Command]] = None,
) -> None

Display the subcommands table for the CLI tool. Args: subcommands (Optional[List[Command]]): The subcommands to display.

Source code in saiuncli/console.py 
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
def display_subcommands_table(self, subcommands: Optional[List[Command]] = None) -> None:
    """Display the subcommands table for the CLI tool.
    Args:
        subcommands (Optional[List[Command]]): The subcommands to display.
    """

    if not subcommands:
        return
    subcommands_table = Table(highlight=True, box=None, show_header=False)
    for subcommand in subcommands:
        help_message = (
            Text.from_markup(subcommand.description) if subcommand.description else Text("")
        )
        help_message.style = self.theme.subcommand_description

        if subcommand.description:
            subcommand_name = Text(subcommand.name, style=self.theme.subcommand)
            subcommand_name.pad_right(5)

            subcommands_table.add_row(subcommand_name, help_message)
    self.print(
        Panel(subcommands_table, border_style="dim", title_align="left", title="Subcommands")
    )

display_usage 

display_usage(usage: str = None) -> None

Display the usage information for the CLI tool. Args: usage (str): The usage information for the CLI tool.

Source code in saiuncli/console.py 
114
115
116
117
118
119
def display_usage(self, usage: str = None) -> None:
    """Display the usage information for the CLI tool.
    Args:
        usage (str): The usage information for the CLI tool.
    """
    self.print(Text(f"Usage: {usage}"), style=self.theme.usage)

display_version 

display_version(version: str) -> None

Display the version of the CLI tool. Args: version (str): The version of the CLI tool.

Source code in saiuncli/console.py 
121
122
123
124
125
126
127
128
129
130
131
132
def display_version(self, version: str) -> None:
    """Display the version of the CLI tool.
    Args:
        version (str): The version of the CLI tool.
    """
    self.print(
        Text(
            f"v{version}",
            style=self.theme.version,
        ),
        justify="left",
    )

error 

error(message: str) -> None

Display an error message in the console.

Source code in saiuncli/console.py 
58
59
60
61
62
63
64
def error(self, message: str) -> None:
    """Display an error message in the console."""
    style = self.theme.error_prefix.style
    symbol = self.theme.error_prefix.symbol
    self.print(
        f"[{style}]{symbol}[/{style}] {message}",
    )

info 

info(message: str) -> None

Display an informational message in the console.

Source code in saiuncli/console.py 
74
75
76
77
78
79
80
def info(self, message: str) -> None:
    """Display an informational message in the console."""
    style = self.theme.info_prefix.style
    symbol = self.theme.info_prefix.symbol
    self.print(
        f"[{style}]{symbol}[/{style}] {message}",
    )

print 

print(
    *objects: Any,
    style: Optional[str] = None,
    **kwargs: Any
) -> None

Display rich text in the console

Wraps the rich console print method to allow for custom styling.

Parameters:

  • *objects

    (Any, default: () ) –

    The objects to print to the console.

  • style

    (Optional[str], default: None ) –

    The style to apply to the text.

  • **kwargs

    (Any, default: {} ) –

    Additional keyword arguments for the print method.

Source code in saiuncli/console.py 
38
39
40
41
42
43
44
45
46
47
48
def print(self, *objects: Any, style: Optional[str] = None, **kwargs: Any) -> None:
    """Display rich text in the console

    Wraps the rich console print method to allow for custom styling.

    Args:
        *objects (Any): The objects to print to the console.
        style (Optional[str]): The style to apply to the text.
        **kwargs (Any): Additional keyword arguments for the print method.
    """
    self._console.print(*objects, style=style, **kwargs)

success 

success(message: str) -> None

Display a success message in the console.

Source code in saiuncli/console.py 
50
51
52
53
54
55
56
def success(self, message: str) -> None:
    """Display a success message in the console."""
    style = self.theme.success_prefix.style
    symbol = self.theme.success_prefix.symbol
    self.print(
        f"[{style}]{symbol}[/{style}] {message}",
    )

warning 

warning(message: str) -> None

Display a warning message in the console.

Source code in saiuncli/console.py 
66
67
68
69
70
71
72
def warning(self, message: str) -> None:
    """Display a warning message in the console."""
    style = self.theme.warning_prefix.style
    symbol = self.theme.warning_prefix.symbol
    self.print(
        f"[{style}]{symbol}[/{style}] {message}",
    )