-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathtest_utils.html
299 lines (299 loc) · 22.7 KB
/
test_utils.html
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
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>dalpy.test_utils API documentation</title>
<meta name="description" content="This module provides utilities related to unit testing …" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>dalpy.test_utils</code></h1>
</header>
<section id="section-intro">
<p>This module provides utilities related to unit testing.</p>
<p>This module contains the <code><a title="dalpy.test_utils.build_and_run_watched_suite" href="#dalpy.test_utils.build_and_run_watched_suite">build_and_run_watched_suite()</a></code>, <code><a title="dalpy.test_utils.assert_array_equals" href="#dalpy.test_utils.assert_array_equals">assert_array_equals()</a></code>, <code><a title="dalpy.test_utils.behavior_test" href="#dalpy.test_utils.behavior_test">behavior_test()</a></code>, <code><a title="dalpy.test_utils.generic_test" href="#dalpy.test_utils.generic_test">generic_test()</a></code>,
<code><a title="dalpy.test_utils.dalpy_equals" href="#dalpy.test_utils.dalpy_equals">dalpy_equals()</a></code> and the <code><a title="dalpy.test_utils.dalpy_to_string" href="#dalpy.test_utils.dalpy_to_string">dalpy_to_string()</a></code> functions, as well as <code><a title="dalpy.test_utils.UnexpectedReturnWarning" href="#dalpy.test_utils.UnexpectedReturnWarning">UnexpectedReturnWarning</a></code>.</p>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="dalpy.test_utils.assert_array_equals"><code class="name flex">
<span>def <span class="ident">assert_array_equals</span></span>(<span>expected, actual, msg=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Asserts that two <code><a title="dalpy.arrays.Array" href="arrays.html#dalpy.arrays.Array">Array</a></code>s are equal, displaying a custom message if specified.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>expected</code></strong></dt>
<dd>The expected <code><a title="dalpy.arrays.Array" href="arrays.html#dalpy.arrays.Array">Array</a></code>.</dd>
<dt><strong><code>actual</code></strong></dt>
<dd>The actual <code><a title="dalpy.arrays.Array" href="arrays.html#dalpy.arrays.Array">Array</a></code>.</dd>
<dt><strong><code>msg</code></strong></dt>
<dd>The message to display on <code>AssertionError</code>, if not specified, then a default message is displayed.</dd>
</dl>
<h2 id="raises">Raises</h2>
<dl>
<dt><code>AssertionError</code></dt>
<dd>If <code>expected</code> != <code>actual</code>.</dd>
</dl></div>
</dd>
<dt id="dalpy.test_utils.behavior_test"><code class="name flex">
<span>def <span class="ident">behavior_test</span></span>(<span>behavior, objects)</span>
</code></dt>
<dd>
<div class="desc"><p>Test the behavior of an object.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>behavior</code></strong></dt>
<dd>a <code>list</code> of <code>tuple</code>s of the form <code>(RESULT, METHOD, PARAMETERS)</code>.</dd>
<dt><strong><code>objects</code></strong></dt>
<dd>a <code>list</code> of objects who's parameters are being called.</dd>
</dl>
<h2 id="raises">Raises</h2>
<dl>
<dt><code>AssertionError</code></dt>
<dd>If <code>METHOD(PARAMETERS) != RESULT</code>.</dd>
</dl>
<p>For each tuple in behavior this test asserts that <code>METHOD(PARAMETERS) = RESULT</code>.</p>
<p>In each <code>tuple</code> <code>METHOD</code> should an uncalled <code>callable</code>, for example:</p>
<pre><code class="language-python-repl">>>> stack = Stack()
>>> uncalled_callable = stack.pop
</code></pre>
<p>Notes:
- If <code>METHOD</code> requires multiple parameters, then <code>PARAMETERS</code> can be passed as a <code>tuple</code>.
- If <code>METHOD</code> has no required return, then <code>RESULT</code> can be omitted in favor of <code>(METHOD, PARAMETERS)</code>.
- If <code>METHOD</code> has no parameters, then <code>PARAMETERS</code> can be omitted in favor of <code>(RESULT, METHOD)</code>.</p>
<p>Example:</p>
<pre><code class="language-python-repl">>>> stack = Stack()
>>> behavior = [ (stack.push, 1), (1, stack.pop) ]
</code></pre>
<p>The objects parameter is the object who's behavior is being tested, which will be used for the test log.
If multiple objects are being tested, pass a tuple of objects.</p></div>
</dd>
<dt id="dalpy.test_utils.build_and_run_watched_suite"><code class="name flex">
<span>def <span class="ident">build_and_run_watched_suite</span></span>(<span>cases, timeout=None, show_tb=False, grading_file=None, warning_filter='once')</span>
</code></dt>
<dd>
<div class="desc"><p>Runs a set of test cases, ensuring that they do not run longer than <code>timeout</code> seconds. Optionally,
writes comma-separated test results to a file.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>cases</code></strong></dt>
<dd>A list of TestCases to be run.</dd>
<dt><strong><code>timeout</code></strong></dt>
<dd>Number of seconds to allow each test case to run for.</dd>
<dt><strong><code>show_tb</code></strong></dt>
<dd>Boolean toggle for stack trace.</dd>
<dt><strong><code>grading_file</code></strong></dt>
<dd>Output file path to store comma-separated test results.</dd>
<dt><strong><code>warning_filter</code></strong></dt>
<dd>A <code>warnings.simplefilter</code> action. Default value ensures that warnings are only displayed once.
Choose <code>"ignore"</code> to suppress warnings.</dd>
</dl>
<p>If <code>grading_file</code> is not specified, the test logs will be dumped to console.</p></div>
</dd>
<dt id="dalpy.test_utils.dalpy_equals"><code class="name flex">
<span>def <span class="ident">dalpy_equals</span></span>(<span>first, second)</span>
</code></dt>
<dd>
<div class="desc"><p>Tests equality between two objects. If the objects are from the DALPy, they are compared using their own
custom comparator.</p>
<p><code><a title="dalpy.test_utils.dalpy_equals" href="#dalpy.test_utils.dalpy_equals">dalpy_equals()</a></code> supports equality for the following objects: <code><a title="dalpy.arrays.Array" href="arrays.html#dalpy.arrays.Array">Array</a></code>, <code><a title="dalpy.arrays.Array2D" href="arrays.html#dalpy.arrays.Array2D">Array2D</a></code>,
<code><a title="dalpy.queues.Queue" href="queues.html#dalpy.queues.Queue">Queue</a></code>, <code><a title="dalpy.stacks.Stack" href="stacks.html#dalpy.stacks.Stack">Stack</a></code>, <code><a title="dalpy.sets.Set" href="sets.html#dalpy.sets.Set">Set</a></code>,
<code><a title="dalpy.linked_lists.SinglyLinkedListNode" href="linked_lists.html#dalpy.linked_lists.SinglyLinkedListNode">SinglyLinkedListNode</a></code>. For <code><a title="dalpy.linked_lists.SinglyLinkedListNode" href="linked_lists.html#dalpy.linked_lists.SinglyLinkedListNode">SinglyLinkedListNode</a></code>, checks that all
nodes next of the passed <code><a title="dalpy.linked_lists.SinglyLinkedListNode" href="linked_lists.html#dalpy.linked_lists.SinglyLinkedListNode">SinglyLinkedListNode</a></code>s are the same. For instances of <code>float</code>s,
<code>math.isclose</code> is used for comparison.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>first</code></strong></dt>
<dd>The first element to be tested.</dd>
<dt><strong><code>second</code></strong></dt>
<dd>The second element to be tested</dd>
</dl>
<h2 id="returns">Returns</h2>
<p><code>True</code> if <code>first = second</code> otherwise <code>False</code>.</p></div>
</dd>
<dt id="dalpy.test_utils.dalpy_to_string"><code class="name flex">
<span>def <span class="ident">dalpy_to_string</span></span>(<span>obj)</span>
</code></dt>
<dd>
<div class="desc"><p>Generates a string representation of a DALPy object if passed object is from DALPy, otherwise calls
native str method.</p>
<p>dalpy_to_string supports the following objects: <code><a title="dalpy.arrays.Array" href="arrays.html#dalpy.arrays.Array">Array</a></code>, <code><a title="dalpy.arrays.Array2D" href="arrays.html#dalpy.arrays.Array2D">Array2D</a></code>,
<code><a title="dalpy.queues.Queue" href="queues.html#dalpy.queues.Queue">Queue</a></code>, <code><a title="dalpy.stacks.Stack" href="stacks.html#dalpy.stacks.Stack">Stack</a></code>, <code><a title="dalpy.sets.Set" href="sets.html#dalpy.sets.Set">Set</a></code>,
<code><a title="dalpy.linked_lists.SinglyLinkedListNode" href="linked_lists.html#dalpy.linked_lists.SinglyLinkedListNode">SinglyLinkedListNode</a></code>, <code><a title="dalpy.trees.BinaryTreeNode" href="trees.html#dalpy.trees.BinaryTreeNode">BinaryTreeNode</a></code>, <code><a title="dalpy.trees.NaryTreeNode" href="trees.html#dalpy.trees.NaryTreeNode">NaryTreeNode</a></code>,
<code><a title="dalpy.graphs.Vertex" href="graphs.html#dalpy.graphs.Vertex">Vertex</a></code>, and <code><a title="dalpy.graphs.Graph" href="graphs.html#dalpy.graphs.Graph">Graph</a></code>.</p>
<p>Calling dalpy_to_string on <code><a title="dalpy.trees.BinaryTreeNode" href="trees.html#dalpy.trees.BinaryTreeNode">BinaryTreeNode</a></code> or <code><a title="dalpy.trees.NaryTreeNode" href="trees.html#dalpy.trees.NaryTreeNode">NaryTreeNode</a></code> displays the entire
tree rooted at that node prepended with <code>"BinaryTree"</code> and <code>"NaryTree"</code> respectively.
This is done to clarify the nodes themselves are not holding the data listed after it.</p>
<h2 id="returns">Returns</h2>
<p>string representation of <code>obj</code>.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>obj</code></strong></dt>
<dd>The object to convert to string</dd>
</dl></div>
</dd>
<dt id="dalpy.test_utils.generic_test"><code class="name flex">
<span>def <span class="ident">generic_test</span></span>(<span>params, expected, method, custom_comparator=None, in_place=False, enforce_no_mod=False, params_to_string=None, expected_to_string=None, output_to_string=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Test the output of a function.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>params</code></strong></dt>
<dd>Parameters to be passed into the function being tested. This argument can either be a single parameter,
or a list of parameters.</dd>
<dt><strong><code>expected</code></strong></dt>
<dd>Expected return value of tested function with parameters specified by params. If <code>expected</code> is an
<code>Exception</code>, the test will assert that the function tested on the given parameters throws the expected
<code>Exception</code>.</dd>
<dt><strong><code>method</code></strong></dt>
<dd>Function being tested. Must be a <code>callable</code>.</dd>
<dt><strong><code>custom_comparator</code></strong></dt>
<dd>Function for determining if method output equals expected. Must be a <code>callable</code>. Default
<code>None</code> which means that <code><a title="dalpy.test_utils.dalpy_equals" href="#dalpy.test_utils.dalpy_equals">dalpy_equals()</a></code> will be used.</dd>
<dt><strong><code>in_place</code></strong></dt>
<dd><code>True</code> if <code>expected</code> should be compared against <code>params</code>. By default this is <code>False</code>.</dd>
<dt><strong><code>enforce_no_mod</code></strong></dt>
<dd><code>bool</code> or a <code>list</code> of <code>bool</code> indicating which args should not be modified. Default <code>False</code>
allows modification of all args.</dd>
<dt><strong><code>params_to_string</code></strong></dt>
<dd>Function for displaying the parameters. Must be a <code>callable</code>. Default <code>None</code> which means that
<code><a title="dalpy.test_utils.dalpy_to_string" href="#dalpy.test_utils.dalpy_to_string">dalpy_to_string()</a></code> will be used instead.</dd>
<dt><strong><code>expected_to_string</code></strong></dt>
<dd>Function for displaying the expected output. Must be a <code>callable</code>. Default <code>None</code> which
means that <code><a title="dalpy.test_utils.dalpy_to_string" href="#dalpy.test_utils.dalpy_to_string">dalpy_to_string()</a></code> will be used instead.</dd>
<dt><strong><code>output_to_string</code></strong></dt>
<dd>Function for displaying the actual output. Must be a <code>callable</code>. Default <code>None</code> which means
that <code><a title="dalpy.test_utils.dalpy_to_string" href="#dalpy.test_utils.dalpy_to_string">dalpy_to_string()</a></code> will be used instead.</dd>
</dl>
<h2 id="raises">Raises</h2>
<dl>
<dt><code>AssertionError</code></dt>
<dd>If the test fails.</dd>
<dt><code><a title="dalpy.test_utils.UnexpectedReturnWarning" href="#dalpy.test_utils.UnexpectedReturnWarning">UnexpectedReturnWarning</a></code></dt>
<dd>If <code>in_place</code> is set to <code>True</code> but <code>method</code> still returns a value.</dd>
</dl></div>
</dd>
<dt id="dalpy.test_utils.run_generic_test"><code class="name flex">
<span>def <span class="ident">run_generic_test</span></span>(<span>params, expected, method, custom_comparator=None, in_place=False, enforce_no_mod=False, init_params=None, init_expected=None, params_to_string=None, expected_to_string=None, output_to_string=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Test the output of a function.</p>
<h2 id="warnings">Warnings</h2>
<p>Deprecated in 1.1.0, to be removed. Use the generic_test function instead.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>params</code></strong></dt>
<dd>Parameters to be passed into the function being tested. This argument can either be a single parameter,
or a list of parameters.</dd>
<dt><strong><code>expected</code></strong></dt>
<dd>Expected return value of tested function with parameters specified by params.</dd>
<dt><strong><code>method</code></strong></dt>
<dd>Function being tested. Must be a <code>callable</code>.</dd>
<dt><strong><code>custom_comparator</code></strong></dt>
<dd>Function for determining if method output equals expected. Must be a <code>callable</code>.</dd>
<dt><strong><code>in_place</code></strong></dt>
<dd><code>True</code> if <code>expected</code> should be compared against <code>params</code>.</dd>
<dt><strong><code>enforce_no_mod</code></strong></dt>
<dd><code>bool</code> or a <code>list</code> of <code>bool</code> indicating which args should not be modified. Default <code>False</code>
allows modification of all args.</dd>
<dt><strong><code>init_params</code></strong></dt>
<dd>Function for initializing parameters. Must be a <code>callable</code>.</dd>
<dt><strong><code>init_expected</code></strong></dt>
<dd>Function for initializing expected output. Must be a <code>callable</code>.</dd>
<dt><strong><code>params_to_string</code></strong></dt>
<dd>Function for displaying the parameters. Must be a <code>callable</code>.</dd>
<dt><strong><code>expected_to_string</code></strong></dt>
<dd>Function for displaying the expected output. Must be a <code>callable</code>.</dd>
<dt><strong><code>output_to_string</code></strong></dt>
<dd>Function for displaying the actual output. Must be a <code>callable</code>.</dd>
</dl>
<h2 id="raises">Raises</h2>
<dl>
<dt><code>AssertionError</code></dt>
<dd>If the test fails.</dd>
<dt><code><a title="dalpy.test_utils.UnexpectedReturnWarning" href="#dalpy.test_utils.UnexpectedReturnWarning">UnexpectedReturnWarning</a></code></dt>
<dd>If <code>in_place</code> is set to <code>True</code> but <code>method</code> still returns a value.</dd>
<dt><code>DeprecationWarning</code></dt>
<dd>If used in version >= 1.1.0.</dd>
</dl>
<p>If <code>expected</code> is an <code>Exception</code>, the test will assert that the function tested on the given parameters throws the
expected <code>Exception</code>. If no custom <code>to_string</code>s are specified, the <code><a title="dalpy.test_utils.dalpy_to_string" href="#dalpy.test_utils.dalpy_to_string">dalpy_to_string()</a></code> method will be used for
displaying parameters, input and output.</p></div>
</dd>
</dl>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="dalpy.test_utils.UnexpectedReturnWarning"><code class="flex name class">
<span>class <span class="ident">UnexpectedReturnWarning</span></span>
<span>(</span><span>*args, **kwargs)</span>
</code></dt>
<dd>
<div class="desc"><p>A <code>Warning</code> subclass for instances where functions are expected to modify their arguments but return values instead.</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li>builtins.Warning</li>
<li>builtins.Exception</li>
<li>builtins.BaseException</li>
</ul>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="dalpy" href="index.html">dalpy</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="dalpy.test_utils.assert_array_equals" href="#dalpy.test_utils.assert_array_equals">assert_array_equals</a></code></li>
<li><code><a title="dalpy.test_utils.behavior_test" href="#dalpy.test_utils.behavior_test">behavior_test</a></code></li>
<li><code><a title="dalpy.test_utils.build_and_run_watched_suite" href="#dalpy.test_utils.build_and_run_watched_suite">build_and_run_watched_suite</a></code></li>
<li><code><a title="dalpy.test_utils.dalpy_equals" href="#dalpy.test_utils.dalpy_equals">dalpy_equals</a></code></li>
<li><code><a title="dalpy.test_utils.dalpy_to_string" href="#dalpy.test_utils.dalpy_to_string">dalpy_to_string</a></code></li>
<li><code><a title="dalpy.test_utils.generic_test" href="#dalpy.test_utils.generic_test">generic_test</a></code></li>
<li><code><a title="dalpy.test_utils.run_generic_test" href="#dalpy.test_utils.run_generic_test">run_generic_test</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="dalpy.test_utils.UnexpectedReturnWarning" href="#dalpy.test_utils.UnexpectedReturnWarning">UnexpectedReturnWarning</a></code></h4>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>