-
Notifications
You must be signed in to change notification settings - Fork 55
/
cli_options.py
162 lines (136 loc) · 4.11 KB
/
cli_options.py
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
# Copyright (c) 2023 Contributors to COVESA
#
# This program and the accompanying materials are made available under the
# terms of the Mozilla Public License 2.0 which is available at
# https://www.mozilla.org/en-US/MPL/2.0/
#
# SPDX-License-Identifier: MPL-2.0
from pathlib import Path
import rich_click as click
from rich_click import option
from vss_tools.vspec.model import get_all_model_fields
def validate_attribute(value):
"""
Checks that a user given attribute is valid.
Should not contain ',' and should not be a core attribute
"""
if "," in value:
raise click.BadParameter("Comma (',') not allowed")
if value in get_all_model_fields():
raise click.BadParameter(f"'{value}' is a core attribute")
return value
log_level_opt = click.option(
"--log-level",
type=click.Choice(["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"], case_sensitive=False),
default="INFO",
help="Log level.",
show_default=True,
)
log_file_opt = click.option(
"--log-file",
type=click.Path(dir_okay=False, writable=True, path_type=Path),
help="Log file.",
)
include_dirs_opt = option(
"--include-dirs",
"-I",
multiple=True,
type=click.Path(file_okay=False, readable=True, path_type=Path, exists=True),
help="Add include directory to search for included vspec files.",
)
extended_attributes_opt = option(
"--extended-attributes",
"-e",
multiple=True,
type=validate_attribute,
help="Whitelisted extended attributes",
)
strict_opt = option(
"--strict/--no-strict",
help="Whether to enable strict. Enables all '--abort/-a' values.",
default=False,
show_default=True,
)
aborts_opt = option(
"--aborts",
"-a",
multiple=True,
type=click.Choice(["unknown-attribute", "name-style"]),
help="Abort on selected option. The '--strict' option enables all of them.",
show_choices=True,
)
uuid_opt = option("--uuid/--no-uuid", help="Whether to add UUIDs.", show_default=True, default=False)
expand_opt = option(
"--expand/--no-expand",
default=True,
show_default=True,
help="Whether to expand 'instances'.",
)
overlays_opt = option(
"--overlays",
"-l",
multiple=True,
type=click.Path(dir_okay=False, readable=True, path_type=Path, exists=True),
help="Overlay files to apply on top of the vspec.",
)
quantities_opt = option(
"--quantities",
"-q",
multiple=True,
type=click.Path(dir_okay=False, readable=True, path_type=Path, exists=True),
help="Quantity files. [default: VSPEC/quantities.yaml]",
)
units_opt = option(
"--units",
"-u",
type=click.Path(dir_okay=False, readable=True, path_type=Path, exists=True),
help="Unit files. [default: VSPEC/units.yaml]",
multiple=True,
)
vspec_opt = option(
"--vspec",
"-s",
type=click.Path(dir_okay=False, readable=True, path_type=Path, exists=True),
required=True,
help="The vspec file.",
)
output_required_opt = option(
"--output",
"-o",
type=click.Path(dir_okay=False, writable=True, path_type=Path),
help="Output file.",
required=True,
)
output_opt = option(
"--output",
"-o",
type=click.Path(dir_okay=False, writable=True, path_type=Path),
help="Output file.",
)
types_opt = option(
"--types",
"-t",
multiple=True,
type=click.Path(dir_okay=False, readable=True, path_type=Path, exists=True),
help="Data types files.",
)
types_output_opt = option(
"--types-output",
type=click.Path(dir_okay=False, writable=True, path_type=Path),
help="""
Output file for writing data types from vspec file.
If not specified, a single file is used where applicable.
In case of JSON and YAML, the data is exported under a
special key: "ComplexDataTypes",
""",
)
extend_all_attributes_opt = option(
"--extend-all-attributes/--no-extend-all-attributes",
help="""
Generates all extended attributes,
not only the ones given via '-e/--extended-attributes'
""",
default=False,
show_default=True,
)
pretty_print_opt = option("--pretty/--no-pretty", help="Pretty print.", default=False, show_default=True)