| 1 |
# test_getopt.py |
| 2 |
# David Goodger <[email protected]> 2000-08-19 |
| 3 |
|
| 4 |
import doctest |
| 5 |
import getopt |
| 6 |
import sys |
| 7 |
import unittest |
| 8 |
from test.support.i18n_helper import TestTranslationsBase, update_translation_snapshots |
| 9 |
from test.support.os_helper import EnvironmentVarGuard |
| 10 |
|
| 11 |
sentinel = object() |
| 12 |
|
| 13 |
class GetoptTests(unittest.TestCase): |
| 14 |
def setUp(self): |
| 15 |
self.env = self.enterContext(EnvironmentVarGuard()) |
| 16 |
del self.env["POSIXLY_CORRECT"] |
| 17 |
|
| 18 |
def assertError(self, *args, **kwargs): |
| 19 |
self.assertRaises(getopt.GetoptError, *args, **kwargs) |
| 20 |
|
| 21 |
def test_short_has_arg(self): |
| 22 |
self.assertIs(getopt.short_has_arg('a', 'a:'), True) |
| 23 |
self.assertIs(getopt.short_has_arg('a', 'a'), False) |
| 24 |
self.assertEqual(getopt.short_has_arg('a', 'a::'), '?') |
| 25 |
self.assertError(getopt.short_has_arg, 'a', 'b') |
| 26 |
|
| 27 |
def test_long_has_args(self): |
| 28 |
has_arg, option = getopt.long_has_args('abc', ['abc=']) |
| 29 |
self.assertIs(has_arg, True) |
| 30 |
self.assertEqual(option, 'abc') |
| 31 |
|
| 32 |
has_arg, option = getopt.long_has_args('abc', ['abc']) |
| 33 |
self.assertIs(has_arg, False) |
| 34 |
self.assertEqual(option, 'abc') |
| 35 |
|
| 36 |
has_arg, option = getopt.long_has_args('abc', ['abc=?']) |
| 37 |
self.assertEqual(has_arg, '?') |
| 38 |
self.assertEqual(option, 'abc') |
| 39 |
|
| 40 |
has_arg, option = getopt.long_has_args('abc', ['abcd=']) |
| 41 |
self.assertIs(has_arg, True) |
| 42 |
self.assertEqual(option, 'abcd') |
| 43 |
|
| 44 |
has_arg, option = getopt.long_has_args('abc', ['abcd']) |
| 45 |
self.assertIs(has_arg, False) |
| 46 |
self.assertEqual(option, 'abcd') |
| 47 |
|
| 48 |
has_arg, option = getopt.long_has_args('abc', ['abcd=?']) |
| 49 |
self.assertEqual(has_arg, '?') |
| 50 |
self.assertEqual(option, 'abcd') |
| 51 |
|
| 52 |
self.assertError(getopt.long_has_args, 'abc', ['def']) |
| 53 |
self.assertError(getopt.long_has_args, 'abc', []) |
| 54 |
self.assertError(getopt.long_has_args, 'abc', ['abcd','abcde']) |
| 55 |
|
| 56 |
def test_do_shorts(self): |
| 57 |
opts, args = getopt.do_shorts([], 'a', 'a', []) |
| 58 |
self.assertEqual(opts, [('-a', '')]) |
| 59 |
self.assertEqual(args, []) |
| 60 |
|
| 61 |
opts, args = getopt.do_shorts([], 'a1', 'a:', []) |
| 62 |
self.assertEqual(opts, [('-a', '1')]) |
| 63 |
self.assertEqual(args, []) |
| 64 |
|
| 65 |
opts, args = getopt.do_shorts([], 'a=1', 'a:', []) |
| 66 |
self.assertEqual(opts, [('-a', '=1')]) |
| 67 |
self.assertEqual(args, []) |
| 68 |
|
| 69 |
opts, args = getopt.do_shorts([], 'a', 'a:', ['1']) |
| 70 |
self.assertEqual(opts, [('-a', '1')]) |
| 71 |
self.assertEqual(args, []) |
| 72 |
|
| 73 |
opts, args = getopt.do_shorts([], 'a', 'a:', ['1', '2']) |
| 74 |
self.assertEqual(opts, [('-a', '1')]) |
| 75 |
self.assertEqual(args, ['2']) |
| 76 |
|
| 77 |
opts, args = getopt.do_shorts([], 'a', 'a::', ['1']) |
| 78 |
self.assertEqual(opts, [('-a', '')]) |
| 79 |
self.assertEqual(args, ['1']) |
| 80 |
|
| 81 |
opts, args = getopt.do_shorts([], 'a1', 'a::', []) |
| 82 |
self.assertEqual(opts, [('-a', '1')]) |
| 83 |
self.assertEqual(args, []) |
| 84 |
|
| 85 |
self.assertError(getopt.do_shorts, [], 'a1', 'a', []) |
| 86 |
self.assertError(getopt.do_shorts, [], 'a', 'a:', []) |
| 87 |
|
| 88 |
def test_do_longs(self): |
| 89 |
opts, args = getopt.do_longs([], 'abc', ['abc'], []) |
| 90 |
self.assertEqual(opts, [('--abc', '')]) |
| 91 |
self.assertEqual(args, []) |
| 92 |
|
| 93 |
opts, args = getopt.do_longs([], 'abc=1', ['abc='], []) |
| 94 |
self.assertEqual(opts, [('--abc', '1')]) |
| 95 |
self.assertEqual(args, []) |
| 96 |
|
| 97 |
opts, args = getopt.do_longs([], 'abc=1', ['abcd='], []) |
| 98 |
self.assertEqual(opts, [('--abcd', '1')]) |
| 99 |
self.assertEqual(args, []) |
| 100 |
|
| 101 |
opts, args = getopt.do_longs([], 'abc', ['abc=?'], ['1']) |
| 102 |
self.assertEqual(opts, [('--abc', '')]) |
| 103 |
self.assertEqual(args, ['1']) |
| 104 |
|
| 105 |
opts, args = getopt.do_longs([], 'abc', ['abcd=?'], ['1']) |
| 106 |
self.assertEqual(opts, [('--abcd', '')]) |
| 107 |
self.assertEqual(args, ['1']) |
| 108 |
|
| 109 |
opts, args = getopt.do_longs([], 'abc=1', ['abc=?'], []) |
| 110 |
self.assertEqual(opts, [('--abc', '1')]) |
| 111 |
self.assertEqual(args, []) |
| 112 |
|
| 113 |
opts, args = getopt.do_longs([], 'abc=1', ['abcd=?'], []) |
| 114 |
self.assertEqual(opts, [('--abcd', '1')]) |
| 115 |
self.assertEqual(args, []) |
| 116 |
|
| 117 |
opts, args = getopt.do_longs([], 'abc', ['ab', 'abc', 'abcd'], []) |
| 118 |
self.assertEqual(opts, [('--abc', '')]) |
| 119 |
self.assertEqual(args, []) |
| 120 |
|
| 121 |
# Much like the preceding, except with a non-alpha character ("-") in |
| 122 |
# option name that precedes "="; failed in |
| 123 |
# https://bugs.python.org/issue126863 |
| 124 |
opts, args = getopt.do_longs([], 'foo=42', ['foo-bar', 'foo=',], []) |
| 125 |
self.assertEqual(opts, [('--foo', '42')]) |
| 126 |
self.assertEqual(args, []) |
| 127 |
|
| 128 |
self.assertError(getopt.do_longs, [], 'abc=1', ['abc'], []) |
| 129 |
self.assertError(getopt.do_longs, [], 'abc', ['abc='], []) |
| 130 |
|
| 131 |
def test_getopt(self): |
| 132 |
# note: the empty string between '-a' and '--beta' is significant: |
| 133 |
# it simulates an empty string option argument ('-a ""') on the |
| 134 |
# command line. |
| 135 |
cmdline = ['-a1', '-b', '--alpha=2', '--beta', '-a', '3', '-a', |
| 136 |
'', '--beta', 'arg1', 'arg2'] |
| 137 |
|
| 138 |
opts, args = getopt.getopt(cmdline, 'a:b', ['alpha=', 'beta']) |
| 139 |
self.assertEqual(opts, [('-a', '1'), ('-b', ''), |
| 140 |
('--alpha', '2'), ('--beta', ''), |
| 141 |
('-a', '3'), ('-a', ''), ('--beta', '')]) |
| 142 |
# Note ambiguity of ('-b', '') and ('-a', '') above. This must be |
| 143 |
# accounted for in the code that calls getopt(). |
| 144 |
self.assertEqual(args, ['arg1', 'arg2']) |
| 145 |
|
| 146 |
cmdline = ['-a1', '--alpha=2', '--alpha=', '-a', '--alpha', 'arg1', 'arg2'] |
| 147 |
opts, args = getopt.getopt(cmdline, 'a::', ['alpha=?']) |
| 148 |
self.assertEqual(opts, [('-a', '1'), ('--alpha', '2'), ('--alpha', ''), |
| 149 |
('-a', ''), ('--alpha', '')]) |
| 150 |
self.assertEqual(args, ['arg1', 'arg2']) |
| 151 |
|
| 152 |
self.assertError(getopt.getopt, cmdline, 'a:b', ['alpha', 'beta']) |
| 153 |
|
| 154 |
def test_gnu_getopt(self): |
| 155 |
# Test handling of GNU style scanning mode. |
| 156 |
cmdline = ['-a', 'arg1', '-b', '1', '--alpha', '--beta=2', '--beta', |
| 157 |
'3', 'arg2'] |
| 158 |
|
| 159 |
# GNU style |
| 160 |
opts, args = getopt.gnu_getopt(cmdline, 'ab:', ['alpha', 'beta=']) |
| 161 |
self.assertEqual(args, ['arg1', 'arg2']) |
| 162 |
self.assertEqual(opts, [('-a', ''), ('-b', '1'), ('--alpha', ''), |
| 163 |
('--beta', '2'), ('--beta', '3')]) |
| 164 |
|
| 165 |
opts, args = getopt.gnu_getopt(cmdline, 'ab::', ['alpha', 'beta=?']) |
| 166 |
self.assertEqual(args, ['arg1', '1', '3', 'arg2']) |
| 167 |
self.assertEqual(opts, [('-a', ''), ('-b', ''), ('--alpha', ''), |
| 168 |
('--beta', '2'), ('--beta', '')]) |
| 169 |
|
| 170 |
# recognize "-" as an argument |
| 171 |
opts, args = getopt.gnu_getopt(['-a', '-', '-b', '-'], 'ab:', []) |
| 172 |
self.assertEqual(args, ['-']) |
| 173 |
self.assertEqual(opts, [('-a', ''), ('-b', '-')]) |
| 174 |
|
| 175 |
# Return positional arguments intermixed with options. |
| 176 |
opts, args = getopt.gnu_getopt(cmdline, '-ab:', ['alpha', 'beta=']) |
| 177 |
self.assertEqual(args, ['arg2']) |
| 178 |
self.assertEqual(opts, [('-a', ''), (None, ['arg1']), ('-b', '1'), ('--alpha', ''), |
| 179 |
('--beta', '2'), ('--beta', '3')]) |
| 180 |
|
| 181 |
# Posix style via + |
| 182 |
opts, args = getopt.gnu_getopt(cmdline, '+ab:', ['alpha', 'beta=']) |
| 183 |
self.assertEqual(opts, [('-a', '')]) |
| 184 |
self.assertEqual(args, ['arg1', '-b', '1', '--alpha', '--beta=2', |
| 185 |
'--beta', '3', 'arg2']) |
| 186 |
|
| 187 |
# Posix style via POSIXLY_CORRECT |
| 188 |
self.env["POSIXLY_CORRECT"] = "1" |
| 189 |
opts, args = getopt.gnu_getopt(cmdline, 'ab:', ['alpha', 'beta=']) |
| 190 |
self.assertEqual(opts, [('-a', '')]) |
| 191 |
self.assertEqual(args, ['arg1', '-b', '1', '--alpha', '--beta=2', |
| 192 |
'--beta', '3', 'arg2']) |
| 193 |
|
| 194 |
def test_issue4629(self): |
| 195 |
longopts, shortopts = getopt.getopt(['--help='], '', ['help=']) |
| 196 |
self.assertEqual(longopts, [('--help', '')]) |
| 197 |
longopts, shortopts = getopt.getopt(['--help=x'], '', ['help=']) |
| 198 |
self.assertEqual(longopts, [('--help', 'x')]) |
| 199 |
self.assertRaises(getopt.GetoptError, getopt.getopt, ['--help='], '', ['help']) |
| 200 |
|
| 201 |
def test_libref_examples(): |
| 202 |
""" |
| 203 |
Examples from the Library Reference: Doc/lib/libgetopt.tex |
| 204 |
|
| 205 |
An example using only Unix style options: |
| 206 |
|
| 207 |
|
| 208 |
>>> import getopt |
| 209 |
>>> args = '-a -b -cfoo -d bar a1 a2'.split() |
| 210 |
>>> args |
| 211 |
['-a', '-b', '-cfoo', '-d', 'bar', 'a1', 'a2'] |
| 212 |
>>> optlist, args = getopt.getopt(args, 'abc:d:') |
| 213 |
>>> optlist |
| 214 |
[('-a', ''), ('-b', ''), ('-c', 'foo'), ('-d', 'bar')] |
| 215 |
>>> args |
| 216 |
['a1', 'a2'] |
| 217 |
|
| 218 |
Using long option names is equally easy: |
| 219 |
|
| 220 |
|
| 221 |
>>> s = '--condition=foo --testing --output-file abc.def -x a1 a2' |
| 222 |
>>> args = s.split() |
| 223 |
>>> args |
| 224 |
['--condition=foo', '--testing', '--output-file', 'abc.def', '-x', 'a1', 'a2'] |
| 225 |
>>> optlist, args = getopt.getopt(args, 'x', [ |
| 226 |
... 'condition=', 'output-file=', 'testing']) |
| 227 |
>>> optlist |
| 228 |
[('--condition', 'foo'), ('--testing', ''), ('--output-file', 'abc.def'), ('-x', '')] |
| 229 |
>>> args |
| 230 |
['a1', 'a2'] |
| 231 |
""" |
| 232 |
|
| 233 |
|
| 234 |
class TestTranslations(TestTranslationsBase): |
| 235 |
def test_translations(self): |
| 236 |
self.assertMsgidsEqual(getopt) |
| 237 |
|
| 238 |
|
| 239 |
def load_tests(loader, tests, pattern): |
| 240 |
tests.addTest(doctest.DocTestSuite()) |
| 241 |
return tests |
| 242 |
|
| 243 |
|
| 244 |
if __name__ == '__main__': |
| 245 |
# To regenerate translation snapshots |
| 246 |
if len(sys.argv) > 1 and sys.argv[1] == '--snapshot-update': |
| 247 |
update_translation_snapshots(getopt) |
| 248 |
sys.exit(0) |
| 249 |
unittest.main() |