forked from google/python-fire
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhelputils_test.py
More file actions
131 lines (113 loc) · 4.82 KB
/
helputils_test.py
File metadata and controls
131 lines (113 loc) · 4.82 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
# Copyright (C) 2018 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Tests for the helputils module."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
import os
from fire import helputils
from fire import test_components as tc
from fire import testutils
import six
class HelpUtilsTest(testutils.BaseTestCase):
def testHelpStringClass(self):
helpstring = helputils.HelpString(tc.NoDefaults)
self.assertIn('Type: type', helpstring)
self.assertIn("String form: <class 'fire.test_components.NoDefaults'>",
helpstring)
self.assertIn('test_components.py', helpstring)
self.assertIn('Line: ', helpstring)
self.assertNotIn('Usage', helpstring)
def testHelpStringObject(self):
obj = tc.NoDefaults()
helpstring = helputils.HelpString(obj)
self.assertIn('Type: NoDefaults', helpstring)
self.assertIn('String form: <fire.test_components.NoDefaults object at ',
helpstring)
# TODO(dbieber): We comment this out since it only works with IPython:
# self.assertIn('test_components.py', helpstring)
self.assertIn('Usage: double\n'
' triple', helpstring)
def testHelpStringFunction(self):
obj = tc.NoDefaults()
helpstring = helputils.HelpString(obj.double)
if six.PY2:
self.assertIn('Type: instancemethod\n', helpstring)
else:
self.assertIn('Type: method\n', helpstring)
self.assertIn(
'String form: <bound method NoDefaults.double of '
'<fire.test_components.NoDefaults object',
helpstring)
self.assertIn('test_components.py', helpstring)
self.assertIn('Line: ', helpstring)
self.assertIn('Usage: COUNT\n'
' --count COUNT', helpstring)
def testHelpStringFunctionWithDefaults(self):
obj = tc.WithDefaults()
helpstring = helputils.HelpString(obj.triple)
if six.PY2:
self.assertIn('Type: instancemethod\n', helpstring)
else:
self.assertIn('Type: method\n', helpstring)
self.assertIn(
'String form: <bound method WithDefaults.triple of '
'<fire.test_components.WithDefaults object',
helpstring)
self.assertIn('test_components.py', helpstring)
self.assertIn('Line: ', helpstring)
self.assertIn('Usage: [COUNT]\n'
' [--count COUNT]', helpstring)
def testHelpStringBuiltin(self):
helpstring = helputils.HelpString('test'.upper)
self.assertIn('Type: builtin_function_or_method', helpstring)
self.assertIn('String form: <built-in method upper of', helpstring)
def testHelpStringIntType(self):
helpstring = helputils.HelpString(int)
self.assertIn('Type: type', helpstring)
if six.PY2:
self.assertIn("String form: <type 'int'>", helpstring)
else:
self.assertIn("String form: <class 'int'>", helpstring)
self.assertNotIn('Usage', helpstring)
def testHelpStringEmptyList(self):
helpstring = helputils.HelpString([])
self.assertIn('Type: list', helpstring)
self.assertIn('String form: []', helpstring)
self.assertIn('Length: 0', helpstring)
def testHelpStringShortList(self):
helpstring = helputils.HelpString([10])
self.assertIn('Type: list', helpstring)
self.assertIn('String form: [10]', helpstring)
self.assertIn('Length: 1', helpstring)
self.assertIn('Usage: [0]', helpstring) # [] denotes optional.
def testHelpStringInt(self):
helpstring = helputils.HelpString(7)
self.assertIn('Type: int', helpstring)
self.assertIn('String form: 7', helpstring)
self.assertIn('Usage: bit-length\n'
' conjugate\n'
' denominator\n', helpstring)
def testHelpClassNoInit(self):
helpstring = helputils.HelpString(tc.OldStyleEmpty)
if six.PY2:
self.assertIn('Type: classobj\n', helpstring)
else:
self.assertIn('Type: type\n', helpstring)
self.assertIn('String form: ', helpstring)
self.assertIn('fire.test_components.OldStyleEmpty', helpstring)
self.assertIn(os.path.join('fire', 'test_components.py'), helpstring)
self.assertIn('Line: ', helpstring)
if __name__ == '__main__':
testutils.main()