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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Sentinel — Mock v0.6.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.6.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Mock v0.6.0 documentation" href="index.html" />
<link rel="next" title="Getting Started with Mock" href="getting-started.html" />
<link rel="prev" title="Patch Decorators" href="patch.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="getting-started.html" title="Getting Started with Mock"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="patch.html" title="Patch Decorators"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Mock v0.6.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="sentinel">
<h1>Sentinel<a class="headerlink" href="#sentinel" title="Permalink to this headline">¶</a></h1>
<dl class="data">
<dt id="mock.sentinel">
<tt class="descname">sentinel</tt><a class="headerlink" href="#mock.sentinel" title="Permalink to this definition">¶</a></dt>
<dd><p>The <tt class="docutils literal"><span class="pre">sentinel</span></tt> object provides a convenient way of providing unique objects for your tests.</p>
<p>Attributes are created on demand when you access them by name. Accessing the same attribute will always return the same object. The objects returned have a sensible repr so that test failure messages are readable.</p>
</dd></dl>
<dl class="data">
<dt id="mock.DEFAULT">
<tt class="descname">DEFAULT</tt><a class="headerlink" href="#mock.DEFAULT" title="Permalink to this definition">¶</a></dt>
<dd>The <tt class="docutils literal"><span class="pre">DEFAULT</span></tt> object is a pre-created sentinel (actually <tt class="docutils literal"><span class="pre">sentinel.DEFAULT</span></tt>). It can be used by <a title="mock.Mock.side_effect" class="reference external" href="mock.html#mock.Mock.side_effect"><tt class="xref docutils literal"><span class="pre">Mock.side_effect</span></tt></a> functions to indicate that the normal
return value should be used.</dd></dl>
<div class="section" id="sentinel-example">
<h2>Sentinel Example<a class="headerlink" href="#sentinel-example" title="Permalink to this headline">¶</a></h2>
<p>Sometimes when testing you need to test that a specific object is passed as an argument to another method, or returned. It can be common to create named sentinel objects to test this. <tt class="docutils literal"><span class="pre">sentinel</span></tt> provides a convenient way of creating and testing the identity of objects like this.</p>
<p>In this example we monkey patch <tt class="docutils literal"><span class="pre">method</span></tt> to return <tt class="docutils literal"><span class="pre">sentinel.return_value</span></tt>. We want to test that this is the value returned when we call <tt class="docutils literal"><span class="pre">something</span></tt>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">real</span> <span class="o">=</span> <span class="n">ProductionClass</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">real</span><span class="o">.</span><span class="n">method</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">real</span><span class="o">.</span><span class="n">method</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="n">sentinel</span><span class="o">.</span><span class="n">return_value</span>
<span class="gp">>>> </span><span class="n">returned</span> <span class="o">=</span> <span class="n">real</span><span class="o">.</span><span class="n">something</span><span class="p">()</span>
<span class="gp">>>> </span><span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="n">returned</span><span class="p">,</span> <span class="n">sentinel</span><span class="o">.</span><span class="n">return_value</span><span class="p">,</span> <span class="s">"something returned the wrong value"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">sentinel</span><span class="o">.</span><span class="n">return_value</span>
<span class="go"><SentinelObject "return_value"></span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="">Sentinel</a><ul>
<li><a class="reference external" href="#sentinel-example">Sentinel Example</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="patch.html"
title="previous chapter">Patch Decorators</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="getting-started.html"
title="next chapter">Getting Started with Mock</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/sentinel.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="getting-started.html" title="Getting Started with Mock"
>next</a> |</li>
<li class="right" >
<a href="patch.html" title="Patch Decorators"
>previous</a> |</li>
<li><a href="index.html">Mock v0.6.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009, Michael Foord.
Last updated on Aug 22, 2009.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
</div>
</body>
</html>
|
