The Tor Browser / file comparison
comparison: python/mock-1.0.0/html/mocksignature.html
python/mock-1.0.0/html/mocksignature.html
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
equal
deleted
inserted
replaced
| -1:000000000000 | 0:9a85a400644a |
|---|---|
| 1 | |
| 2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| 3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| 4 | |
| 5 | |
| 6 <html xmlns="http://www.w3.org/1999/xhtml"> | |
| 7 <head> | |
| 8 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 9 | |
| 10 <title>mocksignature — Mock 0.8.1alpha1 documentation</title> | |
| 11 | |
| 12 <link rel="stylesheet" href="_static/nature.css" type="text/css" /> | |
| 13 <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | |
| 14 | |
| 15 <script type="text/javascript"> | |
| 16 var DOCUMENTATION_OPTIONS = { | |
| 17 URL_ROOT: '', | |
| 18 VERSION: '0.8.1alpha1', | |
| 19 COLLAPSE_INDEX: false, | |
| 20 FILE_SUFFIX: '.html', | |
| 21 HAS_SOURCE: true | |
| 22 }; | |
| 23 </script> | |
| 24 <script type="text/javascript" src="_static/jquery.js"></script> | |
| 25 <script type="text/javascript" src="_static/underscore.js"></script> | |
| 26 <script type="text/javascript" src="_static/doctools.js"></script> | |
| 27 <link rel="top" title="Mock 0.8.1alpha1 documentation" href="index.html" /> | |
| 28 <link rel="next" title="Getting Started with Mock" href="getting-started.html" /> | |
| 29 <link rel="prev" title="Mocking Magic Methods" href="magicmock.html" /> | |
| 30 </head> | |
| 31 <body> | |
| 32 <div class="related"> | |
| 33 <h3>Navigation</h3> | |
| 34 <ul> | |
| 35 <li class="right" style="margin-right: 10px"> | |
| 36 <a href="genindex.html" title="General Index" | |
| 37 accesskey="I">index</a></li> | |
| 38 <li class="right" > | |
| 39 <a href="getting-started.html" title="Getting Started with Mock" | |
| 40 accesskey="N">next</a> |</li> | |
| 41 <li class="right" > | |
| 42 <a href="magicmock.html" title="Mocking Magic Methods" | |
| 43 accesskey="P">previous</a> |</li> | |
| 44 <li><a href="index.html">Mock 0.8.1alpha1 documentation</a> »</li> | |
| 45 </ul> | |
| 46 </div> | |
| 47 | |
| 48 <div class="document"> | |
| 49 <div class="documentwrapper"> | |
| 50 <div class="bodywrapper"> | |
| 51 <div class="body"> | |
| 52 | |
| 53 <div class="section" id="mocksignature"> | |
| 54 <h1>mocksignature<a class="headerlink" href="#mocksignature" title="Permalink to this headline">¶</a></h1> | |
| 55 <div class="admonition note"> | |
| 56 <p class="first admonition-title">Note</p> | |
| 57 <p class="last"><a class="reference internal" href="helpers.html#auto-speccing"><em>Autospeccing</em></a>, added in mock 0.8, is a more advanced version of | |
| 58 <cite>mocksignature</cite> and can be used for many of the same use cases.</p> | |
| 59 </div> | |
| 60 <p>A problem with using mock objects to replace real objects in your tests is that | |
| 61 <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> can be <em>too</em> flexible. Your code can treat the mock objects in | |
| 62 any way and you have to manually check that they were called correctly. If your | |
| 63 code calls functions or methods with the wrong number of arguments then mocks | |
| 64 don’t complain.</p> | |
| 65 <p>The solution to this is <cite>mocksignature</cite>, which creates functions with the | |
| 66 same signature as the original, but delegating to a mock. You can interrogate | |
| 67 the mock in the usual way to check it has been called with the <em>right</em> | |
| 68 arguments, but if it is called with the wrong number of arguments it will | |
| 69 raise a <cite>TypeError</cite> in the same way your production code would.</p> | |
| 70 <p>Another advantage is that your mocked objects are real functions, which can | |
| 71 be useful when your code uses | |
| 72 <a class="reference external" href="http://docs.python.org/library/inspect.html">inspect</a> or depends on | |
| 73 functions being function objects.</p> | |
| 74 <dl class="function"> | |
| 75 <dt id="mock.mocksignature"> | |
| 76 <tt class="descname">mocksignature</tt><big>(</big><em>func</em>, <em>mock=None</em>, <em>skipfirst=False</em><big>)</big><a class="headerlink" href="#mock.mocksignature" title="Permalink to this definition">¶</a></dt> | |
| 77 <dd><p>Create a new function with the same signature as <cite>func</cite> that delegates | |
| 78 to <cite>mock</cite>. If <cite>skipfirst</cite> is True the first argument is skipped, useful | |
| 79 for methods where <cite>self</cite> needs to be omitted from the new function.</p> | |
| 80 <p>If you don’t pass in a <cite>mock</cite> then one will be created for you.</p> | |
| 81 <p>Functions returned by <cite>mocksignature</cite> have many of the same attributes | |
| 82 and assert methods as a mock object.</p> | |
| 83 <p>The mock is set as the <cite>mock</cite> attribute of the returned function for easy | |
| 84 access.</p> | |
| 85 <p><cite>mocksignature</cite> can also be used with classes. It copies the signature of | |
| 86 the <cite>__init__</cite> method.</p> | |
| 87 <p>When used with callable objects (instances) it copies the signature of the | |
| 88 <cite>__call__</cite> method.</p> | |
| 89 </dd></dl> | |
| 90 | |
| 91 <p><cite>mocksignature</cite> will work out if it is mocking the signature of a method on | |
| 92 an instance or a method on a class and do the “right thing” with the <cite>self</cite> | |
| 93 argument in both cases.</p> | |
| 94 <p>Because of a limitation in the way that arguments are collected by functions | |
| 95 created by <cite>mocksignature</cite> they are <em>always</em> passed as positional arguments | |
| 96 (including defaults) and not keyword arguments.</p> | |
| 97 <div class="section" id="mocksignature-api"> | |
| 98 <h2>mocksignature api<a class="headerlink" href="#mocksignature-api" title="Permalink to this headline">¶</a></h2> | |
| 99 <p>Although the objects returned by <cite>mocksignature</cite> api are real function objects, | |
| 100 they have much of the same api as the <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> class. This includes the | |
| 101 assert methods:</p> | |
| 102 <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">c</span><span class="p">):</span> | |
| 103 <span class="gp">... </span> <span class="k">pass</span> | |
| 104 <span class="gp">...</span> | |
| 105 <span class="gp">>>> </span><span class="n">func2</span> <span class="o">=</span> <span class="n">mocksignature</span><span class="p">(</span><span class="n">func</span><span class="p">)</span> | |
| 106 <span class="gp">>>> </span><span class="n">func2</span><span class="o">.</span><span class="n">called</span> | |
| 107 <span class="go">False</span> | |
| 108 <span class="gp">>>> </span><span class="n">func2</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="mi">3</span> | |
| 109 <span class="gp">>>> </span><span class="n">func2</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> | |
| 110 <span class="go">3</span> | |
| 111 <span class="gp">>>> </span><span class="n">func2</span><span class="o">.</span><span class="n">called</span> | |
| 112 <span class="go">True</span> | |
| 113 <span class="gp">>>> </span><span class="n">func2</span><span class="o">.</span><span class="n">assert_called_once_with</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> | |
| 114 <span class="gp">>>> </span><span class="n">func2</span><span class="o">.</span><span class="n">assert_called_with</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span> | |
| 115 <span class="gt">Traceback (most recent call last):</span> | |
| 116 <span class="c">...</span> | |
| 117 <span class="gr">AssertionError: Expected call</span>: <span class="n">mock(1, 2, 4)</span> | |
| 118 <span class="go">Actual call: mock(1, 2, 3)</span> | |
| 119 <span class="gp">>>> </span><span class="n">func2</span><span class="o">.</span><span class="n">call_count</span> | |
| 120 <span class="go">1</span> | |
| 121 <span class="gp">>>> </span><span class="n">func2</span><span class="o">.</span><span class="n">side_effect</span> <span class="o">=</span> <span class="ne">IndexError</span> | |
| 122 <span class="gp">>>> </span><span class="n">func2</span><span class="p">(</span><span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">)</span> | |
| 123 <span class="gt">Traceback (most recent call last):</span> | |
| 124 <span class="c">...</span> | |
| 125 <span class="gr">IndexError</span> | |
| 126 </pre></div> | |
| 127 </div> | |
| 128 <p>The mock object that is being delegated to is available as the <cite>mock</cite> attribute | |
| 129 of the function created by <cite>mocksignature</cite>.</p> | |
| 130 <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">func2</span><span class="o">.</span><span class="n">mock</span><span class="o">.</span><span class="n">mock_calls</span> | |
| 131 <span class="go">[call(1, 2, 3), call(4, 5, 6)]</span> | |
| 132 </pre></div> | |
| 133 </div> | |
| 134 <p>The methods and attributes available on functions returned by <cite>mocksignature</cite> | |
| 135 are:</p> | |
| 136 <blockquote> | |
| 137 <div><a class="reference internal" href="mock.html#mock.Mock.assert_any_call" title="mock.Mock.assert_any_call"><tt class="xref py py-meth docutils literal"><span class="pre">assert_any_call()</span></tt></a>, <a class="reference internal" href="mock.html#mock.Mock.assert_called_once_with" title="mock.Mock.assert_called_once_with"><tt class="xref py py-meth docutils literal"><span class="pre">assert_called_once_with()</span></tt></a>, | |
| 138 <a class="reference internal" href="mock.html#mock.Mock.assert_called_with" title="mock.Mock.assert_called_with"><tt class="xref py py-meth docutils literal"><span class="pre">assert_called_with()</span></tt></a>, <a class="reference internal" href="mock.html#mock.Mock.assert_has_calls" title="mock.Mock.assert_has_calls"><tt class="xref py py-meth docutils literal"><span class="pre">assert_has_calls()</span></tt></a>, | |
| 139 <a class="reference internal" href="mock.html#mock.Mock.call_args" title="mock.Mock.call_args"><tt class="xref py py-attr docutils literal"><span class="pre">call_args</span></tt></a>, <a class="reference internal" href="mock.html#mock.Mock.call_args_list" title="mock.Mock.call_args_list"><tt class="xref py py-attr docutils literal"><span class="pre">call_args_list</span></tt></a>, | |
| 140 <a class="reference internal" href="mock.html#mock.Mock.call_count" title="mock.Mock.call_count"><tt class="xref py py-attr docutils literal"><span class="pre">call_count</span></tt></a>, <a class="reference internal" href="mock.html#mock.Mock.called" title="mock.Mock.called"><tt class="xref py py-attr docutils literal"><span class="pre">called</span></tt></a>, | |
| 141 <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>, <cite>mock</cite>, <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>, | |
| 142 <a class="reference internal" href="mock.html#mock.Mock.reset_mock" title="mock.Mock.reset_mock"><tt class="xref py py-meth docutils literal"><span class="pre">reset_mock()</span></tt></a>, <a class="reference internal" href="mock.html#mock.Mock.return_value" title="mock.Mock.return_value"><tt class="xref py py-attr docutils literal"><span class="pre">return_value</span></tt></a>, and | |
| 143 <a class="reference internal" href="mock.html#mock.Mock.side_effect" title="mock.Mock.side_effect"><tt class="xref py py-attr docutils literal"><span class="pre">side_effect</span></tt></a>.</div></blockquote> | |
| 144 </div> | |
| 145 <div class="section" id="example-use"> | |
| 146 <h2>Example use<a class="headerlink" href="#example-use" title="Permalink to this headline">¶</a></h2> | |
| 147 <div class="section" id="basic-use"> | |
| 148 <h3>Basic use<a class="headerlink" href="#basic-use" title="Permalink to this headline">¶</a></h3> | |
| 149 <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">def</span> <span class="nf">function</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> | |
| 150 <span class="gp">... </span> <span class="k">pass</span> | |
| 151 <span class="gp">...</span> | |
| 152 <span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span> | |
| 153 <span class="gp">>>> </span><span class="n">function</span> <span class="o">=</span> <span class="n">mocksignature</span><span class="p">(</span><span class="n">function</span><span class="p">,</span> <span class="n">mock</span><span class="p">)</span> | |
| 154 <span class="gp">>>> </span><span class="n">function</span><span class="p">()</span> | |
| 155 <span class="gt">Traceback (most recent call last):</span> | |
| 156 <span class="c">...</span> | |
| 157 <span class="gr">TypeError</span>: <span class="n"><lambda>() takes at least 2 arguments (0 given)</span> | |
| 158 <span class="gp">>>> </span><span class="n">function</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="s">'some value'</span> | |
| 159 <span class="gp">>>> </span><span class="n">function</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="s">'foo'</span><span class="p">)</span> | |
| 160 <span class="go">'some value'</span> | |
| 161 <span class="gp">>>> </span><span class="n">function</span><span class="o">.</span><span class="n">assert_called_with</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="s">'foo'</span><span class="p">)</span> | |
| 162 </pre></div> | |
| 163 </div> | |
| 164 </div> | |
| 165 <div class="section" id="keyword-arguments"> | |
| 166 <h3>Keyword arguments<a class="headerlink" href="#keyword-arguments" title="Permalink to this headline">¶</a></h3> | |
| 167 <p>Note that arguments to functions created by <cite>mocksignature</cite> are always passed | |
| 168 in to the underlying mock by position even when called with keywords:</p> | |
| 169 <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">def</span> <span class="nf">function</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> | |
| 170 <span class="gp">... </span> <span class="k">pass</span> | |
| 171 <span class="gp">...</span> | |
| 172 <span class="gp">>>> </span><span class="n">function</span> <span class="o">=</span> <span class="n">mocksignature</span><span class="p">(</span><span class="n">function</span><span class="p">)</span> | |
| 173 <span class="gp">>>> </span><span class="n">function</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="bp">None</span> | |
| 174 <span class="gp">>>> </span><span class="n">function</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> | |
| 175 <span class="gp">>>> </span><span class="n">function</span><span class="o">.</span><span class="n">assert_called_with</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span> | |
| 176 </pre></div> | |
| 177 </div> | |
| 178 </div> | |
| 179 <div class="section" id="mocking-methods-and-self"> | |
| 180 <h3>Mocking methods and self<a class="headerlink" href="#mocking-methods-and-self" title="Permalink to this headline">¶</a></h3> | |
| 181 <p>When you use <cite>mocksignature</cite> to replace a method on a class then <cite>self</cite> | |
| 182 will be included in the method signature - and you will need to include | |
| 183 the instance when you do your asserts.</p> | |
| 184 <p>As a curious factor of the way Python (2) wraps methods fetched from a class, | |
| 185 we can <em>get</em> the <cite>return_value</cite> from a function set on a class, but we can’t | |
| 186 set it. We have to do this through the exposed <cite>mock</cite> attribute instead:</p> | |
| 187 <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">class</span> <span class="nc">SomeClass</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> | |
| 188 <span class="gp">... </span> <span class="k">def</span> <span class="nf">method</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> | |
| 189 <span class="gp">... </span> <span class="k">pass</span> | |
| 190 <span class="gp">...</span> | |
| 191 <span class="gp">>>> </span><span class="n">SomeClass</span><span class="o">.</span><span class="n">method</span> <span class="o">=</span> <span class="n">mocksignature</span><span class="p">(</span><span class="n">SomeClass</span><span class="o">.</span><span class="n">method</span><span class="p">)</span> | |
| 192 <span class="gp">>>> </span><span class="n">SomeClass</span><span class="o">.</span><span class="n">method</span><span class="o">.</span><span class="n">mock</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="bp">None</span> | |
| 193 <span class="gp">>>> </span><span class="n">instance</span> <span class="o">=</span> <span class="n">SomeClass</span><span class="p">()</span> | |
| 194 <span class="gp">>>> </span><span class="n">instance</span><span class="o">.</span><span class="n">method</span><span class="p">()</span> | |
| 195 <span class="gt">Traceback (most recent call last):</span> | |
| 196 <span class="c">...</span> | |
| 197 <span class="gr">TypeError</span>: <span class="n"><lambda>() takes at least 4 arguments (1 given)</span> | |
| 198 <span class="gp">>>> </span><span class="n">instance</span><span class="o">.</span><span class="n">method</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> | |
| 199 <span class="gp">>>> </span><span class="n">instance</span><span class="o">.</span><span class="n">method</span><span class="o">.</span><span class="n">assert_called_with</span><span class="p">(</span><span class="n">instance</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> | |
| 200 </pre></div> | |
| 201 </div> | |
| 202 <p>When you use <cite>mocksignature</cite> on instance methods <cite>self</cite> isn’t included (and we | |
| 203 can set the <cite>return_value</cite> etc directly):</p> | |
| 204 <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">class</span> <span class="nc">SomeClass</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> | |
| 205 <span class="gp">... </span> <span class="k">def</span> <span class="nf">method</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> | |
| 206 <span class="gp">... </span> <span class="k">pass</span> | |
| 207 <span class="gp">...</span> | |
| 208 <span class="gp">>>> </span><span class="n">instance</span> <span class="o">=</span> <span class="n">SomeClass</span><span class="p">()</span> | |
| 209 <span class="gp">>>> </span><span class="n">instance</span><span class="o">.</span><span class="n">method</span> <span class="o">=</span> <span class="n">mocksignature</span><span class="p">(</span><span class="n">instance</span><span class="o">.</span><span class="n">method</span><span class="p">)</span> | |
| 210 <span class="gp">>>> </span><span class="n">instance</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="bp">None</span> | |
| 211 <span class="gp">>>> </span><span class="n">instance</span><span class="o">.</span><span class="n">method</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> | |
| 212 <span class="gp">>>> </span><span class="n">instance</span><span class="o">.</span><span class="n">method</span><span class="o">.</span><span class="n">assert_called_with</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> | |
| 213 </pre></div> | |
| 214 </div> | |
| 215 </div> | |
| 216 <div class="section" id="mocksignature-with-classes"> | |
| 217 <h3>mocksignature with classes<a class="headerlink" href="#mocksignature-with-classes" title="Permalink to this headline">¶</a></h3> | |
| 218 <p>When used with a class <cite>mocksignature</cite> copies the signature of the <cite>__init__</cite> | |
| 219 method.</p> | |
| 220 <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">class</span> <span class="nc">Something</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> | |
| 221 <span class="gp">... </span> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">foo</span><span class="p">,</span> <span class="n">bar</span><span class="p">):</span> | |
| 222 <span class="gp">... </span> <span class="k">pass</span> | |
| 223 <span class="gp">...</span> | |
| 224 <span class="gp">>>> </span><span class="n">MockSomething</span> <span class="o">=</span> <span class="n">mocksignature</span><span class="p">(</span><span class="n">Something</span><span class="p">)</span> | |
| 225 <span class="gp">>>> </span><span class="n">instance</span> <span class="o">=</span> <span class="n">MockSomething</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mi">9</span><span class="p">)</span> | |
| 226 <span class="gp">>>> </span><span class="k">assert</span> <span class="n">instance</span> <span class="ow">is</span> <span class="n">MockSomething</span><span class="o">.</span><span class="n">return_value</span> | |
| 227 <span class="gp">>>> </span><span class="n">MockSomething</span><span class="o">.</span><span class="n">assert_called_with</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mi">9</span><span class="p">)</span> | |
| 228 <span class="gp">>>> </span><span class="n">MockSomething</span><span class="p">()</span> | |
| 229 <span class="gt">Traceback (most recent call last):</span> | |
| 230 <span class="c">...</span> | |
| 231 <span class="gr">TypeError</span>: <span class="n"><lambda>() takes at least 2 arguments (0 given)</span> | |
| 232 </pre></div> | |
| 233 </div> | |
| 234 <p>Because the object returned by <cite>mocksignature</cite> is a function rather than a | |
| 235 <cite>Mock</cite> you lose the other capabilities of <cite>Mock</cite>, like dynamic attribute | |
| 236 creation.</p> | |
| 237 </div> | |
| 238 <div class="section" id="mocksignature-with-callable-objects"> | |
| 239 <h3>mocksignature with callable objects<a class="headerlink" href="#mocksignature-with-callable-objects" title="Permalink to this headline">¶</a></h3> | |
| 240 <p>When used with a callable object <cite>mocksignature</cite> copies the signature of the | |
| 241 <cite>__call__</cite> method.</p> | |
| 242 <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">class</span> <span class="nc">Something</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> | |
| 243 <span class="gp">... </span> <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">spam</span><span class="p">,</span> <span class="n">eggs</span><span class="p">):</span> | |
| 244 <span class="gp">... </span> <span class="k">pass</span> | |
| 245 <span class="gp">...</span> | |
| 246 <span class="gp">>>> </span><span class="n">something</span> <span class="o">=</span> <span class="n">Something</span><span class="p">()</span> | |
| 247 <span class="gp">>>> </span><span class="n">mock_something</span> <span class="o">=</span> <span class="n">mocksignature</span><span class="p">(</span><span class="n">something</span><span class="p">)</span> | |
| 248 <span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">mock_something</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mi">9</span><span class="p">)</span> | |
| 249 <span class="gp">>>> </span><span class="n">mock_something</span><span class="o">.</span><span class="n">assert_called_with</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mi">9</span><span class="p">)</span> | |
| 250 <span class="gp">>>> </span><span class="n">mock_something</span><span class="p">()</span> | |
| 251 <span class="gt">Traceback (most recent call last):</span> | |
| 252 <span class="c">...</span> | |
| 253 <span class="gr">TypeError</span>: <span class="n"><lambda>() takes at least 2 arguments (0 given)</span> | |
| 254 </pre></div> | |
| 255 </div> | |
| 256 </div> | |
| 257 </div> | |
| 258 <div class="section" id="mocksignature-argument-to-patch"> | |
| 259 <h2>mocksignature argument to patch<a class="headerlink" href="#mocksignature-argument-to-patch" title="Permalink to this headline">¶</a></h2> | |
| 260 <p><cite>mocksignature</cite> is available as a keyword argument to <a class="reference internal" href="patch.html#mock.patch" title="mock.patch"><tt class="xref py py-func docutils literal"><span class="pre">patch()</span></tt></a> or | |
| 261 <a class="reference internal" href="patch.html#mock.patch.object" title="mock.patch.object"><tt class="xref py py-func docutils literal"><span class="pre">patch.object()</span></tt></a>. It can be used with functions / methods / classes and | |
| 262 callable objects.</p> | |
| 263 <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">class</span> <span class="nc">SomeClass</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> | |
| 264 <span class="gp">... </span> <span class="k">def</span> <span class="nf">method</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> | |
| 265 <span class="gp">... </span> <span class="k">pass</span> | |
| 266 <span class="gp">...</span> | |
| 267 <span class="gp">>>> </span><span class="nd">@patch.object</span><span class="p">(</span><span class="n">SomeClass</span><span class="p">,</span> <span class="s">'method'</span><span class="p">,</span> <span class="n">mocksignature</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span> | |
| 268 <span class="gp">... </span><span class="k">def</span> <span class="nf">test</span><span class="p">(</span><span class="n">mock_method</span><span class="p">):</span> | |
| 269 <span class="gp">... </span> <span class="n">instance</span> <span class="o">=</span> <span class="n">SomeClass</span><span class="p">()</span> | |
| 270 <span class="gp">... </span> <span class="n">mock_method</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="bp">None</span> | |
| 271 <span class="gp">... </span> <span class="n">instance</span><span class="o">.</span><span class="n">method</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> | |
| 272 <span class="gp">... </span> <span class="n">mock_method</span><span class="o">.</span><span class="n">assert_called_with</span><span class="p">(</span><span class="n">instance</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span> | |
| 273 <span class="gp">...</span> | |
| 274 <span class="gp">>>> </span><span class="n">test</span><span class="p">()</span> | |
| 275 </pre></div> | |
| 276 </div> | |
| 277 </div> | |
| 278 </div> | |
| 279 | |
| 280 | |
| 281 </div> | |
| 282 </div> | |
| 283 </div> | |
| 284 <div class="sphinxsidebar"> | |
| 285 <div class="sphinxsidebarwrapper"> | |
| 286 <h3><a href="index.html">Table Of Contents</a></h3> | |
| 287 <ul> | |
| 288 <li><a class="reference internal" href="#">mocksignature</a><ul> | |
| 289 <li><a class="reference internal" href="#mocksignature-api">mocksignature api</a></li> | |
| 290 <li><a class="reference internal" href="#example-use">Example use</a><ul> | |
| 291 <li><a class="reference internal" href="#basic-use">Basic use</a></li> | |
| 292 <li><a class="reference internal" href="#keyword-arguments">Keyword arguments</a></li> | |
| 293 <li><a class="reference internal" href="#mocking-methods-and-self">Mocking methods and self</a></li> | |
| 294 <li><a class="reference internal" href="#mocksignature-with-classes">mocksignature with classes</a></li> | |
| 295 <li><a class="reference internal" href="#mocksignature-with-callable-objects">mocksignature with callable objects</a></li> | |
| 296 </ul> | |
| 297 </li> | |
| 298 <li><a class="reference internal" href="#mocksignature-argument-to-patch">mocksignature argument to patch</a></li> | |
| 299 </ul> | |
| 300 </li> | |
| 301 </ul> | |
| 302 | |
| 303 <h4>Previous topic</h4> | |
| 304 <p class="topless"><a href="magicmock.html" | |
| 305 title="previous chapter">Mocking Magic Methods</a></p> | |
| 306 <h4>Next topic</h4> | |
| 307 <p class="topless"><a href="getting-started.html" | |
| 308 title="next chapter">Getting Started with Mock</a></p> | |
| 309 <h3>This Page</h3> | |
| 310 <ul class="this-page-menu"> | |
| 311 <li><a href="_sources/mocksignature.txt" | |
| 312 rel="nofollow">Show Source</a></li> | |
| 313 </ul> | |
| 314 <div id="searchbox" style="display: none"> | |
| 315 <h3>Quick search</h3> | |
| 316 <form class="search" action="search.html" method="get"> | |
| 317 <input type="text" name="q" /> | |
| 318 <input type="submit" value="Go" /> | |
| 319 <input type="hidden" name="check_keywords" value="yes" /> | |
| 320 <input type="hidden" name="area" value="default" /> | |
| 321 </form> | |
| 322 <p class="searchtip" style="font-size: 90%"> | |
| 323 Enter search terms or a module, class or function name. | |
| 324 </p> | |
| 325 </div> | |
| 326 <script type="text/javascript">$('#searchbox').show(0);</script> | |
| 327 </div> | |
| 328 </div> | |
| 329 <div class="clearer"></div> | |
| 330 </div> | |
| 331 <div class="related"> | |
| 332 <h3>Navigation</h3> | |
| 333 <ul> | |
| 334 <li class="right" style="margin-right: 10px"> | |
| 335 <a href="genindex.html" title="General Index" | |
| 336 >index</a></li> | |
| 337 <li class="right" > | |
| 338 <a href="getting-started.html" title="Getting Started with Mock" | |
| 339 >next</a> |</li> | |
| 340 <li class="right" > | |
| 341 <a href="magicmock.html" title="Mocking Magic Methods" | |
| 342 >previous</a> |</li> | |
| 343 <li><a href="index.html">Mock 0.8.1alpha1 documentation</a> »</li> | |
| 344 </ul> | |
| 345 </div> | |
| 346 <div class="footer"> | |
| 347 © Copyright 2007-2012, Michael Foord & the mock team. | |
| 348 Last updated on Feb 16, 2012. | |
| 349 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2. | |
| 350 </div> | |
| 351 </body> | |
| 352 </html> |
