doxygen/xml/classcmd2_1_1_cmd2_test_case.xml


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

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.7.5.1">
  <compounddef id="classcmd2_1_1_cmd2_test_case" kind="class" prot="public">
    <compoundname>cmd2::Cmd2TestCase</compoundname>
      <sectiondef kind="public-static-attrib">
      <memberdef kind="variable" id="classcmd2_1_1_cmd2_test_case_1ae3ce50557636abee00a3941461dd450c" prot="public" static="yes" mutable="no">
        <type></type>
        <definition>cmd2::Cmd2TestCase::CmdApp</definition>
        <argsstring></argsstring>
        <name>CmdApp</name>
        <initializer>None</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1480" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1480" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classcmd2_1_1_cmd2_test_case_1aa85409ff40b934d96ca1b3d3ff9e897d" prot="public" static="yes" mutable="no">
        <type>tuple</type>
        <definition>tuple cmd2::Cmd2TestCase::regexPattern</definition>
        <argsstring></argsstring>
        <name>regexPattern</name>
        <initializer>pyparsing.QuotedString(quoteChar=r&apos;/&apos;, escChar=&apos;\\&apos;, multiline=True, unquoteResults=True)</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1500" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1500" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classcmd2_1_1_cmd2_test_case_1a29b62f02c603b82014102babccd0c40e" prot="public" static="yes" mutable="no">
        <type>tuple</type>
        <definition>tuple cmd2::Cmd2TestCase::notRegexPattern</definition>
        <argsstring></argsstring>
        <name>notRegexPattern</name>
        <initializer>pyparsing.Word(pyparsing.printables)</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1502" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1502" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classcmd2_1_1_cmd2_test_case_1af9574fde56ba05bc1532a6a028fb566d" prot="public" static="yes" mutable="no">
        <type></type>
        <definition>cmd2::Cmd2TestCase::expectationParser</definition>
        <argsstring></argsstring>
        <name>expectationParser</name>
        <initializer><ref refid="classcmd2_1_1_cmd2_test_case_1aa85409ff40b934d96ca1b3d3ff9e897d" kindref="member">regexPattern</ref>|<ref refid="classcmd2_1_1_cmd2_test_case_1a29b62f02c603b82014102babccd0c40e" kindref="member">notRegexPattern</ref></initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1504" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1504" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classcmd2_1_1_cmd2_test_case_1a946827bef7050042cee99d3749c976d0" prot="public" static="yes" mutable="no">
        <type>tuple</type>
        <definition>tuple cmd2::Cmd2TestCase::anyWhitespace</definition>
        <argsstring></argsstring>
        <name>anyWhitespace</name>
        <initializer>re.compile(r&apos;\s&apos;, re.DOTALL | re.MULTILINE)</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1505" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1505" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="classcmd2_1_1_cmd2_test_case_1ad319aa2e1874f60202610e5b8de33dbb" prot="public" static="no" mutable="no">
        <type></type>
        <definition>cmd2::Cmd2TestCase::transcripts</definition>
        <argsstring></argsstring>
        <name>transcripts</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1481" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1481" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classcmd2_1_1_cmd2_test_case_1adeb5a7b735ad3b7f23a3c44d15ad283e" prot="public" static="no" mutable="no">
        <type></type>
        <definition>cmd2::Cmd2TestCase::outputTrap</definition>
        <argsstring></argsstring>
        <name>outputTrap</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1490" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1490" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classcmd2_1_1_cmd2_test_case_1acc7fc3df4fb04682fd1e4b2c4cc4cd3c" prot="public" static="no" mutable="no">
        <type></type>
        <definition>cmd2::Cmd2TestCase::cmdapp</definition>
        <argsstring></argsstring>
        <name>cmdapp</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1490" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1490" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classcmd2_1_1_cmd2_test_case_1ad82fc3489ffaf8ae227e7b122df389e0" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>def</type>
        <definition>def cmd2::Cmd2TestCase::fetchTranscripts</definition>
        <argsstring></argsstring>
        <name>fetchTranscripts</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1481" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1481" bodyend="1489"/>
      </memberdef>
      <memberdef kind="function" id="classcmd2_1_1_cmd2_test_case_1a5892c02ac5ee5a25c47bbfa1c648647b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>def</type>
        <definition>def cmd2::Cmd2TestCase::setUp</definition>
        <argsstring></argsstring>
        <name>setUp</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1490" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1490" bodyend="1494"/>
      </memberdef>
      <memberdef kind="function" id="classcmd2_1_1_cmd2_test_case_1acc8585a2192f48e04a8eafd63348c590" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>def</type>
        <definition>def cmd2::Cmd2TestCase::runTest</definition>
        <argsstring></argsstring>
        <name>runTest</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1495" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1495" bodyend="1499"/>
      </memberdef>
      <memberdef kind="function" id="classcmd2_1_1_cmd2_test_case_1a12a9839011a264bf817e646114523052" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>def</type>
        <definition>def cmd2::Cmd2TestCase::tearDown</definition>
        <argsstring></argsstring>
        <name>tearDown</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1563" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1563" bodyend="1566"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="classcmd2_1_1_cmd2_test_case_1aaad687718f366338a76f83cb6547a258" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>def</type>
        <definition>def cmd2::Cmd2TestCase::_test_transcript</definition>
        <argsstring></argsstring>
        <name>_test_transcript</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1506" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1506" bodyend="1562"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
