1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/python/mock-1.0.0/html/magicmock.html Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,347 @@
1.4 +
1.5 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1.6 + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1.7 +
1.8 +
1.9 +<html xmlns="http://www.w3.org/1999/xhtml">
1.10 + <head>
1.11 + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1.12 +
1.13 + <title>Mocking Magic Methods — Mock 1.0.0 documentation</title>
1.14 +
1.15 + <link rel="stylesheet" href="_static/nature.css" type="text/css" />
1.16 + <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1.17 +
1.18 + <script type="text/javascript">
1.19 + var DOCUMENTATION_OPTIONS = {
1.20 + URL_ROOT: '',
1.21 + VERSION: '1.0.0',
1.22 + COLLAPSE_INDEX: false,
1.23 + FILE_SUFFIX: '.html',
1.24 + HAS_SOURCE: true
1.25 + };
1.26 + </script>
1.27 + <script type="text/javascript" src="_static/jquery.js"></script>
1.28 + <script type="text/javascript" src="_static/underscore.js"></script>
1.29 + <script type="text/javascript" src="_static/doctools.js"></script>
1.30 + <link rel="top" title="Mock 1.0.0 documentation" href="index.html" />
1.31 + <link rel="next" title="Getting Started with Mock" href="getting-started.html" />
1.32 + <link rel="prev" title="Sentinel" href="sentinel.html" />
1.33 + </head>
1.34 + <body>
1.35 + <div class="related">
1.36 + <h3>Navigation</h3>
1.37 + <ul>
1.38 + <li class="right" style="margin-right: 10px">
1.39 + <a href="genindex.html" title="General Index"
1.40 + accesskey="I">index</a></li>
1.41 + <li class="right" >
1.42 + <a href="getting-started.html" title="Getting Started with Mock"
1.43 + accesskey="N">next</a> |</li>
1.44 + <li class="right" >
1.45 + <a href="sentinel.html" title="Sentinel"
1.46 + accesskey="P">previous</a> |</li>
1.47 + <li><a href="index.html">Mock 1.0.0 documentation</a> »</li>
1.48 + </ul>
1.49 + </div>
1.50 +
1.51 + <div class="document">
1.52 + <div class="documentwrapper">
1.53 + <div class="bodywrapper">
1.54 + <div class="body">
1.55 +
1.56 + <div class="section" id="mocking-magic-methods">
1.57 +<span id="magic-methods"></span><h1>Mocking Magic Methods<a class="headerlink" href="#mocking-magic-methods" title="Permalink to this headline">¶</a></h1>
1.58 +<p><a class="reference internal" href="mock.html#mock.Mock" title="mock.Mock"><tt class="xref py py-class docutils literal"><span class="pre">Mock</span></tt></a> supports mocking <a class="reference external" href="http://www.ironpythoninaction.com/magic-methods.html">magic methods</a>. This allows mock
1.59 +objects to replace containers or other objects that implement Python
1.60 +protocols.</p>
1.61 +<p>Because magic methods are looked up differently from normal methods <a class="footnote-reference" href="#id4" id="id2">[1]</a>, this
1.62 +support has been specially implemented. This means that only specific magic
1.63 +methods are supported. The supported list includes <em>almost</em> all of them. If
1.64 +there are any missing that you need please let us know!</p>
1.65 +<p>You mock magic methods by setting the method you are interested in to a function
1.66 +or a mock instance. If you are using a function then it <em>must</em> take <tt class="docutils literal"><span class="pre">self</span></tt> as
1.67 +the first argument <a class="footnote-reference" href="#id5" id="id3">[2]</a>.</p>
1.68 +<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
1.69 +<span class="gp">... </span> <span class="k">return</span> <span class="s">'fooble'</span>
1.70 +<span class="gp">...</span>
1.71 +<span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>
1.72 +<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">__str__</span> <span class="o">=</span> <span class="n">__str__</span>
1.73 +<span class="gp">>>> </span><span class="nb">str</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span>
1.74 +<span class="go">'fooble'</span>
1.75 +
1.76 +<span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>
1.77 +<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">__str__</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>
1.78 +<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">__str__</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="s">'fooble'</span>
1.79 +<span class="gp">>>> </span><span class="nb">str</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span>
1.80 +<span class="go">'fooble'</span>
1.81 +
1.82 +<span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>
1.83 +<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">__iter__</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">(</span><span class="n">return_value</span><span class="o">=</span><span class="nb">iter</span><span class="p">([]))</span>
1.84 +<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span>
1.85 +<span class="go">[]</span>
1.86 +</pre></div>
1.87 +</div>
1.88 +<p>One use case for this is for mocking objects used as context managers in a
1.89 +<cite>with</cite> statement:</p>
1.90 +<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>
1.91 +<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">__enter__</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">(</span><span class="n">return_value</span><span class="o">=</span><span class="s">'foo'</span><span class="p">)</span>
1.92 +<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">__exit__</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">(</span><span class="n">return_value</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
1.93 +<span class="gp">>>> </span><span class="k">with</span> <span class="n">mock</span> <span class="k">as</span> <span class="n">m</span><span class="p">:</span>
1.94 +<span class="gp">... </span> <span class="k">assert</span> <span class="n">m</span> <span class="o">==</span> <span class="s">'foo'</span>
1.95 +<span class="gp">...</span>
1.96 +<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">__enter__</span><span class="o">.</span><span class="n">assert_called_with</span><span class="p">()</span>
1.97 +<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">__exit__</span><span class="o">.</span><span class="n">assert_called_with</span><span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
1.98 +</pre></div>
1.99 +</div>
1.100 +<p>Calls to magic methods do not appear in <a class="reference internal" href="mock.html#mock.Mock.method_calls" title="mock.Mock.method_calls"><tt class="xref py py-attr docutils literal"><span class="pre">method_calls</span></tt></a>, but they
1.101 +are recorded in <a class="reference internal" href="mock.html#mock.Mock.mock_calls" title="mock.Mock.mock_calls"><tt class="xref py py-attr docutils literal"><span class="pre">mock_calls</span></tt></a>.</p>
1.102 +<div class="admonition note">
1.103 +<p class="first admonition-title">Note</p>
1.104 +<p class="last">If you use the <cite>spec</cite> keyword argument to create a mock then attempting to
1.105 +set a magic method that isn’t in the spec will raise an <cite>AttributeError</cite>.</p>
1.106 +</div>
1.107 +<p>The full list of supported magic methods is:</p>
1.108 +<ul class="simple">
1.109 +<li><tt class="docutils literal"><span class="pre">__hash__</span></tt>, <tt class="docutils literal"><span class="pre">__sizeof__</span></tt>, <tt class="docutils literal"><span class="pre">__repr__</span></tt> and <tt class="docutils literal"><span class="pre">__str__</span></tt></li>
1.110 +<li><tt class="docutils literal"><span class="pre">__dir__</span></tt>, <tt class="docutils literal"><span class="pre">__format__</span></tt> and <tt class="docutils literal"><span class="pre">__subclasses__</span></tt></li>
1.111 +<li><tt class="docutils literal"><span class="pre">__floor__</span></tt>, <tt class="docutils literal"><span class="pre">__trunc__</span></tt> and <tt class="docutils literal"><span class="pre">__ceil__</span></tt></li>
1.112 +<li>Comparisons: <tt class="docutils literal"><span class="pre">__cmp__</span></tt>, <tt class="docutils literal"><span class="pre">__lt__</span></tt>, <tt class="docutils literal"><span class="pre">__gt__</span></tt>, <tt class="docutils literal"><span class="pre">__le__</span></tt>, <tt class="docutils literal"><span class="pre">__ge__</span></tt>,
1.113 +<tt class="docutils literal"><span class="pre">__eq__</span></tt> and <tt class="docutils literal"><span class="pre">__ne__</span></tt></li>
1.114 +<li>Container methods: <tt class="docutils literal"><span class="pre">__getitem__</span></tt>, <tt class="docutils literal"><span class="pre">__setitem__</span></tt>, <tt class="docutils literal"><span class="pre">__delitem__</span></tt>,
1.115 +<tt class="docutils literal"><span class="pre">__contains__</span></tt>, <tt class="docutils literal"><span class="pre">__len__</span></tt>, <tt class="docutils literal"><span class="pre">__iter__</span></tt>, <tt class="docutils literal"><span class="pre">__getslice__</span></tt>,
1.116 +<tt class="docutils literal"><span class="pre">__setslice__</span></tt>, <tt class="docutils literal"><span class="pre">__reversed__</span></tt> and <tt class="docutils literal"><span class="pre">__missing__</span></tt></li>
1.117 +<li>Context manager: <tt class="docutils literal"><span class="pre">__enter__</span></tt> and <tt class="docutils literal"><span class="pre">__exit__</span></tt></li>
1.118 +<li>Unary numeric methods: <tt class="docutils literal"><span class="pre">__neg__</span></tt>, <tt class="docutils literal"><span class="pre">__pos__</span></tt> and <tt class="docutils literal"><span class="pre">__invert__</span></tt></li>
1.119 +<li>The numeric methods (including right hand and in-place variants):
1.120 +<tt class="docutils literal"><span class="pre">__add__</span></tt>, <tt class="docutils literal"><span class="pre">__sub__</span></tt>, <tt class="docutils literal"><span class="pre">__mul__</span></tt>, <tt class="docutils literal"><span class="pre">__div__</span></tt>,
1.121 +<tt class="docutils literal"><span class="pre">__floordiv__</span></tt>, <tt class="docutils literal"><span class="pre">__mod__</span></tt>, <tt class="docutils literal"><span class="pre">__divmod__</span></tt>, <tt class="docutils literal"><span class="pre">__lshift__</span></tt>,
1.122 +<tt class="docutils literal"><span class="pre">__rshift__</span></tt>, <tt class="docutils literal"><span class="pre">__and__</span></tt>, <tt class="docutils literal"><span class="pre">__xor__</span></tt>, <tt class="docutils literal"><span class="pre">__or__</span></tt>, and <tt class="docutils literal"><span class="pre">__pow__</span></tt></li>
1.123 +<li>Numeric conversion methods: <tt class="docutils literal"><span class="pre">__complex__</span></tt>, <tt class="docutils literal"><span class="pre">__int__</span></tt>, <tt class="docutils literal"><span class="pre">__float__</span></tt>,
1.124 +<tt class="docutils literal"><span class="pre">__index__</span></tt> and <tt class="docutils literal"><span class="pre">__coerce__</span></tt></li>
1.125 +<li>Descriptor methods: <tt class="docutils literal"><span class="pre">__get__</span></tt>, <tt class="docutils literal"><span class="pre">__set__</span></tt> and <tt class="docutils literal"><span class="pre">__delete__</span></tt></li>
1.126 +<li>Pickling: <tt class="docutils literal"><span class="pre">__reduce__</span></tt>, <tt class="docutils literal"><span class="pre">__reduce_ex__</span></tt>, <tt class="docutils literal"><span class="pre">__getinitargs__</span></tt>,
1.127 +<tt class="docutils literal"><span class="pre">__getnewargs__</span></tt>, <tt class="docutils literal"><span class="pre">__getstate__</span></tt> and <tt class="docutils literal"><span class="pre">__setstate__</span></tt></li>
1.128 +</ul>
1.129 +<p>The following methods are supported in Python 2 but don’t exist in Python 3:</p>
1.130 +<ul class="simple">
1.131 +<li><tt class="docutils literal"><span class="pre">__unicode__</span></tt>, <tt class="docutils literal"><span class="pre">__long__</span></tt>, <tt class="docutils literal"><span class="pre">__oct__</span></tt>, <tt class="docutils literal"><span class="pre">__hex__</span></tt> and <tt class="docutils literal"><span class="pre">__nonzero__</span></tt></li>
1.132 +<li><tt class="docutils literal"><span class="pre">__truediv__</span></tt> and <tt class="docutils literal"><span class="pre">__rtruediv__</span></tt></li>
1.133 +</ul>
1.134 +<p>The following methods are supported in Python 3 but don’t exist in Python 2:</p>
1.135 +<ul class="simple">
1.136 +<li><tt class="docutils literal"><span class="pre">__bool__</span></tt> and <tt class="docutils literal"><span class="pre">__next__</span></tt></li>
1.137 +</ul>
1.138 +<p>The following methods exist but are <em>not</em> supported as they are either in use by
1.139 +mock, can’t be set dynamically, or can cause problems:</p>
1.140 +<ul class="simple">
1.141 +<li><tt class="docutils literal"><span class="pre">__getattr__</span></tt>, <tt class="docutils literal"><span class="pre">__setattr__</span></tt>, <tt class="docutils literal"><span class="pre">__init__</span></tt> and <tt class="docutils literal"><span class="pre">__new__</span></tt></li>
1.142 +<li><tt class="docutils literal"><span class="pre">__prepare__</span></tt>, <tt class="docutils literal"><span class="pre">__instancecheck__</span></tt>, <tt class="docutils literal"><span class="pre">__subclasscheck__</span></tt>, <tt class="docutils literal"><span class="pre">__del__</span></tt></li>
1.143 +</ul>
1.144 +</div>
1.145 +<div class="section" id="magic-mock">
1.146 +<h1>Magic Mock<a class="headerlink" href="#magic-mock" title="Permalink to this headline">¶</a></h1>
1.147 +<p>There are two <cite>MagicMock</cite> variants: <cite>MagicMock</cite> and <cite>NonCallableMagicMock</cite>.</p>
1.148 +<dl class="class">
1.149 +<dt id="mock.MagicMock">
1.150 +<em class="property">class </em><tt class="descname">MagicMock</tt><big>(</big><em>*args</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#mock.MagicMock" title="Permalink to this definition">¶</a></dt>
1.151 +<dd><p><tt class="docutils literal"><span class="pre">MagicMock</span></tt> is a subclass of <a class="reference internal" href="mock.html#mock.Mock" title="mock.Mock"><tt class="xref py py-class docutils literal"><span class="pre">Mock</span></tt></a> with default implementations
1.152 +of most of the magic methods. You can use <tt class="docutils literal"><span class="pre">MagicMock</span></tt> without having to
1.153 +configure the magic methods yourself.</p>
1.154 +<p>The constructor parameters have the same meaning as for <a class="reference internal" href="mock.html#mock.Mock" title="mock.Mock"><tt class="xref py py-class docutils literal"><span class="pre">Mock</span></tt></a>.</p>
1.155 +<p>If you use the <cite>spec</cite> or <cite>spec_set</cite> arguments then <em>only</em> magic methods
1.156 +that exist in the spec will be created.</p>
1.157 +</dd></dl>
1.158 +
1.159 +<dl class="class">
1.160 +<dt id="mock.NonCallableMagicMock">
1.161 +<em class="property">class </em><tt class="descname">NonCallableMagicMock</tt><big>(</big><em>*args</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#mock.NonCallableMagicMock" title="Permalink to this definition">¶</a></dt>
1.162 +<dd><p>A non-callable version of <cite>MagicMock</cite>.</p>
1.163 +<p>The constructor parameters have the same meaning as for
1.164 +<a class="reference internal" href="#mock.MagicMock" title="mock.MagicMock"><tt class="xref py py-class docutils literal"><span class="pre">MagicMock</span></tt></a>, with the exception of <cite>return_value</cite> and
1.165 +<cite>side_effect</cite> which have no meaning on a non-callable mock.</p>
1.166 +</dd></dl>
1.167 +
1.168 +<p>The magic methods are setup with <cite>MagicMock</cite> objects, so you can configure them
1.169 +and use them in the usual way:</p>
1.170 +<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">MagicMock</span><span class="p">()</span>
1.171 +<span class="gp">>>> </span><span class="n">mock</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">=</span> <span class="s">'fish'</span>
1.172 +<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">__setitem__</span><span class="o">.</span><span class="n">assert_called_with</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="s">'fish'</span><span class="p">)</span>
1.173 +<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">__getitem__</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="s">'result'</span>
1.174 +<span class="gp">>>> </span><span class="n">mock</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
1.175 +<span class="go">'result'</span>
1.176 +</pre></div>
1.177 +</div>
1.178 +<p>By default many of the protocol methods are required to return objects of a
1.179 +specific type. These methods are preconfigured with a default return value, so
1.180 +that they can be used without you having to do anything if you aren’t interested
1.181 +in the return value. You can still <em>set</em> the return value manually if you want
1.182 +to change the default.</p>
1.183 +<p>Methods and their defaults:</p>
1.184 +<ul class="simple">
1.185 +<li><tt class="docutils literal"><span class="pre">__lt__</span></tt>: NotImplemented</li>
1.186 +<li><tt class="docutils literal"><span class="pre">__gt__</span></tt>: NotImplemented</li>
1.187 +<li><tt class="docutils literal"><span class="pre">__le__</span></tt>: NotImplemented</li>
1.188 +<li><tt class="docutils literal"><span class="pre">__ge__</span></tt>: NotImplemented</li>
1.189 +<li><tt class="docutils literal"><span class="pre">__int__</span></tt> : 1</li>
1.190 +<li><tt class="docutils literal"><span class="pre">__contains__</span></tt> : False</li>
1.191 +<li><tt class="docutils literal"><span class="pre">__len__</span></tt> : 1</li>
1.192 +<li><tt class="docutils literal"><span class="pre">__iter__</span></tt> : iter([])</li>
1.193 +<li><tt class="docutils literal"><span class="pre">__exit__</span></tt> : False</li>
1.194 +<li><tt class="docutils literal"><span class="pre">__complex__</span></tt> : 1j</li>
1.195 +<li><tt class="docutils literal"><span class="pre">__float__</span></tt> : 1.0</li>
1.196 +<li><tt class="docutils literal"><span class="pre">__bool__</span></tt> : True</li>
1.197 +<li><tt class="docutils literal"><span class="pre">__nonzero__</span></tt> : True</li>
1.198 +<li><tt class="docutils literal"><span class="pre">__oct__</span></tt> : ‘1’</li>
1.199 +<li><tt class="docutils literal"><span class="pre">__hex__</span></tt> : ‘0x1’</li>
1.200 +<li><tt class="docutils literal"><span class="pre">__long__</span></tt> : long(1)</li>
1.201 +<li><tt class="docutils literal"><span class="pre">__index__</span></tt> : 1</li>
1.202 +<li><tt class="docutils literal"><span class="pre">__hash__</span></tt> : default hash for the mock</li>
1.203 +<li><tt class="docutils literal"><span class="pre">__str__</span></tt> : default str for the mock</li>
1.204 +<li><tt class="docutils literal"><span class="pre">__unicode__</span></tt> : default unicode for the mock</li>
1.205 +<li><tt class="docutils literal"><span class="pre">__sizeof__</span></tt>: default sizeof for the mock</li>
1.206 +</ul>
1.207 +<p>For example:</p>
1.208 +<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">MagicMock</span><span class="p">()</span>
1.209 +<span class="gp">>>> </span><span class="nb">int</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span>
1.210 +<span class="go">1</span>
1.211 +<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span>
1.212 +<span class="go">0</span>
1.213 +<span class="gp">>>> </span><span class="nb">hex</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span>
1.214 +<span class="go">'0x1'</span>
1.215 +<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span>
1.216 +<span class="go">[]</span>
1.217 +<span class="gp">>>> </span><span class="nb">object</span><span class="p">()</span> <span class="ow">in</span> <span class="n">mock</span>
1.218 +<span class="go">False</span>
1.219 +</pre></div>
1.220 +</div>
1.221 +<p>The two equality method, <cite>__eq__</cite> and <cite>__ne__</cite>, are special (changed in
1.222 +0.7.2). They do the default equality comparison on identity, using a side
1.223 +effect, unless you change their return value to return something else:</p>
1.224 +<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">MagicMock</span><span class="p">()</span> <span class="o">==</span> <span class="mi">3</span>
1.225 +<span class="go">False</span>
1.226 +<span class="gp">>>> </span><span class="n">MagicMock</span><span class="p">()</span> <span class="o">!=</span> <span class="mi">3</span>
1.227 +<span class="go">True</span>
1.228 +<span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">MagicMock</span><span class="p">()</span>
1.229 +<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">__eq__</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="bp">True</span>
1.230 +<span class="gp">>>> </span><span class="n">mock</span> <span class="o">==</span> <span class="mi">3</span>
1.231 +<span class="go">True</span>
1.232 +</pre></div>
1.233 +</div>
1.234 +<p>In <cite>0.8</cite> the <cite>__iter__</cite> also gained special handling implemented with a
1.235 +side effect. The return value of <cite>MagicMock.__iter__</cite> can be any iterable
1.236 +object and isn’t required to be an iterator:</p>
1.237 +<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">MagicMock</span><span class="p">()</span>
1.238 +<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">__iter__</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="p">[</span><span class="s">'a'</span><span class="p">,</span> <span class="s">'b'</span><span class="p">,</span> <span class="s">'c'</span><span class="p">]</span>
1.239 +<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span>
1.240 +<span class="go">['a', 'b', 'c']</span>
1.241 +<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span>
1.242 +<span class="go">['a', 'b', 'c']</span>
1.243 +</pre></div>
1.244 +</div>
1.245 +<p>If the return value <em>is</em> an iterator, then iterating over it once will consume
1.246 +it and subsequent iterations will result in an empty list:</p>
1.247 +<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">__iter__</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">([</span><span class="s">'a'</span><span class="p">,</span> <span class="s">'b'</span><span class="p">,</span> <span class="s">'c'</span><span class="p">])</span>
1.248 +<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span>
1.249 +<span class="go">['a', 'b', 'c']</span>
1.250 +<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span>
1.251 +<span class="go">[]</span>
1.252 +</pre></div>
1.253 +</div>
1.254 +<p><tt class="docutils literal"><span class="pre">MagicMock</span></tt> has all of the supported magic methods configured except for some
1.255 +of the obscure and obsolete ones. You can still set these up if you want.</p>
1.256 +<p>Magic methods that are supported but not setup by default in <tt class="docutils literal"><span class="pre">MagicMock</span></tt> are:</p>
1.257 +<ul class="simple">
1.258 +<li><tt class="docutils literal"><span class="pre">__cmp__</span></tt></li>
1.259 +<li><tt class="docutils literal"><span class="pre">__getslice__</span></tt> and <tt class="docutils literal"><span class="pre">__setslice__</span></tt></li>
1.260 +<li><tt class="docutils literal"><span class="pre">__coerce__</span></tt></li>
1.261 +<li><tt class="docutils literal"><span class="pre">__subclasses__</span></tt></li>
1.262 +<li><tt class="docutils literal"><span class="pre">__dir__</span></tt></li>
1.263 +<li><tt class="docutils literal"><span class="pre">__format__</span></tt></li>
1.264 +<li><tt class="docutils literal"><span class="pre">__get__</span></tt>, <tt class="docutils literal"><span class="pre">__set__</span></tt> and <tt class="docutils literal"><span class="pre">__delete__</span></tt></li>
1.265 +<li><tt class="docutils literal"><span class="pre">__reversed__</span></tt> and <tt class="docutils literal"><span class="pre">__missing__</span></tt></li>
1.266 +<li><tt class="docutils literal"><span class="pre">__reduce__</span></tt>, <tt class="docutils literal"><span class="pre">__reduce_ex__</span></tt>, <tt class="docutils literal"><span class="pre">__getinitargs__</span></tt>, <tt class="docutils literal"><span class="pre">__getnewargs__</span></tt>,
1.267 +<tt class="docutils literal"><span class="pre">__getstate__</span></tt> and <tt class="docutils literal"><span class="pre">__setstate__</span></tt></li>
1.268 +<li><tt class="docutils literal"><span class="pre">__getformat__</span></tt> and <tt class="docutils literal"><span class="pre">__setformat__</span></tt></li>
1.269 +</ul>
1.270 +<hr class="docutils" />
1.271 +<table class="docutils footnote" frame="void" id="id4" rules="none">
1.272 +<colgroup><col class="label" /><col /></colgroup>
1.273 +<tbody valign="top">
1.274 +<tr><td class="label"><a class="fn-backref" href="#id2">[1]</a></td><td>Magic methods <em>should</em> be looked up on the class rather than the
1.275 +instance. Different versions of Python are inconsistent about applying this
1.276 +rule. The supported protocol methods should work with all supported versions
1.277 +of Python.</td></tr>
1.278 +</tbody>
1.279 +</table>
1.280 +<table class="docutils footnote" frame="void" id="id5" rules="none">
1.281 +<colgroup><col class="label" /><col /></colgroup>
1.282 +<tbody valign="top">
1.283 +<tr><td class="label"><a class="fn-backref" href="#id3">[2]</a></td><td>The function is basically hooked up to the class, but each <tt class="docutils literal"><span class="pre">Mock</span></tt>
1.284 +instance is kept isolated from the others.</td></tr>
1.285 +</tbody>
1.286 +</table>
1.287 +</div>
1.288 +
1.289 +
1.290 + </div>
1.291 + </div>
1.292 + </div>
1.293 + <div class="sphinxsidebar">
1.294 + <div class="sphinxsidebarwrapper">
1.295 + <h3><a href="index.html">Table Of Contents</a></h3>
1.296 + <ul>
1.297 +<li><a class="reference internal" href="#">Mocking Magic Methods</a></li>
1.298 +<li><a class="reference internal" href="#magic-mock">Magic Mock</a></li>
1.299 +</ul>
1.300 +
1.301 + <h4>Previous topic</h4>
1.302 + <p class="topless"><a href="sentinel.html"
1.303 + title="previous chapter">Sentinel</a></p>
1.304 + <h4>Next topic</h4>
1.305 + <p class="topless"><a href="getting-started.html"
1.306 + title="next chapter">Getting Started with Mock</a></p>
1.307 + <h3>This Page</h3>
1.308 + <ul class="this-page-menu">
1.309 + <li><a href="_sources/magicmock.txt"
1.310 + rel="nofollow">Show Source</a></li>
1.311 + </ul>
1.312 +<div id="searchbox" style="display: none">
1.313 + <h3>Quick search</h3>
1.314 + <form class="search" action="search.html" method="get">
1.315 + <input type="text" name="q" />
1.316 + <input type="submit" value="Go" />
1.317 + <input type="hidden" name="check_keywords" value="yes" />
1.318 + <input type="hidden" name="area" value="default" />
1.319 + </form>
1.320 + <p class="searchtip" style="font-size: 90%">
1.321 + Enter search terms or a module, class or function name.
1.322 + </p>
1.323 +</div>
1.324 +<script type="text/javascript">$('#searchbox').show(0);</script>
1.325 + </div>
1.326 + </div>
1.327 + <div class="clearer"></div>
1.328 + </div>
1.329 + <div class="related">
1.330 + <h3>Navigation</h3>
1.331 + <ul>
1.332 + <li class="right" style="margin-right: 10px">
1.333 + <a href="genindex.html" title="General Index"
1.334 + >index</a></li>
1.335 + <li class="right" >
1.336 + <a href="getting-started.html" title="Getting Started with Mock"
1.337 + >next</a> |</li>
1.338 + <li class="right" >
1.339 + <a href="sentinel.html" title="Sentinel"
1.340 + >previous</a> |</li>
1.341 + <li><a href="index.html">Mock 1.0.0 documentation</a> »</li>
1.342 + </ul>
1.343 + </div>
1.344 + <div class="footer">
1.345 + © Copyright 2007-2012, Michael Foord & the mock team.
1.346 + Last updated on Oct 07, 2012.
1.347 + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
1.348 + </div>
1.349 + </body>
1.350 +</html>
1.351 \ No newline at end of file
