python/mock-1.0.0/html/magicmock.html@7e26c7da4463 (annotated)
python/mock-1.0.0/html/magicmock.html
Wed, 31 Dec 2014 06:55:50 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:55:50 +0100
- changeset 2
- 7e26c7da4463
- permissions
- -rw-r--r--
Added tag UPSTREAM_283F7C6 for changeset ca08bd8f51b2
| michael@0 | 1 | |
| michael@0 | 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| michael@0 | 3 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| michael@0 | 4 | |
| michael@0 | 5 | |
| michael@0 | 6 | <html xmlns="http://www.w3.org/1999/xhtml"> |
| michael@0 | 7 | <head> |
| michael@0 | 8 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| michael@0 | 9 | |
| michael@0 | 10 | <title>Mocking Magic Methods — Mock 1.0.0 documentation</title> |
| michael@0 | 11 | |
| michael@0 | 12 | <link rel="stylesheet" href="_static/nature.css" type="text/css" /> |
| michael@0 | 13 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
| michael@0 | 14 | |
| michael@0 | 15 | <script type="text/javascript"> |
| michael@0 | 16 | var DOCUMENTATION_OPTIONS = { |
| michael@0 | 17 | URL_ROOT: '', |
| michael@0 | 18 | VERSION: '1.0.0', |
| michael@0 | 19 | COLLAPSE_INDEX: false, |
| michael@0 | 20 | FILE_SUFFIX: '.html', |
| michael@0 | 21 | HAS_SOURCE: true |
| michael@0 | 22 | }; |
| michael@0 | 23 | </script> |
| michael@0 | 24 | <script type="text/javascript" src="_static/jquery.js"></script> |
| michael@0 | 25 | <script type="text/javascript" src="_static/underscore.js"></script> |
| michael@0 | 26 | <script type="text/javascript" src="_static/doctools.js"></script> |
| michael@0 | 27 | <link rel="top" title="Mock 1.0.0 documentation" href="index.html" /> |
| michael@0 | 28 | <link rel="next" title="Getting Started with Mock" href="getting-started.html" /> |
| michael@0 | 29 | <link rel="prev" title="Sentinel" href="sentinel.html" /> |
| michael@0 | 30 | </head> |
| michael@0 | 31 | <body> |
| michael@0 | 32 | <div class="related"> |
| michael@0 | 33 | <h3>Navigation</h3> |
| michael@0 | 34 | <ul> |
| michael@0 | 35 | <li class="right" style="margin-right: 10px"> |
| michael@0 | 36 | <a href="genindex.html" title="General Index" |
| michael@0 | 37 | accesskey="I">index</a></li> |
| michael@0 | 38 | <li class="right" > |
| michael@0 | 39 | <a href="getting-started.html" title="Getting Started with Mock" |
| michael@0 | 40 | accesskey="N">next</a> |</li> |
| michael@0 | 41 | <li class="right" > |
| michael@0 | 42 | <a href="sentinel.html" title="Sentinel" |
| michael@0 | 43 | accesskey="P">previous</a> |</li> |
| michael@0 | 44 | <li><a href="index.html">Mock 1.0.0 documentation</a> »</li> |
| michael@0 | 45 | </ul> |
| michael@0 | 46 | </div> |
| michael@0 | 47 | |
| michael@0 | 48 | <div class="document"> |
| michael@0 | 49 | <div class="documentwrapper"> |
| michael@0 | 50 | <div class="bodywrapper"> |
| michael@0 | 51 | <div class="body"> |
| michael@0 | 52 | |
| michael@0 | 53 | <div class="section" id="mocking-magic-methods"> |
| michael@0 | 54 | <span id="magic-methods"></span><h1>Mocking Magic Methods<a class="headerlink" href="#mocking-magic-methods" title="Permalink to this headline">ΒΆ</a></h1> |
| michael@0 | 55 | <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 |
| michael@0 | 56 | objects to replace containers or other objects that implement Python |
| michael@0 | 57 | protocols.</p> |
| michael@0 | 58 | <p>Because magic methods are looked up differently from normal methods <a class="footnote-reference" href="#id4" id="id2">[1]</a>, this |
| michael@0 | 59 | support has been specially implemented. This means that only specific magic |
| michael@0 | 60 | methods are supported. The supported list includes <em>almost</em> all of them. If |
| michael@0 | 61 | there are any missing that you need please let us know!</p> |
| michael@0 | 62 | <p>You mock magic methods by setting the method you are interested in to a function |
| michael@0 | 63 | 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 |
| michael@0 | 64 | the first argument <a class="footnote-reference" href="#id5" id="id3">[2]</a>.</p> |
| michael@0 | 65 | <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> |
| michael@0 | 66 | <span class="gp">... </span> <span class="k">return</span> <span class="s">'fooble'</span> |
| michael@0 | 67 | <span class="gp">...</span> |
| michael@0 | 68 | <span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span> |
| michael@0 | 69 | <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> |
| michael@0 | 70 | <span class="gp">>>> </span><span class="nb">str</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 71 | <span class="go">'fooble'</span> |
| michael@0 | 72 | |
| michael@0 | 73 | <span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span> |
| michael@0 | 74 | <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> |
| michael@0 | 75 | <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> |
| michael@0 | 76 | <span class="gp">>>> </span><span class="nb">str</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 77 | <span class="go">'fooble'</span> |
| michael@0 | 78 | |
| michael@0 | 79 | <span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span> |
| michael@0 | 80 | <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> |
| michael@0 | 81 | <span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 82 | <span class="go">[]</span> |
| michael@0 | 83 | </pre></div> |
| michael@0 | 84 | </div> |
| michael@0 | 85 | <p>One use case for this is for mocking objects used as context managers in a |
| michael@0 | 86 | <cite>with</cite> statement:</p> |
| michael@0 | 87 | <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> |
| michael@0 | 88 | <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> |
| michael@0 | 89 | <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> |
| michael@0 | 90 | <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> |
| michael@0 | 91 | <span class="gp">... </span> <span class="k">assert</span> <span class="n">m</span> <span class="o">==</span> <span class="s">'foo'</span> |
| michael@0 | 92 | <span class="gp">...</span> |
| michael@0 | 93 | <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> |
| michael@0 | 94 | <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> |
| michael@0 | 95 | </pre></div> |
| michael@0 | 96 | </div> |
| michael@0 | 97 | <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 |
| michael@0 | 98 | 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> |
| michael@0 | 99 | <div class="admonition note"> |
| michael@0 | 100 | <p class="first admonition-title">Note</p> |
| michael@0 | 101 | <p class="last">If you use the <cite>spec</cite> keyword argument to create a mock then attempting to |
| michael@0 | 102 | set a magic method that isn’t in the spec will raise an <cite>AttributeError</cite>.</p> |
| michael@0 | 103 | </div> |
| michael@0 | 104 | <p>The full list of supported magic methods is:</p> |
| michael@0 | 105 | <ul class="simple"> |
| michael@0 | 106 | <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> |
| michael@0 | 107 | <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> |
| michael@0 | 108 | <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> |
| michael@0 | 109 | <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>, |
| michael@0 | 110 | <tt class="docutils literal"><span class="pre">__eq__</span></tt> and <tt class="docutils literal"><span class="pre">__ne__</span></tt></li> |
| michael@0 | 111 | <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>, |
| michael@0 | 112 | <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>, |
| michael@0 | 113 | <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> |
| michael@0 | 114 | <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> |
| michael@0 | 115 | <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> |
| michael@0 | 116 | <li>The numeric methods (including right hand and in-place variants): |
| michael@0 | 117 | <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>, |
| michael@0 | 118 | <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>, |
| michael@0 | 119 | <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> |
| michael@0 | 120 | <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>, |
| michael@0 | 121 | <tt class="docutils literal"><span class="pre">__index__</span></tt> and <tt class="docutils literal"><span class="pre">__coerce__</span></tt></li> |
| michael@0 | 122 | <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> |
| michael@0 | 123 | <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>, |
| michael@0 | 124 | <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> |
| michael@0 | 125 | </ul> |
| michael@0 | 126 | <p>The following methods are supported in Python 2 but don’t exist in Python 3:</p> |
| michael@0 | 127 | <ul class="simple"> |
| michael@0 | 128 | <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> |
| michael@0 | 129 | <li><tt class="docutils literal"><span class="pre">__truediv__</span></tt> and <tt class="docutils literal"><span class="pre">__rtruediv__</span></tt></li> |
| michael@0 | 130 | </ul> |
| michael@0 | 131 | <p>The following methods are supported in Python 3 but don’t exist in Python 2:</p> |
| michael@0 | 132 | <ul class="simple"> |
| michael@0 | 133 | <li><tt class="docutils literal"><span class="pre">__bool__</span></tt> and <tt class="docutils literal"><span class="pre">__next__</span></tt></li> |
| michael@0 | 134 | </ul> |
| michael@0 | 135 | <p>The following methods exist but are <em>not</em> supported as they are either in use by |
| michael@0 | 136 | mock, can’t be set dynamically, or can cause problems:</p> |
| michael@0 | 137 | <ul class="simple"> |
| michael@0 | 138 | <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> |
| michael@0 | 139 | <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> |
| michael@0 | 140 | </ul> |
| michael@0 | 141 | </div> |
| michael@0 | 142 | <div class="section" id="magic-mock"> |
| michael@0 | 143 | <h1>Magic Mock<a class="headerlink" href="#magic-mock" title="Permalink to this headline">ΒΆ</a></h1> |
| michael@0 | 144 | <p>There are two <cite>MagicMock</cite> variants: <cite>MagicMock</cite> and <cite>NonCallableMagicMock</cite>.</p> |
| michael@0 | 145 | <dl class="class"> |
| michael@0 | 146 | <dt id="mock.MagicMock"> |
| michael@0 | 147 | <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> |
| michael@0 | 148 | <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 |
| michael@0 | 149 | of most of the magic methods. You can use <tt class="docutils literal"><span class="pre">MagicMock</span></tt> without having to |
| michael@0 | 150 | configure the magic methods yourself.</p> |
| michael@0 | 151 | <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> |
| michael@0 | 152 | <p>If you use the <cite>spec</cite> or <cite>spec_set</cite> arguments then <em>only</em> magic methods |
| michael@0 | 153 | that exist in the spec will be created.</p> |
| michael@0 | 154 | </dd></dl> |
| michael@0 | 155 | |
| michael@0 | 156 | <dl class="class"> |
| michael@0 | 157 | <dt id="mock.NonCallableMagicMock"> |
| michael@0 | 158 | <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> |
| michael@0 | 159 | <dd><p>A non-callable version of <cite>MagicMock</cite>.</p> |
| michael@0 | 160 | <p>The constructor parameters have the same meaning as for |
| michael@0 | 161 | <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 |
| michael@0 | 162 | <cite>side_effect</cite> which have no meaning on a non-callable mock.</p> |
| michael@0 | 163 | </dd></dl> |
| michael@0 | 164 | |
| michael@0 | 165 | <p>The magic methods are setup with <cite>MagicMock</cite> objects, so you can configure them |
| michael@0 | 166 | and use them in the usual way:</p> |
| michael@0 | 167 | <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> |
| michael@0 | 168 | <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> |
| michael@0 | 169 | <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> |
| michael@0 | 170 | <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> |
| michael@0 | 171 | <span class="gp">>>> </span><span class="n">mock</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> |
| michael@0 | 172 | <span class="go">'result'</span> |
| michael@0 | 173 | </pre></div> |
| michael@0 | 174 | </div> |
| michael@0 | 175 | <p>By default many of the protocol methods are required to return objects of a |
| michael@0 | 176 | specific type. These methods are preconfigured with a default return value, so |
| michael@0 | 177 | that they can be used without you having to do anything if you aren’t interested |
| michael@0 | 178 | in the return value. You can still <em>set</em> the return value manually if you want |
| michael@0 | 179 | to change the default.</p> |
| michael@0 | 180 | <p>Methods and their defaults:</p> |
| michael@0 | 181 | <ul class="simple"> |
| michael@0 | 182 | <li><tt class="docutils literal"><span class="pre">__lt__</span></tt>: NotImplemented</li> |
| michael@0 | 183 | <li><tt class="docutils literal"><span class="pre">__gt__</span></tt>: NotImplemented</li> |
| michael@0 | 184 | <li><tt class="docutils literal"><span class="pre">__le__</span></tt>: NotImplemented</li> |
| michael@0 | 185 | <li><tt class="docutils literal"><span class="pre">__ge__</span></tt>: NotImplemented</li> |
| michael@0 | 186 | <li><tt class="docutils literal"><span class="pre">__int__</span></tt> : 1</li> |
| michael@0 | 187 | <li><tt class="docutils literal"><span class="pre">__contains__</span></tt> : False</li> |
| michael@0 | 188 | <li><tt class="docutils literal"><span class="pre">__len__</span></tt> : 1</li> |
| michael@0 | 189 | <li><tt class="docutils literal"><span class="pre">__iter__</span></tt> : iter([])</li> |
| michael@0 | 190 | <li><tt class="docutils literal"><span class="pre">__exit__</span></tt> : False</li> |
| michael@0 | 191 | <li><tt class="docutils literal"><span class="pre">__complex__</span></tt> : 1j</li> |
| michael@0 | 192 | <li><tt class="docutils literal"><span class="pre">__float__</span></tt> : 1.0</li> |
| michael@0 | 193 | <li><tt class="docutils literal"><span class="pre">__bool__</span></tt> : True</li> |
| michael@0 | 194 | <li><tt class="docutils literal"><span class="pre">__nonzero__</span></tt> : True</li> |
| michael@0 | 195 | <li><tt class="docutils literal"><span class="pre">__oct__</span></tt> : ‘1’</li> |
| michael@0 | 196 | <li><tt class="docutils literal"><span class="pre">__hex__</span></tt> : ‘0x1’</li> |
| michael@0 | 197 | <li><tt class="docutils literal"><span class="pre">__long__</span></tt> : long(1)</li> |
| michael@0 | 198 | <li><tt class="docutils literal"><span class="pre">__index__</span></tt> : 1</li> |
| michael@0 | 199 | <li><tt class="docutils literal"><span class="pre">__hash__</span></tt> : default hash for the mock</li> |
| michael@0 | 200 | <li><tt class="docutils literal"><span class="pre">__str__</span></tt> : default str for the mock</li> |
| michael@0 | 201 | <li><tt class="docutils literal"><span class="pre">__unicode__</span></tt> : default unicode for the mock</li> |
| michael@0 | 202 | <li><tt class="docutils literal"><span class="pre">__sizeof__</span></tt>: default sizeof for the mock</li> |
| michael@0 | 203 | </ul> |
| michael@0 | 204 | <p>For example:</p> |
| michael@0 | 205 | <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> |
| michael@0 | 206 | <span class="gp">>>> </span><span class="nb">int</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 207 | <span class="go">1</span> |
| michael@0 | 208 | <span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 209 | <span class="go">0</span> |
| michael@0 | 210 | <span class="gp">>>> </span><span class="nb">hex</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 211 | <span class="go">'0x1'</span> |
| michael@0 | 212 | <span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 213 | <span class="go">[]</span> |
| michael@0 | 214 | <span class="gp">>>> </span><span class="nb">object</span><span class="p">()</span> <span class="ow">in</span> <span class="n">mock</span> |
| michael@0 | 215 | <span class="go">False</span> |
| michael@0 | 216 | </pre></div> |
| michael@0 | 217 | </div> |
| michael@0 | 218 | <p>The two equality method, <cite>__eq__</cite> and <cite>__ne__</cite>, are special (changed in |
| michael@0 | 219 | 0.7.2). They do the default equality comparison on identity, using a side |
| michael@0 | 220 | effect, unless you change their return value to return something else:</p> |
| michael@0 | 221 | <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> |
| michael@0 | 222 | <span class="go">False</span> |
| michael@0 | 223 | <span class="gp">>>> </span><span class="n">MagicMock</span><span class="p">()</span> <span class="o">!=</span> <span class="mi">3</span> |
| michael@0 | 224 | <span class="go">True</span> |
| michael@0 | 225 | <span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">MagicMock</span><span class="p">()</span> |
| michael@0 | 226 | <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> |
| michael@0 | 227 | <span class="gp">>>> </span><span class="n">mock</span> <span class="o">==</span> <span class="mi">3</span> |
| michael@0 | 228 | <span class="go">True</span> |
| michael@0 | 229 | </pre></div> |
| michael@0 | 230 | </div> |
| michael@0 | 231 | <p>In <cite>0.8</cite> the <cite>__iter__</cite> also gained special handling implemented with a |
| michael@0 | 232 | side effect. The return value of <cite>MagicMock.__iter__</cite> can be any iterable |
| michael@0 | 233 | object and isn’t required to be an iterator:</p> |
| michael@0 | 234 | <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> |
| michael@0 | 235 | <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> |
| michael@0 | 236 | <span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 237 | <span class="go">['a', 'b', 'c']</span> |
| michael@0 | 238 | <span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 239 | <span class="go">['a', 'b', 'c']</span> |
| michael@0 | 240 | </pre></div> |
| michael@0 | 241 | </div> |
| michael@0 | 242 | <p>If the return value <em>is</em> an iterator, then iterating over it once will consume |
| michael@0 | 243 | it and subsequent iterations will result in an empty list:</p> |
| michael@0 | 244 | <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> |
| michael@0 | 245 | <span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 246 | <span class="go">['a', 'b', 'c']</span> |
| michael@0 | 247 | <span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 248 | <span class="go">[]</span> |
| michael@0 | 249 | </pre></div> |
| michael@0 | 250 | </div> |
| michael@0 | 251 | <p><tt class="docutils literal"><span class="pre">MagicMock</span></tt> has all of the supported magic methods configured except for some |
| michael@0 | 252 | of the obscure and obsolete ones. You can still set these up if you want.</p> |
| michael@0 | 253 | <p>Magic methods that are supported but not setup by default in <tt class="docutils literal"><span class="pre">MagicMock</span></tt> are:</p> |
| michael@0 | 254 | <ul class="simple"> |
| michael@0 | 255 | <li><tt class="docutils literal"><span class="pre">__cmp__</span></tt></li> |
| michael@0 | 256 | <li><tt class="docutils literal"><span class="pre">__getslice__</span></tt> and <tt class="docutils literal"><span class="pre">__setslice__</span></tt></li> |
| michael@0 | 257 | <li><tt class="docutils literal"><span class="pre">__coerce__</span></tt></li> |
| michael@0 | 258 | <li><tt class="docutils literal"><span class="pre">__subclasses__</span></tt></li> |
| michael@0 | 259 | <li><tt class="docutils literal"><span class="pre">__dir__</span></tt></li> |
| michael@0 | 260 | <li><tt class="docutils literal"><span class="pre">__format__</span></tt></li> |
| michael@0 | 261 | <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> |
| michael@0 | 262 | <li><tt class="docutils literal"><span class="pre">__reversed__</span></tt> and <tt class="docutils literal"><span class="pre">__missing__</span></tt></li> |
| michael@0 | 263 | <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>, |
| michael@0 | 264 | <tt class="docutils literal"><span class="pre">__getstate__</span></tt> and <tt class="docutils literal"><span class="pre">__setstate__</span></tt></li> |
| michael@0 | 265 | <li><tt class="docutils literal"><span class="pre">__getformat__</span></tt> and <tt class="docutils literal"><span class="pre">__setformat__</span></tt></li> |
| michael@0 | 266 | </ul> |
| michael@0 | 267 | <hr class="docutils" /> |
| michael@0 | 268 | <table class="docutils footnote" frame="void" id="id4" rules="none"> |
| michael@0 | 269 | <colgroup><col class="label" /><col /></colgroup> |
| michael@0 | 270 | <tbody valign="top"> |
| michael@0 | 271 | <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 |
| michael@0 | 272 | instance. Different versions of Python are inconsistent about applying this |
| michael@0 | 273 | rule. The supported protocol methods should work with all supported versions |
| michael@0 | 274 | of Python.</td></tr> |
| michael@0 | 275 | </tbody> |
| michael@0 | 276 | </table> |
| michael@0 | 277 | <table class="docutils footnote" frame="void" id="id5" rules="none"> |
| michael@0 | 278 | <colgroup><col class="label" /><col /></colgroup> |
| michael@0 | 279 | <tbody valign="top"> |
| michael@0 | 280 | <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> |
| michael@0 | 281 | instance is kept isolated from the others.</td></tr> |
| michael@0 | 282 | </tbody> |
| michael@0 | 283 | </table> |
| michael@0 | 284 | </div> |
| michael@0 | 285 | |
| michael@0 | 286 | |
| michael@0 | 287 | </div> |
| michael@0 | 288 | </div> |
| michael@0 | 289 | </div> |
| michael@0 | 290 | <div class="sphinxsidebar"> |
| michael@0 | 291 | <div class="sphinxsidebarwrapper"> |
| michael@0 | 292 | <h3><a href="index.html">Table Of Contents</a></h3> |
| michael@0 | 293 | <ul> |
| michael@0 | 294 | <li><a class="reference internal" href="#">Mocking Magic Methods</a></li> |
| michael@0 | 295 | <li><a class="reference internal" href="#magic-mock">Magic Mock</a></li> |
| michael@0 | 296 | </ul> |
| michael@0 | 297 | |
| michael@0 | 298 | <h4>Previous topic</h4> |
| michael@0 | 299 | <p class="topless"><a href="sentinel.html" |
| michael@0 | 300 | title="previous chapter">Sentinel</a></p> |
| michael@0 | 301 | <h4>Next topic</h4> |
| michael@0 | 302 | <p class="topless"><a href="getting-started.html" |
| michael@0 | 303 | title="next chapter">Getting Started with Mock</a></p> |
| michael@0 | 304 | <h3>This Page</h3> |
| michael@0 | 305 | <ul class="this-page-menu"> |
| michael@0 | 306 | <li><a href="_sources/magicmock.txt" |
| michael@0 | 307 | rel="nofollow">Show Source</a></li> |
| michael@0 | 308 | </ul> |
| michael@0 | 309 | <div id="searchbox" style="display: none"> |
| michael@0 | 310 | <h3>Quick search</h3> |
| michael@0 | 311 | <form class="search" action="search.html" method="get"> |
| michael@0 | 312 | <input type="text" name="q" /> |
| michael@0 | 313 | <input type="submit" value="Go" /> |
| michael@0 | 314 | <input type="hidden" name="check_keywords" value="yes" /> |
| michael@0 | 315 | <input type="hidden" name="area" value="default" /> |
| michael@0 | 316 | </form> |
| michael@0 | 317 | <p class="searchtip" style="font-size: 90%"> |
| michael@0 | 318 | Enter search terms or a module, class or function name. |
| michael@0 | 319 | </p> |
| michael@0 | 320 | </div> |
| michael@0 | 321 | <script type="text/javascript">$('#searchbox').show(0);</script> |
| michael@0 | 322 | </div> |
| michael@0 | 323 | </div> |
| michael@0 | 324 | <div class="clearer"></div> |
| michael@0 | 325 | </div> |
| michael@0 | 326 | <div class="related"> |
| michael@0 | 327 | <h3>Navigation</h3> |
| michael@0 | 328 | <ul> |
| michael@0 | 329 | <li class="right" style="margin-right: 10px"> |
| michael@0 | 330 | <a href="genindex.html" title="General Index" |
| michael@0 | 331 | >index</a></li> |
| michael@0 | 332 | <li class="right" > |
| michael@0 | 333 | <a href="getting-started.html" title="Getting Started with Mock" |
| michael@0 | 334 | >next</a> |</li> |
| michael@0 | 335 | <li class="right" > |
| michael@0 | 336 | <a href="sentinel.html" title="Sentinel" |
| michael@0 | 337 | >previous</a> |</li> |
| michael@0 | 338 | <li><a href="index.html">Mock 1.0.0 documentation</a> »</li> |
| michael@0 | 339 | </ul> |
| michael@0 | 340 | </div> |
| michael@0 | 341 | <div class="footer"> |
| michael@0 | 342 | © Copyright 2007-2012, Michael Foord & the mock team. |
| michael@0 | 343 | Last updated on Oct 07, 2012. |
| michael@0 | 344 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. |
| michael@0 | 345 | </div> |
| michael@0 | 346 | </body> |
| michael@0 | 347 | </html> |
