forked from openml/openml-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcli.py
More file actions
368 lines (301 loc) 路 12 KB
/
Copy pathcli.py
File metadata and controls
368 lines (301 loc) 路 12 KB
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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
"""Command Line Interface for `openml` to configure its settings."""
from __future__ import annotations
import argparse
import string
import sys
from pathlib import Path
from typing import Callable
from urllib.parse import urlparse
from openml import config
def is_hex(string_: str) -> bool:
return all(c in string.hexdigits for c in string_)
def looks_like_url(url: str) -> bool:
# There's no thorough url parser, but we only seem to use netloc.
try:
return bool(urlparse(url).netloc)
except Exception: # noqa: BLE001
return False
def wait_until_valid_input(
prompt: str,
check: Callable[[str], str],
sanitize: Callable[[str], str] | None,
) -> str:
"""Asks `prompt` until an input is received which returns True for `check`.
Parameters
----------
prompt: str
message to display
check: Callable[[str], str]
function to call with the given input, that provides an error message if the input is not
valid otherwise, and False-like otherwise.
sanitize: Callable[[str], str], optional
A function which attempts to sanitize the user input (e.g. auto-complete).
Returns
-------
valid input
"""
while True:
response = input(prompt)
if sanitize:
response = sanitize(response)
error_message = check(response)
if error_message:
print(error_message, end="\n\n")
else:
return response
def print_configuration() -> None:
file = config.determine_config_file_path()
header = f"File '{file}' contains (or defaults to):"
print(header)
max_key_length = max(map(len, config.get_config_as_dict()))
for field, value in config.get_config_as_dict().items():
print(f"{field.ljust(max_key_length)}: {value}")
def verbose_set(field: str, value: str) -> None:
config.set_field_in_config_file(field, value)
print(f"{field} set to '{value}'.")
def configure_apikey(value: str) -> None:
def check_apikey(apikey: str) -> str:
if len(apikey) != 32:
return f"The key should contain 32 characters but contains {len(apikey)}."
if not is_hex(apikey):
return "Some characters are not hexadecimal."
return ""
instructions = (
f"Your current API key is set to: '{config.apikey}'. "
"You can get an API key at https://new.openml.org. "
"You must create an account if you don't have one yet:\n"
" 1. Log in with the account.\n"
" 2. Navigate to the profile page (top right circle > Your Profile). \n"
" 3. Click the API Key button to reach the page with your API key.\n"
"If you have any difficulty following these instructions, let us know on Github."
)
configure_field(
field="apikey",
value=value,
check_with_message=check_apikey,
intro_message=instructions,
input_message="Please enter your API key:",
)
def configure_server(value: str) -> None:
def check_server(server: str) -> str:
is_shorthand = server in ["test", "production"]
if is_shorthand or looks_like_url(server):
return ""
return "Must be 'test', 'production' or a url."
def replace_shorthand(server: str) -> str:
if server == "test":
return "https://test.openml.org/api/v1/xml"
if server == "production":
return "https://www.openml.org/api/v1/xml"
return server
configure_field(
field="server",
value=value,
check_with_message=check_server,
intro_message="Specify which server you wish to connect to.",
input_message="Specify a url or use 'test' or 'production' as a shorthand: ",
sanitize=replace_shorthand,
)
def configure_cachedir(value: str) -> None:
def check_cache_dir(path: str) -> str:
_path = Path(path)
if _path.is_file():
return f"'{_path}' is a file, not a directory."
expanded = _path.expanduser()
if not expanded.is_absolute():
return f"'{_path}' is not absolute (even after expanding '~')."
if not expanded.exists():
try:
expanded.mkdir()
except PermissionError:
return f"'{path}' does not exist and there are not enough permissions to create it."
return ""
configure_field(
field="cachedir",
value=value,
check_with_message=check_cache_dir,
intro_message="Configuring the cache directory. It can not be a relative path.",
input_message="Specify the directory to use (or create) as cache directory: ",
)
def configure_connection_n_retries(value: str) -> None:
def valid_connection_retries(n: str) -> str:
if not n.isdigit():
return f"'{n}' is not a valid positive integer."
if int(n) <= 0:
return "connection_n_retries must be positive."
return ""
configure_field(
field="connection_n_retries",
value=value,
check_with_message=valid_connection_retries,
intro_message="Configuring the number of times to attempt to connect to the OpenML Server",
input_message="Enter a positive integer: ",
)
def configure_avoid_duplicate_runs(value: str) -> None:
def is_python_bool(bool_: str) -> str:
if bool_ in ["True", "False"]:
return ""
return "Must be 'True' or 'False' (mind the capital)."
def autocomplete_bool(bool_: str) -> str:
if bool_.lower() in ["n", "no", "f", "false", "0"]:
return "False"
if bool_.lower() in ["y", "yes", "t", "true", "1"]:
return "True"
return bool_
intro_message = (
"If set to True, when `run_flow_on_task` or similar methods are called a lookup is "
"performed to see if there already exists such a run on the server. "
"If so, download those results instead. "
"If set to False, runs will always be executed."
)
configure_field(
field="avoid_duplicate_runs",
value=value,
check_with_message=is_python_bool,
intro_message=intro_message,
input_message="Enter 'True' or 'False': ",
sanitize=autocomplete_bool,
)
def configure_verbosity(value: str) -> None:
def is_zero_through_two(verbosity: str) -> str:
if verbosity in ["0", "1", "2"]:
return ""
return "Must be '0', '1' or '2'."
intro_message = (
"Set the verbosity of log messages which should be shown by openml-python."
" 0: normal output (warnings and errors)"
" 1: info output (some high-level progress output)"
" 2: debug output (detailed information (for developers))"
)
configure_field(
field="verbosity",
value=value,
check_with_message=is_zero_through_two,
intro_message=intro_message,
input_message="Enter '0', '1' or '2': ",
)
def configure_retry_policy(value: str) -> None:
def is_known_policy(policy: str) -> str:
if policy in ["human", "robot"]:
return ""
return "Must be 'human' or 'robot'."
def autocomplete_policy(policy: str) -> str:
for option in ["human", "robot"]:
if option.startswith(policy.lower()):
return option
return policy
intro_message = (
"Set the retry policy which determines how to react if the server is unresponsive."
"We recommend 'human' for interactive usage and 'robot' for scripts."
"'human': try a few times in quick succession, less reliable but quicker response."
"'robot': try many times with increasing intervals, more reliable but slower response."
)
configure_field(
field="retry_policy",
value=value,
check_with_message=is_known_policy,
intro_message=intro_message,
input_message="Enter 'human' or 'robot': ",
sanitize=autocomplete_policy,
)
def configure_field( # noqa: PLR0913
field: str,
value: None | str,
check_with_message: Callable[[str], str],
intro_message: str,
input_message: str,
sanitize: Callable[[str], str] | None = None,
) -> None:
"""Configure `field` with `value`. If `value` is None ask the user for input.
`value` and user input are first corrected/auto-completed with `convert_value` if provided,
then validated with `check_with_message` function.
If the user input a wrong value in interactive mode, the user gets to input a new value.
The new valid value is saved in the openml configuration file.
In case an invalid `value` is supplied directly (non-interactive), no changes are made.
Parameters
----------
field: str
Field to set.
value: str, None
Value to field to. If `None` will ask user for input.
check_with_message: Callable[[str], str]
Function which validates `value` or user input, and returns either an error message if it
is invalid, or a False-like value if `value` is valid.
intro_message: str
Message that is printed once if user input is requested (e.g. instructions).
input_message: str
Message that comes with the input prompt.
sanitize: Union[Callable[[str], str], None]
A function to convert user input to 'more acceptable' input, e.g. for auto-complete.
If no correction of user input is possible, return the original value.
If no function is provided, don't attempt to correct/auto-complete input.
"""
if value is not None:
if sanitize:
value = sanitize(value)
malformed_input = check_with_message(value)
if malformed_input:
print(malformed_input)
sys.exit()
else:
print(intro_message)
value = wait_until_valid_input(
prompt=input_message,
check=check_with_message,
sanitize=sanitize,
)
verbose_set(field, value)
def configure(args: argparse.Namespace) -> None:
"""Calls the right submenu(s) to edit `args.field` in the configuration file."""
set_functions = {
"apikey": configure_apikey,
"server": configure_server,
"cachedir": configure_cachedir,
"retry_policy": configure_retry_policy,
"connection_n_retries": configure_connection_n_retries,
"avoid_duplicate_runs": configure_avoid_duplicate_runs,
"verbosity": configure_verbosity,
}
def not_supported_yet(_: str) -> None:
print(f"Setting '{args.field}' is not supported yet.")
if args.field not in ["all", "none"]:
set_functions.get(args.field, not_supported_yet)(args.value)
else:
if args.value is not None:
print(f"Can not set value ('{args.value}') when field is specified as '{args.field}'.")
sys.exit()
print_configuration()
if args.field == "all":
for set_field_function in set_functions.values():
set_field_function(args.value)
def main() -> None:
subroutines = {"configure": configure}
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(dest="subroutine")
parser_configure = subparsers.add_parser(
"configure",
description="Set or read variables in your configuration file. For more help also see "
"'https://openml.github.io/openml-python/main/usage.html#configuration'.",
)
configurable_fields = [f for f in config._defaults if f not in ["max_retries"]]
parser_configure.add_argument(
"field",
type=str,
choices=[*configurable_fields, "all", "none"],
default="all",
nargs="?",
help="The field you wish to edit. "
"Choosing 'all' lets you configure all fields one by one. "
"Choosing 'none' will print out the current configuration.",
)
parser_configure.add_argument(
"value",
type=str,
default=None,
nargs="?",
help="The value to set the FIELD to.",
)
args = parser.parse_args()
subroutines.get(args.subroutine, lambda _: parser.print_help())(args)
if __name__ == "__main__":
main()