9 from overrides import overrides
12 # This module is commonly used by others in here and should avoid
13 # taking any unnecessary dependencies back on them.
15 logger = logging.getLogger(__name__)
18 class ActionNoYes(argparse.Action):
19 def __init__(self, option_strings, dest, default=None, required=False, help=None):
21 msg = 'You must provide a default with Yes/No action'
24 if len(option_strings) != 1:
25 msg = 'Only single argument is allowed with YesNo action'
28 opt = option_strings[0]
29 if not opt.startswith('--'):
30 msg = 'Yes/No arguments must be prefixed with --'
35 opts = ['--' + opt, '--no_' + opt]
47 def __call__(self, parser, namespace, values, option_strings=None):
48 if option_strings.startswith('--no-') or option_strings.startswith('--no_'):
49 setattr(namespace, self.dest, False)
51 setattr(namespace, self.dest, True)
54 def valid_bool(v: Any) -> bool:
56 If the string is a valid bool, return its value.
61 >>> valid_bool("true")
74 Traceback (most recent call last):
76 argparse.ArgumentTypeError: 12345
79 if isinstance(v, bool):
81 from string_utils import to_bool
86 raise argparse.ArgumentTypeError(v)
89 def valid_ip(ip: str) -> str:
91 If the string is a valid IPv4 address, return it. Otherwise raise
94 >>> valid_ip("1.2.3.4")
97 >>> valid_ip("localhost")
98 Traceback (most recent call last):
100 argparse.ArgumentTypeError: localhost is an invalid IP address
103 from string_utils import extract_ip_v4
105 s = extract_ip_v4(ip.strip())
108 msg = f"{ip} is an invalid IP address"
110 raise argparse.ArgumentTypeError(msg)
113 def valid_mac(mac: str) -> str:
115 If the string is a valid MAC address, return it. Otherwise raise
116 an ArgumentTypeError.
118 >>> valid_mac('12:23:3A:4F:55:66')
121 >>> valid_mac('12-23-3A-4F-55-66')
125 Traceback (most recent call last):
127 argparse.ArgumentTypeError: big is an invalid MAC address
130 from string_utils import extract_mac_address
132 s = extract_mac_address(mac)
135 msg = f"{mac} is an invalid MAC address"
137 raise argparse.ArgumentTypeError(msg)
140 def valid_percentage(num: str) -> float:
142 If the string is a valid percentage, return it. Otherwise raise
143 an ArgumentTypeError.
145 >>> valid_percentage("15%")
148 >>> valid_percentage('40')
151 >>> valid_percentage('115')
152 Traceback (most recent call last):
154 argparse.ArgumentTypeError: 115 is an invalid percentage; expected 0 <= n <= 100.0
159 if 0.0 <= n <= 100.0:
161 msg = f"{num} is an invalid percentage; expected 0 <= n <= 100.0"
163 raise argparse.ArgumentTypeError(msg)
166 def valid_filename(filename: str) -> str:
168 If the string is a valid filename, return it. Otherwise raise
169 an ArgumentTypeError.
171 >>> valid_filename('/tmp')
174 >>> valid_filename('wfwefwefwefwefwefwefwefwef')
175 Traceback (most recent call last):
177 argparse.ArgumentTypeError: wfwefwefwefwefwefwefwefwef was not found and is therefore invalid.
181 if os.path.exists(s):
183 msg = f"{filename} was not found and is therefore invalid."
185 raise argparse.ArgumentTypeError(msg)
188 def valid_date(txt: str) -> datetime.date:
189 """If the string is a valid date, return it. Otherwise raise
190 an ArgumentTypeError.
192 >>> valid_date('6/5/2021')
193 datetime.date(2021, 6, 5)
195 # Note: dates like 'next wednesday' work fine, they are just
196 # hard to test for without knowing when the testcase will be
198 >>> valid_date('next wednesday') # doctest: +ELLIPSIS
201 from string_utils import to_date
206 msg = f'Cannot parse argument as a date: {txt}'
208 raise argparse.ArgumentTypeError(msg)
211 def valid_datetime(txt: str) -> datetime.datetime:
212 """If the string is a valid datetime, return it. Otherwise raise
213 an ArgumentTypeError.
215 >>> valid_datetime('6/5/2021 3:01:02')
216 datetime.datetime(2021, 6, 5, 3, 1, 2)
218 # Again, these types of expressions work fine but are
219 # difficult to test with doctests because the answer is
220 # relative to the time the doctest is executed.
221 >>> valid_datetime('next christmas at 4:15am') # doctest: +ELLIPSIS
224 from string_utils import to_datetime
226 dt = to_datetime(txt)
229 msg = f'Cannot parse argument as datetime: {txt}'
231 raise argparse.ArgumentTypeError(msg)
234 def valid_duration(txt: str) -> datetime.timedelta:
235 """If the string is a valid time duration, return a
236 datetime.timedelta representing the period of time. Otherwise
237 maybe raise an ArgumentTypeError or potentially just treat the
238 time window as zero in length.
240 >>> valid_duration('3m')
241 datetime.timedelta(seconds=180)
243 >>> valid_duration('your mom')
244 datetime.timedelta(0)
247 from datetime_utils import parse_duration
250 secs = parse_duration(txt)
251 except Exception as e:
252 raise argparse.ArgumentTypeError(e)
254 return datetime.timedelta(seconds=secs)
257 if __name__ == '__main__':
260 doctest.ELLIPSIS_MARKER = '-ANYTHING-'