<para><verbatim>Subclass this, setting CmdApp, to make a unittest.TestCase class
   that will execute the commands in a transcript file and expect the results shown.
   See example.py</verbatim> </para>    </detaileddescription>
    <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1479" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1476" bodyend="1567"/>
    <listofallmembers>
      <member refid="classcmd2_1_1_cmd2_test_case_1aaad687718f366338a76f83cb6547a258" prot="private" virt="non-virtual"><scope>cmd2::Cmd2TestCase</scope><name>_test_transcript</name></member>
      <member refid="classcmd2_1_1_cmd2_test_case_1a946827bef7050042cee99d3749c976d0" prot="public" virt="non-virtual"><scope>cmd2::Cmd2TestCase</scope><name>anyWhitespace</name></member>
      <member refid="classcmd2_1_1_cmd2_test_case_1ae3ce50557636abee00a3941461dd450c" prot="public" virt="non-virtual"><scope>cmd2::Cmd2TestCase</scope><name>CmdApp</name></member>
      <member refid="classcmd2_1_1_cmd2_test_case_1acc7fc3df4fb04682fd1e4b2c4cc4cd3c" prot="public" virt="non-virtual"><scope>cmd2::Cmd2TestCase</scope><name>cmdapp</name></member>
      <member refid="classcmd2_1_1_cmd2_test_case_1af9574fde56ba05bc1532a6a028fb566d" prot="public" virt="non-virtual"><scope>cmd2::Cmd2TestCase</scope><name>expectationParser</name></member>
      <member refid="classcmd2_1_1_cmd2_test_case_1ad82fc3489ffaf8ae227e7b122df389e0" prot="public" virt="non-virtual"><scope>cmd2::Cmd2TestCase</scope><name>fetchTranscripts</name></member>
      <member refid="classcmd2_1_1_cmd2_test_case_1a29b62f02c603b82014102babccd0c40e" prot="public" virt="non-virtual"><scope>cmd2::Cmd2TestCase</scope><name>notRegexPattern</name></member>
      <member refid="classcmd2_1_1_cmd2_test_case_1adeb5a7b735ad3b7f23a3c44d15ad283e" prot="public" virt="non-virtual"><scope>cmd2::Cmd2TestCase</scope><name>outputTrap</name></member>
      <member refid="classcmd2_1_1_cmd2_test_case_1aa85409ff40b934d96ca1b3d3ff9e897d" prot="public" virt="non-virtual"><scope>cmd2::Cmd2TestCase</scope><name>regexPattern</name></member>
      <member refid="classcmd2_1_1_cmd2_test_case_1acc8585a2192f48e04a8eafd63348c590" prot="public" virt="non-virtual"><scope>cmd2::Cmd2TestCase</scope><name>runTest</name></member>
      <member refid="classcmd2_1_1_cmd2_test_case_1a5892c02ac5ee5a25c47bbfa1c648647b" prot="public" virt="non-virtual"><scope>cmd2::Cmd2TestCase</scope><name>setUp</name></member>
      <member refid="classcmd2_1_1_cmd2_test_case_1a12a9839011a264bf817e646114523052" prot="public" virt="non-virtual"><scope>cmd2::Cmd2TestCase</scope><name>tearDown</name></member>
      <member refid="classcmd2_1_1_cmd2_test_case_1ad319aa2e1874f60202610e5b8de33dbb" prot="public" virt="non-virtual"><scope>cmd2::Cmd2TestCase</scope><name>transcripts</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>