parthtamu/rag-code-assistant
0
1<!DOCTYPE html>2 3<html lang="en" data-content_root="../">4 <head>5 <meta charset="utf-8" />6 <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />7<meta property="og:title" content="unittest.mock — mock object library" />8<meta property="og:type" content="website" />9<meta property="og:url" content="https://docs.python.org/3/library/unittest.mock.html" />10<meta property="og:site_name" content="Python documentation" />11<meta property="og:description" content="Source code: Lib/unittest/mock.py unittest.mock is a library for testing in Python. It allows you to replace parts of your system under test with mock objects and make assertions about how they hav..." />12<meta property="og:image:width" content="1146" />13<meta property="og:image:height" content="600" />14<meta property="og:image" content="https://docs.python.org/3.15/_images/social_previews/summary_library_unittest.mock_4002ab0a.png" />15<meta property="og:image:alt" content="Source code: Lib/unittest/mock.py unittest.mock is a library for testing in Python. It allows you to replace parts of your system under test with mock objects and make assertions about how they hav..." />16<meta name="description" content="Source code: Lib/unittest/mock.py unittest.mock is a library for testing in Python. It allows you to replace parts of your system under test with mock objects and make assertions about how they hav..." />17<meta name="twitter:card" content="summary_large_image" />18<meta name="theme-color" content="#3776ab">19 20 <title>unittest.mock — mock object library — Python 3.15.0a6 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">21 22 <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />23 <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=234b1a7c" />24 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=89a2f22a" />25 <link rel="stylesheet" type="text/css" href="../_static/profiling-sampling-visualization.css?v=0c2600ae" />26 <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=5349f25f" />27 28 <script src="../_static/documentation_options.js?v=6b7c9ff5"></script>29 <script src="../_static/doctools.js?v=9bcbadda"></script>30 <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>31 <script src="../_static/profiling-sampling-visualization.js?v=9811ed04"></script>32 33 <script src="../_static/sidebar.js"></script>34 35 <link rel="search" type="application/opensearchdescription+xml"36 title="Search within Python 3.15.0a6 documentation"37 href="../_static/opensearch.xml"/>38 <link rel="author" title="About these documents" href="../about.html" />39 <link rel="index" title="Index" href="../genindex.html" />40 <link rel="search" title="Search" href="../search.html" />41 <link rel="copyright" title="Copyright" href="../copyright.html" />42 <link rel="next" title="unittest.mock — getting started" href="unittest.mock-examples.html" />43 <link rel="prev" title="unittest — Unit testing framework" href="unittest.html" />44 45 46 <script defer file-types="bz2,epub,zip" data-domain="docs.python.org" src="https://analytics.python.org/js/script.file-downloads.outbound-links.js"></script>47 48 <link rel="canonical" href="https://docs.python.org/3/library/unittest.mock.html">49 50 51 52 53 <style>54 @media only screen {55 table.full-width-table {56 width: 100%;57 }58 }59 </style>60<link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">61 <link rel="shortcut icon" type="image/png" href="../_static/py.svg">62 <script type="text/javascript" src="../_static/copybutton.js"></script>63 <script type="text/javascript" src="../_static/menu.js"></script>64 <script type="text/javascript" src="../_static/search-focus.js"></script>65 <script type="text/javascript" src="../_static/themetoggle.js"></script> 66 <script type="text/javascript" src="../_static/rtd_switcher.js"></script>67 <meta name="readthedocs-addons-api-version" content="1">68 69 </head>70<body>71<div class="mobile-nav">72 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"73 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">74 <nav class="nav-content" role="navigation">75 <label for="menuToggler" class="toggler__label">76 <span></span>77 </label>78 <span class="nav-items-wrapper">79 <a href="https://www.python.org/" class="nav-logo">80 <img src="../_static/py.svg" alt="Python logo">81 </a>82 <span class="version_switcher_placeholder"></span>83 <form role="search" class="search" action="../search.html" method="get">84 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">85 <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>86 </svg>87 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q">88 <input type="submit" value="Go">89 </form>90 </span>91 </nav>92 <div class="menu-wrapper">93 <nav class="menu" role="navigation" aria-label="main navigation">94 <div class="language_switcher_placeholder"></div>95 96<label class="theme-selector-label">97 Theme98 <select class="theme-selector" oninput="activateTheme(this.value)">99 <option value="auto" selected>Auto</option>100 <option value="light">Light</option>101 <option value="dark">Dark</option>102 </select>103</label>104 <div>105 <h3><a href="../contents.html">Table of Contents</a></h3>106 <ul>107<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">unittest.mock</span></code> — mock object library</a><ul>108<li><a class="reference internal" href="#quick-guide">Quick Guide</a></li>109<li><a class="reference internal" href="#the-mock-class">The Mock Class</a><ul>110<li><a class="reference internal" href="#calling">Calling</a></li>111<li><a class="reference internal" href="#deleting-attributes">Deleting Attributes</a></li>112<li><a class="reference internal" href="#mock-names-and-the-name-attribute">Mock names and the name attribute</a></li>113<li><a class="reference internal" href="#attaching-mocks-as-attributes">Attaching Mocks as Attributes</a></li>114</ul>115</li>116<li><a class="reference internal" href="#the-patchers">The patchers</a><ul>117<li><a class="reference internal" href="#patch">patch</a></li>118<li><a class="reference internal" href="#patch-object">patch.object</a></li>119<li><a class="reference internal" href="#patch-dict">patch.dict</a></li>120<li><a class="reference internal" href="#patch-multiple">patch.multiple</a></li>121<li><a class="reference internal" href="#patch-methods-start-and-stop">patch methods: start and stop</a></li>122<li><a class="reference internal" href="#patch-builtins">patch builtins</a></li>123<li><a class="reference internal" href="#test-prefix">TEST_PREFIX</a></li>124<li><a class="reference internal" href="#nesting-patch-decorators">Nesting Patch Decorators</a></li>125<li><a class="reference internal" href="#where-to-patch">Where to patch</a></li>126<li><a class="reference internal" href="#patching-descriptors-and-proxy-objects">Patching Descriptors and Proxy Objects</a></li>127</ul>128</li>129<li><a class="reference internal" href="#magicmock-and-magic-method-support">MagicMock and magic method support</a><ul>130<li><a class="reference internal" href="#mocking-magic-methods">Mocking Magic Methods</a></li>131<li><a class="reference internal" href="#magic-mock">Magic Mock</a></li>132</ul>133</li>134<li><a class="reference internal" href="#helpers">Helpers</a><ul>135<li><a class="reference internal" href="#sentinel">sentinel</a></li>136<li><a class="reference internal" href="#default">DEFAULT</a></li>137<li><a class="reference internal" href="#call">call</a></li>138<li><a class="reference internal" href="#create-autospec">create_autospec</a></li>139<li><a class="reference internal" href="#any">ANY</a></li>140<li><a class="reference internal" href="#filter-dir">FILTER_DIR</a></li>141<li><a class="reference internal" href="#mock-open">mock_open</a></li>142<li><a class="reference internal" href="#autospeccing">Autospeccing</a></li>143<li><a class="reference internal" href="#sealing-mocks">Sealing mocks</a></li>144</ul>145</li>146<li><a class="reference internal" href="#order-of-precedence-of-side-effect-return-value-and-wraps">Order of precedence of <code class="xref py py-attr docutils literal notranslate"><span class="pre">side_effect</span></code>, <code class="xref py py-attr docutils literal notranslate"><span class="pre">return_value</span></code> and <em>wraps</em></a></li>147</ul>148</li>149</ul>150 151 </div>152 <div>153 <h4>Previous topic</h4>154 <p class="topless"><a href="unittest.html"155 title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">unittest</span></code> — Unit testing framework</a></p>156 </div>157 <div>158 <h4>Next topic</h4>159 <p class="topless"><a href="unittest.mock-examples.html"160 title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">unittest.mock</span></code> — getting started</a></p>161 </div>162 <script>163 document.addEventListener('DOMContentLoaded', () => {164 const title = document.querySelector('meta[property="og:title"]').content;165 const elements = document.querySelectorAll('.improvepage');166 const pageurl = window.location.href.split('?')[0];167 elements.forEach(element => {168 const url = new URL(element.href.split('?')[0].replace("-nojs", ""));169 url.searchParams.set('pagetitle', title);170 url.searchParams.set('pageurl', pageurl);171 url.searchParams.set('pagesource', "library/unittest.mock.rst");172 element.href = url.toString();173 });174 });175 </script>176 <div role="note" aria-label="source link">177 <h3>This page</h3>178 <ul class="this-page-menu">179 <li><a href="../bugs.html">Report a bug</a></li>180 <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>181 <li>182 <a href="https://github.com/python/cpython/blob/main/Doc/library/unittest.mock.rst?plain=1"183 rel="nofollow">Show source184 </a>185 </li>186 187 </ul>188 </div>189 </nav>190 </div>191</div>192 193 194 <div class="related" role="navigation" aria-label="Related">195 <h3>Navigation</h3>196 <ul>197 <li class="right" style="margin-right: 10px">198 <a href="../genindex.html" title="General Index"199 accesskey="I">index</a></li>200 <li class="right" >201 <a href="../py-modindex.html" title="Python Module Index"202 >modules</a> |</li>203 <li class="right" >204 <a href="unittest.mock-examples.html" title="unittest.mock — getting started"205 accesskey="N">next</a> |</li>206 <li class="right" >207 <a href="unittest.html" title="unittest — Unit testing framework"208 accesskey="P">previous</a> |</li>209 210 <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>211 <li><a href="https://www.python.org/">Python</a> »</li>212 <li class="switchers">213 <div class="language_switcher_placeholder"></div>214 <div class="version_switcher_placeholder"></div>215 </li>216 <li>217 218 </li>219 <li id="cpython-language-and-version">220 <a href="../index.html">3.15.0a6 Documentation</a> »221 </li>222 223 <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>224 <li class="nav-item nav-item-2"><a href="development.html" accesskey="U">Development Tools</a> »</li>225 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">unittest.mock</span></code> — mock object library</a></li>226 <li class="right">227 228 229 <div class="inline-search" role="search">230 <form class="inline-search" action="../search.html" method="get">231 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">232 <input type="submit" value="Go">233 </form>234 </div>235 |236 </li>237 <li class="right">238<label class="theme-selector-label">239 Theme240 <select class="theme-selector" oninput="activateTheme(this.value)">241 <option value="auto" selected>Auto</option>242 <option value="light">Light</option>243 <option value="dark">Dark</option>244 </select>245</label> |</li>246 247 </ul>248 </div> 249 250 <div class="document">251 <div class="documentwrapper">252 <div class="bodywrapper">253 <div class="body" role="main">254 255 <section id="module-unittest.mock">256<span id="unittest-mock-mock-object-library"></span><h1><code class="xref py py-mod docutils literal notranslate"><span class="pre">unittest.mock</span></code> — mock object library<a class="headerlink" href="#module-unittest.mock" title="Link to this heading">¶</a></h1>257<div class="versionadded">258<p><span class="versionmodified added">Added in version 3.3.</span></p>259</div>260<p><strong>Source code:</strong> <a class="extlink-source reference external" href="https://github.com/python/cpython/tree/main/Lib/unittest/mock.py">Lib/unittest/mock.py</a></p>261<hr class="docutils" />262<p><code class="xref py py-mod docutils literal notranslate"><span class="pre">unittest.mock</span></code> is a library for testing in Python. It allows you to263replace parts of your system under test with mock objects and make assertions264about how they have been used.</p>265<p><code class="xref py py-mod docutils literal notranslate"><span class="pre">unittest.mock</span></code> provides a core <a class="reference internal" href="#unittest.mock.Mock" title="unittest.mock.Mock"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code></a> class removing the need to266create a host of stubs throughout your test suite. After performing an267action, you can make assertions about which methods / attributes were used268and arguments they were called with. You can also specify return values and269set needed attributes in the normal way.</p>270<p>Additionally, mock provides a <a class="reference internal" href="#unittest.mock.patch" title="unittest.mock.patch"><code class="xref py py-func docutils literal notranslate"><span class="pre">patch()</span></code></a> decorator that handles patching271module and class level attributes within the scope of a test, along with272<a class="reference internal" href="#unittest.mock.sentinel" title="unittest.mock.sentinel"><code class="xref py py-const docutils literal notranslate"><span class="pre">sentinel</span></code></a> for creating unique objects. See the <a class="reference internal" href="#quick-guide">quick guide</a> for273some examples of how to use <a class="reference internal" href="#unittest.mock.Mock" title="unittest.mock.Mock"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code></a>, <a class="reference internal" href="#unittest.mock.MagicMock" title="unittest.mock.MagicMock"><code class="xref py py-class docutils literal notranslate"><span class="pre">MagicMock</span></code></a> and274<code class="xref py py-func docutils literal notranslate"><span class="pre">patch()</span></code>.</p>275<p>Mock is designed for use with <a class="reference internal" href="unittest.html#module-unittest" title="unittest: Unit testing framework for Python."><code class="xref py py-mod docutils literal notranslate"><span class="pre">unittest</span></code></a> and276is based on the ‘action -> assertion’ pattern instead of ‘record -> replay’277used by many mocking frameworks.</p>278<p>There is a backport of <code class="xref py py-mod docutils literal notranslate"><span class="pre">unittest.mock</span></code> for earlier versions of Python,279available as <a class="extlink-pypi reference external" href="https://pypi.org/project/mock/">mock</a> on PyPI.</p>280<section id="quick-guide">281<h2>Quick Guide<a class="headerlink" href="#quick-guide" title="Link to this heading">¶</a></h2>282<p><a class="reference internal" href="#unittest.mock.Mock" title="unittest.mock.Mock"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code></a> and <a class="reference internal" href="#unittest.mock.MagicMock" title="unittest.mock.MagicMock"><code class="xref py py-class docutils literal notranslate"><span class="pre">MagicMock</span></code></a> objects create all attributes and283methods as you access them and store details of how they have been used. You284can configure them, to specify return values or limit what attributes are285available, and then make assertions about how they have been used:</p>286<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">unittest.mock</span><span class="w"> </span><span class="kn">import</span> <span class="n">MagicMock</span>287<span class="gp">>>> </span><span class="n">thing</span> <span class="o">=</span> <span class="n">ProductionClass</span><span class="p">()</span>288<span class="gp">>>> </span><span class="n">thing</span><span class="o">.</span><span class="n">method</span> <span class="o">=</span> <span class="n">MagicMock</span><span class="p">(</span><span class="n">return_value</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>289<span class="gp">>>> </span><span class="n">thing</span><span class="o">.</span><span class="n">method</span><span class="p">(</span><span class="mi">3</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="n">key</span><span class="o">=</span><span class="s1">'value'</span><span class="p">)</span>290<span class="go">3</span>291<span class="gp">>>> </span><span class="n">thing</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">3</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="n">key</span><span class="o">=</span><span class="s1">'value'</span><span class="p">)</span>292</pre></div>293</div>294<p><a class="reference internal" href="#unittest.mock.Mock.side_effect" title="unittest.mock.Mock.side_effect"><code class="xref py py-attr docutils literal notranslate"><span class="pre">side_effect</span></code></a> allows you to perform side effects, including raising an295exception when a mock is called:</p>296<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">unittest.mock</span><span class="w"> </span><span class="kn">import</span> <span class="n">Mock</span>297<span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">(</span><span class="n">side_effect</span><span class="o">=</span><span class="ne">KeyError</span><span class="p">(</span><span class="s1">'foo'</span><span class="p">))</span>298<span class="gp">>>> </span><span class="n">mock</span><span class="p">()</span>299<span class="gt">Traceback (most recent call last):</span>300<span class="w"> </span><span class="c">...</span>301<span class="gr">KeyError</span>: <span class="n">'foo'</span>302</pre></div>303</div>304<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">values</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'a'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">'b'</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s1">'c'</span><span class="p">:</span> <span class="mi">3</span><span class="p">}</span>305<span class="gp">>>> </span><span class="k">def</span><span class="w"> </span><span class="nf">side_effect</span><span class="p">(</span><span class="n">arg</span><span class="p">):</span>306<span class="gp">... </span> <span class="k">return</span> <span class="n">values</span><span class="p">[</span><span class="n">arg</span><span class="p">]</span>307<span class="gp">...</span>308<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">side_effect</span> <span class="o">=</span> <span class="n">side_effect</span>309<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="s1">'a'</span><span class="p">),</span> <span class="n">mock</span><span class="p">(</span><span class="s1">'b'</span><span class="p">),</span> <span class="n">mock</span><span class="p">(</span><span class="s1">'c'</span><span class="p">)</span>310<span class="go">(1, 2, 3)</span>311<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">side_effect</span> <span class="o">=</span> <span class="p">[</span><span class="mi">5</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">]</span>312<span class="gp">>>> </span><span class="n">mock</span><span class="p">(),</span> <span class="n">mock</span><span class="p">(),</span> <span class="n">mock</span><span class="p">()</span>313<span class="go">(5, 4, 3)</span>314</pre></div>315</div>316<p>Mock has many other ways you can configure it and control its behaviour. For317example the <em>spec</em> argument configures the mock to take its specification318from another object. Attempting to access attributes or methods on the mock319that don’t exist on the spec will fail with an <a class="reference internal" href="exceptions.html#AttributeError" title="AttributeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AttributeError</span></code></a>.</p>320<p>The <a class="reference internal" href="#unittest.mock.patch" title="unittest.mock.patch"><code class="xref py py-func docutils literal notranslate"><span class="pre">patch()</span></code></a> decorator / context manager makes it easy to mock classes or321objects in a module under test. The object you specify will be replaced with a322mock (or other object) during the test and restored when the test ends:</p>323<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">unittest.mock</span><span class="w"> </span><span class="kn">import</span> <span class="n">patch</span>324<span class="gp">>>> </span><span class="nd">@patch</span><span class="p">(</span><span class="s1">'module.ClassName2'</span><span class="p">)</span>325<span class="gp">... </span><span class="nd">@patch</span><span class="p">(</span><span class="s1">'module.ClassName1'</span><span class="p">)</span>326<span class="gp">... </span><span class="k">def</span><span class="w"> </span><span class="nf">test</span><span class="p">(</span><span class="n">MockClass1</span><span class="p">,</span> <span class="n">MockClass2</span><span class="p">):</span>327<span class="gp">... </span> <span class="n">module</span><span class="o">.</span><span class="n">ClassName1</span><span class="p">()</span>328<span class="gp">... </span> <span class="n">module</span><span class="o">.</span><span class="n">ClassName2</span><span class="p">()</span>329<span class="gp">... </span> <span class="k">assert</span> <span class="n">MockClass1</span> <span class="ow">is</span> <span class="n">module</span><span class="o">.</span><span class="n">ClassName1</span>330<span class="gp">... </span> <span class="k">assert</span> <span class="n">MockClass2</span> <span class="ow">is</span> <span class="n">module</span><span class="o">.</span><span class="n">ClassName2</span>331<span class="gp">... </span> <span class="k">assert</span> <span class="n">MockClass1</span><span class="o">.</span><span class="n">called</span>332<span class="gp">... </span> <span class="k">assert</span> <span class="n">MockClass2</span><span class="o">.</span><span class="n">called</span>333<span class="gp">...</span>334<span class="gp">>>> </span><span class="n">test</span><span class="p">()</span>335</pre></div>336</div>337<div class="admonition note">338<p class="admonition-title">Note</p>339<p>When you nest patch decorators the mocks are passed in to the decorated340function in the same order they applied (the normal <em>Python</em> order that341decorators are applied). This means from the bottom up, so in the example342above the mock for <code class="docutils literal notranslate"><span class="pre">module.ClassName1</span></code> is passed in first.</p>343<p>With <a class="reference internal" href="#unittest.mock.patch" title="unittest.mock.patch"><code class="xref py py-func docutils literal notranslate"><span class="pre">patch()</span></code></a> it matters that you patch objects in the namespace where they344are looked up. This is normally straightforward, but for a quick guide345read <a class="reference internal" href="#where-to-patch"><span class="std std-ref">where to patch</span></a>.</p>346</div>347<p>As well as a decorator <a class="reference internal" href="#unittest.mock.patch" title="unittest.mock.patch"><code class="xref py py-func docutils literal notranslate"><span class="pre">patch()</span></code></a> can be used as a context manager in a with348statement:</p>349<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">with</span> <span class="n">patch</span><span class="o">.</span><span class="n">object</span><span class="p">(</span><span class="n">ProductionClass</span><span class="p">,</span> <span class="s1">'method'</span><span class="p">,</span> <span class="n">return_value</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="k">as</span> <span class="n">mock_method</span><span class="p">:</span>350<span class="gp">... </span> <span class="n">thing</span> <span class="o">=</span> <span class="n">ProductionClass</span><span class="p">()</span>351<span class="gp">... </span> <span class="n">thing</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>352<span class="gp">...</span>353<span class="gp">>>> </span><span class="n">mock_method</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>354</pre></div>355</div>356<p>There is also <a class="reference internal" href="#unittest.mock.patch.dict" title="unittest.mock.patch.dict"><code class="xref py py-func docutils literal notranslate"><span class="pre">patch.dict()</span></code></a> for setting values in a dictionary just357during a scope and restoring the dictionary to its original state when the test358ends:</p>359<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">foo</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'key'</span><span class="p">:</span> <span class="s1">'value'</span><span class="p">}</span>360<span class="gp">>>> </span><span class="n">original</span> <span class="o">=</span> <span class="n">foo</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>361<span class="gp">>>> </span><span class="k">with</span> <span class="n">patch</span><span class="o">.</span><span class="n">dict</span><span class="p">(</span><span class="n">foo</span><span class="p">,</span> <span class="p">{</span><span class="s1">'newkey'</span><span class="p">:</span> <span class="s1">'newvalue'</span><span class="p">},</span> <span class="n">clear</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>362<span class="gp">... </span> <span class="k">assert</span> <span class="n">foo</span> <span class="o">==</span> <span class="p">{</span><span class="s1">'newkey'</span><span class="p">:</span> <span class="s1">'newvalue'</span><span class="p">}</span>363<span class="gp">...</span>364<span class="gp">>>> </span><span class="k">assert</span> <span class="n">foo</span> <span class="o">==</span> <span class="n">original</span>365</pre></div>366</div>367<p>Mock supports the mocking of Python <a class="reference internal" href="#magic-methods"><span class="std std-ref">magic methods</span></a>. The368easiest way of using magic methods is with the <a class="reference internal" href="#unittest.mock.MagicMock" title="unittest.mock.MagicMock"><code class="xref py py-class docutils literal notranslate"><span class="pre">MagicMock</span></code></a> class. It369allows you to do things like:</p>370<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">MagicMock</span><span class="p">()</span>371<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="fm">__str__</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="s1">'foobarbaz'</span>372<span class="gp">>>> </span><span class="nb">str</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span>373<span class="go">'foobarbaz'</span>374<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="fm">__str__</span><span class="o">.</span><span class="n">assert_called_with</span><span class="p">()</span>375</pre></div>376</div>377<p>Mock allows you to assign functions (or other Mock instances) to magic methods378and they will be called appropriately. The <a class="reference internal" href="#unittest.mock.MagicMock" title="unittest.mock.MagicMock"><code class="xref py py-class docutils literal notranslate"><span class="pre">MagicMock</span></code></a> class is just a Mock379variant that has all of the magic methods pre-created for you (well, all the380useful ones anyway).</p>381<p>The following is an example of using magic methods with the ordinary Mock382class:</p>383<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>384<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="fm">__str__</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="s1">'wheeeeee'</span><span class="p">)</span>385<span class="gp">>>> </span><span class="nb">str</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span>386<span class="go">'wheeeeee'</span>387</pre></div>388</div>389<p>For ensuring that the mock objects in your tests have the same api as the390objects they are replacing, you can use <a class="reference internal" href="#auto-speccing"><span class="std std-ref">auto-speccing</span></a>.391Auto-speccing can be done through the <em>autospec</em> argument to patch, or the392<a class="reference internal" href="#unittest.mock.create_autospec" title="unittest.mock.create_autospec"><code class="xref py py-func docutils literal notranslate"><span class="pre">create_autospec()</span></code></a> function. Auto-speccing creates mock objects that393have the same attributes and methods as the objects they are replacing, and394any functions and methods (including constructors) have the same call395signature as the real object.</p>396<p>This ensures that your mocks will fail in the same way as your production397code if they are used incorrectly:</p>398<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">unittest.mock</span><span class="w"> </span><span class="kn">import</span> <span class="n">create_autospec</span>399<span class="gp">>>> </span><span class="k">def</span><span class="w"> </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="p">):</span>400<span class="gp">... </span> <span class="k">pass</span>401<span class="gp">...</span>402<span class="gp">>>> </span><span class="n">mock_function</span> <span class="o">=</span> <span class="n">create_autospec</span><span class="p">(</span><span class="n">function</span><span class="p">,</span> <span class="n">return_value</span><span class="o">=</span><span class="s1">'fishy'</span><span class="p">)</span>403<span class="gp">>>> </span><span class="n">mock_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="mi">3</span><span class="p">)</span>404<span class="go">'fishy'</span>405<span class="gp">>>> </span><span class="n">mock_function</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>406<span class="gp">>>> </span><span class="n">mock_function</span><span class="p">(</span><span class="s1">'wrong arguments'</span><span class="p">)</span>407<span class="gt">Traceback (most recent call last):</span>408<span class="w"> </span><span class="c">...</span>409<span class="gr">TypeError</span>: <span class="n">missing a required argument: 'b'</span>410</pre></div>411</div>412<p><a class="reference internal" href="#unittest.mock.create_autospec" title="unittest.mock.create_autospec"><code class="xref py py-func docutils literal notranslate"><span class="pre">create_autospec()</span></code></a> can also be used on classes, where it copies the signature of413the <code class="docutils literal notranslate"><span class="pre">__init__</span></code> method, and on callable objects where it copies the signature of414the <code class="docutils literal notranslate"><span class="pre">__call__</span></code> method.</p>415</section>416<section id="the-mock-class">417<h2>The Mock Class<a class="headerlink" href="#the-mock-class" title="Link to this heading">¶</a></h2>418<p><a class="reference internal" href="#unittest.mock.Mock" title="unittest.mock.Mock"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code></a> is a flexible mock object intended to replace the use of stubs and419test doubles throughout your code. Mocks are callable and create attributes as420new mocks when you access them <a class="footnote-reference brackets" href="#id3" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>. Accessing the same attribute will always421return the same mock. Mocks record how you use them, allowing you to make422assertions about what your code has done to them.</p>423<p><a class="reference internal" href="#unittest.mock.MagicMock" title="unittest.mock.MagicMock"><code class="xref py py-class docutils literal notranslate"><span class="pre">MagicMock</span></code></a> is a subclass of <a class="reference internal" href="#unittest.mock.Mock" title="unittest.mock.Mock"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code></a> with all the magic methods424pre-created and ready to use. There are also non-callable variants, useful425when you are mocking out objects that aren’t callable:426<a class="reference internal" href="#unittest.mock.NonCallableMock" title="unittest.mock.NonCallableMock"><code class="xref py py-class docutils literal notranslate"><span class="pre">NonCallableMock</span></code></a> and <a class="reference internal" href="#unittest.mock.NonCallableMagicMock" title="unittest.mock.NonCallableMagicMock"><code class="xref py py-class docutils literal notranslate"><span class="pre">NonCallableMagicMock</span></code></a></p>427<p>The <a class="reference internal" href="#unittest.mock.patch" title="unittest.mock.patch"><code class="xref py py-func docutils literal notranslate"><span class="pre">patch()</span></code></a> decorators makes it easy to temporarily replace classes428in a particular module with a <a class="reference internal" href="#unittest.mock.Mock" title="unittest.mock.Mock"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code></a> object. By default <code class="xref py py-func docutils literal notranslate"><span class="pre">patch()</span></code> will create429a <a class="reference internal" href="#unittest.mock.MagicMock" title="unittest.mock.MagicMock"><code class="xref py py-class docutils literal notranslate"><span class="pre">MagicMock</span></code></a> for you. You can specify an alternative class of <code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code> using430the <em>new_callable</em> argument to <code class="xref py py-func docutils literal notranslate"><span class="pre">patch()</span></code>.</p>431<dl class="py class">432<dt class="sig sig-object py" id="unittest.mock.Mock">433<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">unittest.mock.</span></span><span class="sig-name descname"><span class="pre">Mock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">side_effect</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">DEFAULT</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wraps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unsafe</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.Mock" title="Link to this definition">¶</a></dt>434<dd><p>Create a new <code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code> object. <code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code> takes several optional arguments435that specify the behaviour of the Mock object:</p>436<ul>437<li><p><em>spec</em>: This can be either a list of strings or an existing object (a438class or instance) that acts as the specification for the mock object. If439you pass in an object then a list of strings is formed by calling dir on440the object (excluding unsupported magic attributes and methods).441Accessing any attribute not in this list will raise an <a class="reference internal" href="exceptions.html#AttributeError" title="AttributeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AttributeError</span></code></a>.</p>442<p>If <em>spec</em> is an object (rather than a list of strings) then443<a class="reference internal" href="../reference/datamodel.html#object.__class__" title="object.__class__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__class__</span></code></a> returns the class of the spec object. This444allows mocks to pass <a class="reference internal" href="functions.html#isinstance" title="isinstance"><code class="xref py py-func docutils literal notranslate"><span class="pre">isinstance()</span></code></a> tests.</p>445</li>446<li><p><em>spec_set</em>: A stricter variant of <em>spec</em>. If used, attempting to <em>set</em>447or get an attribute on the mock that isn’t on the object passed as448<em>spec_set</em> will raise an <a class="reference internal" href="exceptions.html#AttributeError" title="AttributeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AttributeError</span></code></a>.</p></li>449<li><p><em>side_effect</em>: A function to be called whenever the Mock is called. See450the <a class="reference internal" href="#unittest.mock.Mock.side_effect" title="unittest.mock.Mock.side_effect"><code class="xref py py-attr docutils literal notranslate"><span class="pre">side_effect</span></code></a> attribute. Useful for raising exceptions or451dynamically changing return values. The function is called with the same452arguments as the mock, and unless it returns <a class="reference internal" href="#unittest.mock.DEFAULT" title="unittest.mock.DEFAULT"><code class="xref py py-data docutils literal notranslate"><span class="pre">DEFAULT</span></code></a>, the return453value of this function is used as the return value.</p>454<p>Alternatively <em>side_effect</em> can be an exception class or instance. In455this case the exception will be raised when the mock is called.</p>456<p>If <em>side_effect</em> is an iterable then each call to the mock will return457the next value from the iterable.</p>458<p>A <em>side_effect</em> can be cleared by setting it to <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>459</li>460<li><p><em>return_value</em>: The value returned when the mock is called. By default461this is a new Mock (created on first access). See the462<a class="reference internal" href="#unittest.mock.Mock.return_value" title="unittest.mock.Mock.return_value"><code class="xref py py-attr docutils literal notranslate"><span class="pre">return_value</span></code></a> attribute.</p></li>463<li><p><em>unsafe</em>: By default, accessing any attribute whose name starts with464<em>assert</em>, <em>assret</em>, <em>asert</em>, <em>aseert</em> or <em>assrt</em> will raise an465<a class="reference internal" href="exceptions.html#AttributeError" title="AttributeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AttributeError</span></code></a>. Passing <code class="docutils literal notranslate"><span class="pre">unsafe=True</span></code> will allow access to466these attributes.</p>467<div class="versionadded">468<p><span class="versionmodified added">Added in version 3.5.</span></p>469</div>470</li>471<li><p><em>wraps</em>: Item for the mock object to wrap. If <em>wraps</em> is not <code class="docutils literal notranslate"><span class="pre">None</span></code> then472calling the Mock will pass the call through to the wrapped object473(returning the real result). Attribute access on the mock will return a474Mock object that wraps the corresponding attribute of the wrapped475object (so attempting to access an attribute that doesn’t exist will476raise an <a class="reference internal" href="exceptions.html#AttributeError" title="AttributeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AttributeError</span></code></a>).</p>477<p>If the mock has an explicit <em>return_value</em> set then calls are not passed478to the wrapped object and the <em>return_value</em> is returned instead.</p>479</li>480<li><p><em>name</em>: If the mock has a name then it will be used in the repr of the481mock. This can be useful for debugging. The name is propagated to child482mocks.</p></li>483</ul>484<p>Mocks can also be called with arbitrary keyword arguments. These will be485used to set attributes on the mock after it is created. See the486<a class="reference internal" href="#unittest.mock.Mock.configure_mock" title="unittest.mock.Mock.configure_mock"><code class="xref py py-meth docutils literal notranslate"><span class="pre">configure_mock()</span></code></a> method for details.</p>487<dl class="py method">488<dt class="sig sig-object py" id="unittest.mock.Mock.assert_called">489<span class="sig-name descname"><span class="pre">assert_called</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.Mock.assert_called" title="Link to this definition">¶</a></dt>490<dd><p>Assert that the mock was called at least once.</p>491<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>492<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">method</span><span class="p">()</span>493<span class="go"><Mock name='mock.method()' id='...'></span>494<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">method</span><span class="o">.</span><span class="n">assert_called</span><span class="p">()</span>495</pre></div>496</div>497<div class="versionadded">498<p><span class="versionmodified added">Added in version 3.6.</span></p>499</div>500</dd></dl>501 502<dl class="py method">503<dt class="sig sig-object py" id="unittest.mock.Mock.assert_called_once">504<span class="sig-name descname"><span class="pre">assert_called_once</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.Mock.assert_called_once" title="Link to this definition">¶</a></dt>505<dd><p>Assert that the mock was called exactly once.</p>506<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>507<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">method</span><span class="p">()</span>508<span class="go"><Mock name='mock.method()' id='...'></span>509<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">method</span><span class="o">.</span><span class="n">assert_called_once</span><span class="p">()</span>510<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">method</span><span class="p">()</span>511<span class="go"><Mock name='mock.method()' id='...'></span>512<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">method</span><span class="o">.</span><span class="n">assert_called_once</span><span class="p">()</span>513<span class="gt">Traceback (most recent call last):</span>514<span class="c">...</span>515<span class="gr">AssertionError</span>: <span class="n">Expected 'method' to have been called once. Called 2 times.</span>516<span class="x">Calls: [call(), call()].</span>517</pre></div>518</div>519<div class="versionadded">520<p><span class="versionmodified added">Added in version 3.6.</span></p>521</div>522</dd></dl>523 524<dl class="py method">525<dt class="sig sig-object py" id="unittest.mock.Mock.assert_called_with">526<span class="sig-name descname"><span class="pre">assert_called_with</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.Mock.assert_called_with" title="Link to this definition">¶</a></dt>527<dd><p>This method is a convenient way of asserting that the last call has been528made in a particular way:</p>529<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>530<span class="gp">>>> </span><span class="n">mock</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> <span class="n">test</span><span class="o">=</span><span class="s1">'wow'</span><span class="p">)</span>531<span class="go"><Mock name='mock.method()' id='...'></span>532<span class="gp">>>> </span><span class="n">mock</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> <span class="n">test</span><span class="o">=</span><span class="s1">'wow'</span><span class="p">)</span>533</pre></div>534</div>535</dd></dl>536 537<dl class="py method">538<dt class="sig sig-object py" id="unittest.mock.Mock.assert_called_once_with">539<span class="sig-name descname"><span class="pre">assert_called_once_with</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.Mock.assert_called_once_with" title="Link to this definition">¶</a></dt>540<dd><p>Assert that the mock was called exactly once and that call was with the541specified arguments.</p>542<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</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="kc">None</span><span class="p">)</span>543<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="s1">'foo'</span><span class="p">,</span> <span class="n">bar</span><span class="o">=</span><span class="s1">'baz'</span><span class="p">)</span>544<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">assert_called_once_with</span><span class="p">(</span><span class="s1">'foo'</span><span class="p">,</span> <span class="n">bar</span><span class="o">=</span><span class="s1">'baz'</span><span class="p">)</span>545<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="s1">'other'</span><span class="p">,</span> <span class="n">bar</span><span class="o">=</span><span class="s1">'values'</span><span class="p">)</span>546<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">assert_called_once_with</span><span class="p">(</span><span class="s1">'other'</span><span class="p">,</span> <span class="n">bar</span><span class="o">=</span><span class="s1">'values'</span><span class="p">)</span>547<span class="gt">Traceback (most recent call last):</span>548<span class="w"> </span><span class="c">...</span>549<span class="gr">AssertionError</span>: <span class="n">Expected 'mock' to be called once. Called 2 times.</span>550<span class="x">Calls: [call('foo', bar='baz'), call('other', bar='values')].</span>551</pre></div>552</div>553</dd></dl>554 555<dl class="py method">556<dt class="sig sig-object py" id="unittest.mock.Mock.assert_any_call">557<span class="sig-name descname"><span class="pre">assert_any_call</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.Mock.assert_any_call" title="Link to this definition">¶</a></dt>558<dd><p>assert the mock has been called with the specified arguments.</p>559<p>The assert passes if the mock has <em>ever</em> been called, unlike560<a class="reference internal" href="#unittest.mock.Mock.assert_called_with" title="unittest.mock.Mock.assert_called_with"><code class="xref py py-meth docutils literal notranslate"><span class="pre">assert_called_with()</span></code></a> and <a class="reference internal" href="#unittest.mock.Mock.assert_called_once_with" title="unittest.mock.Mock.assert_called_once_with"><code class="xref py py-meth docutils literal notranslate"><span class="pre">assert_called_once_with()</span></code></a> that561only pass if the call is the most recent one, and in the case of562<code class="xref py py-meth docutils literal notranslate"><span class="pre">assert_called_once_with()</span></code> it must also be the only call.</p>563<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</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="kc">None</span><span class="p">)</span>564<span class="gp">>>> </span><span class="n">mock</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="n">arg</span><span class="o">=</span><span class="s1">'thing'</span><span class="p">)</span>565<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="s1">'some'</span><span class="p">,</span> <span class="s1">'thing'</span><span class="p">,</span> <span class="s1">'else'</span><span class="p">)</span>566<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">assert_any_call</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="n">arg</span><span class="o">=</span><span class="s1">'thing'</span><span class="p">)</span>567</pre></div>568</div>569</dd></dl>570 571<dl class="py method">572<dt class="sig sig-object py" id="unittest.mock.Mock.assert_has_calls">573<span class="sig-name descname"><span class="pre">assert_has_calls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">calls</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">any_order</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.Mock.assert_has_calls" title="Link to this definition">¶</a></dt>574<dd><p>assert the mock has been called with the specified calls.575The <a class="reference internal" href="#unittest.mock.Mock.mock_calls" title="unittest.mock.Mock.mock_calls"><code class="xref py py-attr docutils literal notranslate"><span class="pre">mock_calls</span></code></a> list is checked for the calls.</p>576<p>If <em>any_order</em> is false then the calls must be577sequential. There can be extra calls before or after the578specified calls.</p>579<p>If <em>any_order</em> is true then the calls can be in any order, but580they must all appear in <a class="reference internal" href="#unittest.mock.Mock.mock_calls" title="unittest.mock.Mock.mock_calls"><code class="xref py py-attr docutils literal notranslate"><span class="pre">mock_calls</span></code></a>.</p>581<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</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="kc">None</span><span class="p">)</span>582<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>583<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>584<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>585<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>586<span class="gp">>>> </span><span class="n">calls</span> <span class="o">=</span> <span class="p">[</span><span class="n">call</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span> <span class="n">call</span><span class="p">(</span><span class="mi">3</span><span class="p">)]</span>587<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">assert_has_calls</span><span class="p">(</span><span class="n">calls</span><span class="p">)</span>588<span class="gp">>>> </span><span class="n">calls</span> <span class="o">=</span> <span class="p">[</span><span class="n">call</span><span class="p">(</span><span class="mi">4</span><span class="p">),</span> <span class="n">call</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span> <span class="n">call</span><span class="p">(</span><span class="mi">3</span><span class="p">)]</span>589<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">assert_has_calls</span><span class="p">(</span><span class="n">calls</span><span class="p">,</span> <span class="n">any_order</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>590</pre></div>591</div>592</dd></dl>593 594<dl class="py method">595<dt class="sig sig-object py" id="unittest.mock.Mock.assert_not_called">596<span class="sig-name descname"><span class="pre">assert_not_called</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.Mock.assert_not_called" title="Link to this definition">¶</a></dt>597<dd><p>Assert the mock was never called.</p>598<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">m</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>599<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">hello</span><span class="o">.</span><span class="n">assert_not_called</span><span class="p">()</span>600<span class="gp">>>> </span><span class="n">obj</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">hello</span><span class="p">()</span>601<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">hello</span><span class="o">.</span><span class="n">assert_not_called</span><span class="p">()</span>602<span class="gt">Traceback (most recent call last):</span>603<span class="w"> </span><span class="c">...</span>604<span class="gr">AssertionError</span>: <span class="n">Expected 'hello' to not have been called. Called 1 times.</span>605<span class="x">Calls: [call()].</span>606</pre></div>607</div>608<div class="versionadded">609<p><span class="versionmodified added">Added in version 3.5.</span></p>610</div>611</dd></dl>612 613<dl class="py method">614<dt class="sig sig-object py" id="unittest.mock.Mock.reset_mock">615<span class="sig-name descname"><span class="pre">reset_mock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">side_effect</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.Mock.reset_mock" title="Link to this definition">¶</a></dt>616<dd><p>The reset_mock method resets all the call attributes on a mock object:</p>617<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</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="kc">None</span><span class="p">)</span>618<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="s1">'hello'</span><span class="p">)</span>619<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">called</span>620<span class="go">True</span>621<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">reset_mock</span><span class="p">()</span>622<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">called</span>623<span class="go">False</span>624</pre></div>625</div>626<p>This can be useful where you want to make a series of assertions that627reuse the same object.</p>628<p><em>return_value</em> parameter when set to <code class="docutils literal notranslate"><span class="pre">True</span></code> resets <a class="reference internal" href="#unittest.mock.Mock.return_value" title="unittest.mock.Mock.return_value"><code class="xref py py-attr docutils literal notranslate"><span class="pre">return_value</span></code></a>:</p>629<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</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="mi">5</span><span class="p">)</span>630<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="s1">'hello'</span><span class="p">)</span>631<span class="go">5</span>632<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">reset_mock</span><span class="p">(</span><span class="n">return_value</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>633<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="s1">'hello'</span><span class="p">)</span>634<span class="go"><Mock name='mock()' id='...'></span>635</pre></div>636</div>637<p><em>side_effect</em> parameter when set to <code class="docutils literal notranslate"><span class="pre">True</span></code> resets <a class="reference internal" href="#unittest.mock.Mock.side_effect" title="unittest.mock.Mock.side_effect"><code class="xref py py-attr docutils literal notranslate"><span class="pre">side_effect</span></code></a>:</p>638<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">(</span><span class="n">side_effect</span><span class="o">=</span><span class="ne">ValueError</span><span class="p">)</span>639<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="s1">'hello'</span><span class="p">)</span>640<span class="gt">Traceback (most recent call last):</span>641<span class="w"> </span><span class="c">...</span>642<span class="gr">ValueError</span>643<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">reset_mock</span><span class="p">(</span><span class="n">side_effect</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>644<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="s1">'hello'</span><span class="p">)</span>645<span class="go"><Mock name='mock()' id='...'></span>646</pre></div>647</div>648<p>Note that <code class="xref py py-meth docutils literal notranslate"><span class="pre">reset_mock()</span></code> <em>doesn’t</em> clear the649<a class="reference internal" href="#unittest.mock.Mock.return_value" title="unittest.mock.Mock.return_value"><code class="xref py py-attr docutils literal notranslate"><span class="pre">return_value</span></code></a>, <a class="reference internal" href="#unittest.mock.Mock.side_effect" title="unittest.mock.Mock.side_effect"><code class="xref py py-attr docutils literal notranslate"><span class="pre">side_effect</span></code></a> or any child attributes you have650set using normal assignment by default.</p>651<p>Child mocks are reset as well.</p>652<div class="versionchanged">653<p><span class="versionmodified changed">Changed in version 3.6: </span>Added two keyword-only arguments to the reset_mock function.</p>654</div>655</dd></dl>656 657<dl class="py method">658<dt class="sig sig-object py" id="unittest.mock.Mock.mock_add_spec">659<span class="sig-name descname"><span class="pre">mock_add_spec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.Mock.mock_add_spec" title="Link to this definition">¶</a></dt>660<dd><p>Add a spec to a mock. <em>spec</em> can either be an object or a661list of strings. Only attributes on the <em>spec</em> can be fetched as662attributes from the mock.</p>663<p>If <em>spec_set</em> is true then only attributes on the spec can be set.</p>664</dd></dl>665 666<dl class="py method">667<dt class="sig sig-object py" id="unittest.mock.Mock.attach_mock">668<span class="sig-name descname"><span class="pre">attach_mock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mock</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attribute</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.Mock.attach_mock" title="Link to this definition">¶</a></dt>669<dd><p>Attach a mock as an attribute of this one, replacing its name and670parent. Calls to the attached mock will be recorded in the671<a class="reference internal" href="#unittest.mock.Mock.method_calls" title="unittest.mock.Mock.method_calls"><code class="xref py py-attr docutils literal notranslate"><span class="pre">method_calls</span></code></a> and <a class="reference internal" href="#unittest.mock.Mock.mock_calls" title="unittest.mock.Mock.mock_calls"><code class="xref py py-attr docutils literal notranslate"><span class="pre">mock_calls</span></code></a> attributes of this one.</p>672</dd></dl>673 674<dl class="py method">675<dt class="sig sig-object py" id="unittest.mock.Mock.configure_mock">676<span class="sig-name descname"><span class="pre">configure_mock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.Mock.configure_mock" title="Link to this definition">¶</a></dt>677<dd><p>Set attributes on the mock through keyword arguments.</p>678<p>Attributes plus return values and side effects can be set on child679mocks using standard dot notation and unpacking a dictionary in the680method call:</p>681<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>682<span class="gp">>>> </span><span class="n">attrs</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'method.return_value'</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="s1">'other.side_effect'</span><span class="p">:</span> <span class="ne">KeyError</span><span class="p">}</span>683<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">configure_mock</span><span class="p">(</span><span class="o">**</span><span class="n">attrs</span><span class="p">)</span>684<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">method</span><span class="p">()</span>685<span class="go">3</span>686<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">other</span><span class="p">()</span>687<span class="gt">Traceback (most recent call last):</span>688<span class="w"> </span><span class="c">...</span>689<span class="gr">KeyError</span>690</pre></div>691</div>692<p>The same thing can be achieved in the constructor call to mocks:</p>693<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">attrs</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'method.return_value'</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="s1">'other.side_effect'</span><span class="p">:</span> <span class="ne">KeyError</span><span class="p">}</span>694<span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">(</span><span class="n">some_attribute</span><span class="o">=</span><span class="s1">'eggs'</span><span class="p">,</span> <span class="o">**</span><span class="n">attrs</span><span class="p">)</span>695<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">some_attribute</span>696<span class="go">'eggs'</span>697<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">method</span><span class="p">()</span>698<span class="go">3</span>699<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">other</span><span class="p">()</span>700<span class="gt">Traceback (most recent call last):</span>701<span class="w"> </span><span class="c">...</span>702<span class="gr">KeyError</span>703</pre></div>704</div>705<p><code class="xref py py-meth docutils literal notranslate"><span class="pre">configure_mock()</span></code> exists to make it easier to do configuration706after the mock has been created.</p>707</dd></dl>708 709<dl class="py method">710<dt class="sig sig-object py" id="unittest.mock.Mock.__dir__">711<span class="sig-name descname"><span class="pre">__dir__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.Mock.__dir__" title="Link to this definition">¶</a></dt>712<dd><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code> objects limit the results of <code class="docutils literal notranslate"><span class="pre">dir(some_mock)</span></code> to useful results.713For mocks with a <em>spec</em> this includes all the permitted attributes714for the mock.</p>715<p>See <a class="reference internal" href="#unittest.mock.FILTER_DIR" title="unittest.mock.FILTER_DIR"><code class="xref py py-data docutils literal notranslate"><span class="pre">FILTER_DIR</span></code></a> for what this filtering does, and how to716switch it off.</p>717</dd></dl>718 719<dl class="py method">720<dt class="sig sig-object py" id="unittest.mock.Mock._get_child_mock">721<span class="sig-name descname"><span class="pre">_get_child_mock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kw</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.Mock._get_child_mock" title="Link to this definition">¶</a></dt>722<dd><p>Create the child mocks for attributes and return value.723By default child mocks will be the same type as the parent.724Subclasses of Mock may want to override this to customize the way725child mocks are made.</p>726<p>For non-callable mocks the callable variant will be used (rather than727any custom subclass).</p>728</dd></dl>729 730<dl class="py attribute">731<dt class="sig sig-object py" id="unittest.mock.Mock.called">732<span class="sig-name descname"><span class="pre">called</span></span><a class="headerlink" href="#unittest.mock.Mock.called" title="Link to this definition">¶</a></dt>733<dd><p>A boolean representing whether or not the mock object has been called:</p>734<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</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="kc">None</span><span class="p">)</span>735<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">called</span>736<span class="go">False</span>737<span class="gp">>>> </span><span class="n">mock</span><span class="p">()</span>738<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">called</span>739<span class="go">True</span>740</pre></div>741</div>742</dd></dl>743 744<dl class="py attribute">745<dt class="sig sig-object py" id="unittest.mock.Mock.call_count">746<span class="sig-name descname"><span class="pre">call_count</span></span><a class="headerlink" href="#unittest.mock.Mock.call_count" title="Link to this definition">¶</a></dt>747<dd><p>An integer telling you how many times the mock object has been called:</p>748<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</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="kc">None</span><span class="p">)</span>749<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">call_count</span>750<span class="go">0</span>751<span class="gp">>>> </span><span class="n">mock</span><span class="p">()</span>752<span class="gp">>>> </span><span class="n">mock</span><span class="p">()</span>753<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">call_count</span>754<span class="go">2</span>755</pre></div>756</div>757</dd></dl>758 759<dl class="py attribute">760<dt class="sig sig-object py" id="unittest.mock.Mock.return_value">761<span class="sig-name descname"><span class="pre">return_value</span></span><a class="headerlink" href="#unittest.mock.Mock.return_value" title="Link to this definition">¶</a></dt>762<dd><p>Set this to configure the value returned by calling the mock:</p>763<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>764<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="s1">'fish'</span>765<span class="gp">>>> </span><span class="n">mock</span><span class="p">()</span>766<span class="go">'fish'</span>767</pre></div>768</div>769<p>The default return value is a mock object and you can configure it in770the normal way:</p>771<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>772<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">return_value</span><span class="o">.</span><span class="n">attribute</span> <span class="o">=</span> <span class="n">sentinel</span><span class="o">.</span><span class="n">Attribute</span>773<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">return_value</span><span class="p">()</span>774<span class="go"><Mock name='mock()()' id='...'></span>775<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">return_value</span><span class="o">.</span><span class="n">assert_called_with</span><span class="p">()</span>776</pre></div>777</div>778<p><a class="reference internal" href="#unittest.mock.Mock.return_value" title="unittest.mock.Mock.return_value"><code class="xref py py-attr docutils literal notranslate"><span class="pre">return_value</span></code></a> can also be set in the constructor:</p>779<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</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="mi">3</span><span class="p">)</span>780<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">return_value</span>781<span class="go">3</span>782<span class="gp">>>> </span><span class="n">mock</span><span class="p">()</span>783<span class="go">3</span>784</pre></div>785</div>786</dd></dl>787 788<dl class="py attribute">789<dt class="sig sig-object py" id="unittest.mock.Mock.side_effect">790<span class="sig-name descname"><span class="pre">side_effect</span></span><a class="headerlink" href="#unittest.mock.Mock.side_effect" title="Link to this definition">¶</a></dt>791<dd><p>This can either be a function to be called when the mock is called,792an iterable or an exception (class or instance) to be raised.</p>793<p>If you pass in a function it will be called with same arguments as the794mock and unless the function returns the <a class="reference internal" href="#unittest.mock.DEFAULT" title="unittest.mock.DEFAULT"><code class="xref py py-data docutils literal notranslate"><span class="pre">DEFAULT</span></code></a> singleton the795call to the mock will then return whatever the function returns. If the796function returns <code class="xref py py-data docutils literal notranslate"><span class="pre">DEFAULT</span></code> then the mock will return its normal797value (from the <a class="reference internal" href="#unittest.mock.Mock.return_value" title="unittest.mock.Mock.return_value"><code class="xref py py-attr docutils literal notranslate"><span class="pre">return_value</span></code></a>).</p>798<p>If you pass in an iterable, it is used to retrieve an iterator which799must yield a value on every call. This value can either be an exception800instance to be raised, or a value to be returned from the call to the801mock (<a class="reference internal" href="#unittest.mock.DEFAULT" title="unittest.mock.DEFAULT"><code class="xref py py-data docutils literal notranslate"><span class="pre">DEFAULT</span></code></a> handling is identical to the function case).</p>802<p>An example of a mock that raises an exception (to test exception803handling of an API):</p>804<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>805<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">side_effect</span> <span class="o">=</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Boom!'</span><span class="p">)</span>806<span class="gp">>>> </span><span class="n">mock</span><span class="p">()</span>807<span class="gt">Traceback (most recent call last):</span>808<span class="w"> </span><span class="c">...</span>809<span class="gr">Exception</span>: <span class="n">Boom!</span>810</pre></div>811</div>812<p>Using <a class="reference internal" href="#unittest.mock.Mock.side_effect" title="unittest.mock.Mock.side_effect"><code class="xref py py-attr docutils literal notranslate"><span class="pre">side_effect</span></code></a> to return a sequence of values:</p>813<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>814<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">side_effect</span> <span class="o">=</span> <span class="p">[</span><span class="mi">3</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">]</span>815<span class="gp">>>> </span><span class="n">mock</span><span class="p">(),</span> <span class="n">mock</span><span class="p">(),</span> <span class="n">mock</span><span class="p">()</span>816<span class="go">(3, 2, 1)</span>817</pre></div>818</div>819<p>Using a callable:</p>820<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</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="mi">3</span><span class="p">)</span>821<span class="gp">>>> </span><span class="k">def</span><span class="w"> </span><span class="nf">side_effect</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>822<span class="gp">... </span> <span class="k">return</span> <span class="n">DEFAULT</span>823<span class="gp">...</span>824<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">side_effect</span> <span class="o">=</span> <span class="n">side_effect</span>825<span class="gp">>>> </span><span class="n">mock</span><span class="p">()</span>826<span class="go">3</span>827</pre></div>828</div>829<p><a class="reference internal" href="#unittest.mock.Mock.side_effect" title="unittest.mock.Mock.side_effect"><code class="xref py py-attr docutils literal notranslate"><span class="pre">side_effect</span></code></a> can be set in the constructor. Here’s an example that830adds one to the value the mock is called with and returns it:</p>831<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">side_effect</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">value</span><span class="p">:</span> <span class="n">value</span> <span class="o">+</span> <span class="mi">1</span>832<span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">(</span><span class="n">side_effect</span><span class="o">=</span><span class="n">side_effect</span><span class="p">)</span>833<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>834<span class="go">4</span>835<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="o">-</span><span class="mi">8</span><span class="p">)</span>836<span class="go">-7</span>837</pre></div>838</div>839<p>Setting <a class="reference internal" href="#unittest.mock.Mock.side_effect" title="unittest.mock.Mock.side_effect"><code class="xref py py-attr docutils literal notranslate"><span class="pre">side_effect</span></code></a> to <code class="docutils literal notranslate"><span class="pre">None</span></code> clears it:</p>840<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">m</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">(</span><span class="n">side_effect</span><span class="o">=</span><span class="ne">KeyError</span><span class="p">,</span> <span class="n">return_value</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>841<span class="gp">>>> </span><span class="n">m</span><span class="p">()</span>842<span class="gt">Traceback (most recent call last):</span>843<span class="w"> </span><span class="c">...</span>844<span class="gr">KeyError</span>845<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">side_effect</span> <span class="o">=</span> <span class="kc">None</span>846<span class="gp">>>> </span><span class="n">m</span><span class="p">()</span>847<span class="go">3</span>848</pre></div>849</div>850</dd></dl>851 852<dl class="py attribute">853<dt class="sig sig-object py" id="unittest.mock.Mock.call_args">854<span class="sig-name descname"><span class="pre">call_args</span></span><a class="headerlink" href="#unittest.mock.Mock.call_args" title="Link to this definition">¶</a></dt>855<dd><p>This is either <code class="docutils literal notranslate"><span class="pre">None</span></code> (if the mock hasn’t been called), or the856arguments that the mock was last called with. This will be in the857form of a tuple: the first member, which can also be accessed through858the <code class="docutils literal notranslate"><span class="pre">args</span></code> property, is any positional arguments the mock was859called with (or an empty tuple) and the second member, which can860also be accessed through the <code class="docutils literal notranslate"><span class="pre">kwargs</span></code> property, is any keyword861arguments (or an empty dictionary).</p>862<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</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="kc">None</span><span class="p">)</span>863<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">mock</span><span class="o">.</span><span class="n">call_args</span><span class="p">)</span>864<span class="go">None</span>865<span class="gp">>>> </span><span class="n">mock</span><span class="p">()</span>866<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">call_args</span>867<span class="go">call()</span>868<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">call_args</span> <span class="o">==</span> <span class="p">()</span>869<span class="go">True</span>870<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>871<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">call_args</span>872<span class="go">call(3, 4)</span>873<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">call_args</span> <span class="o">==</span> <span class="p">((</span><span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">),)</span>874<span class="go">True</span>875<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">call_args</span><span class="o">.</span><span class="n">args</span>876<span class="go">(3, 4)</span>877<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">call_args</span><span class="o">.</span><span class="n">kwargs</span>878<span class="go">{}</span>879<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="mi">3</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="n">key</span><span class="o">=</span><span class="s1">'fish'</span><span class="p">,</span> <span class="nb">next</span><span class="o">=</span><span class="s1">'w00t!'</span><span class="p">)</span>880<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">call_args</span>881<span class="go">call(3, 4, 5, key='fish', next='w00t!')</span>882<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">call_args</span><span class="o">.</span><span class="n">args</span>883<span class="go">(3, 4, 5)</span>884<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">call_args</span><span class="o">.</span><span class="n">kwargs</span>885<span class="go">{'key': 'fish', 'next': 'w00t!'}</span>886</pre></div>887</div>888<p><a class="reference internal" href="#unittest.mock.Mock.call_args" title="unittest.mock.Mock.call_args"><code class="xref py py-attr docutils literal notranslate"><span class="pre">call_args</span></code></a>, along with members of the lists <a class="reference internal" href="#unittest.mock.Mock.call_args_list" title="unittest.mock.Mock.call_args_list"><code class="xref py py-attr docutils literal notranslate"><span class="pre">call_args_list</span></code></a>,889<a class="reference internal" href="#unittest.mock.Mock.method_calls" title="unittest.mock.Mock.method_calls"><code class="xref py py-attr docutils literal notranslate"><span class="pre">method_calls</span></code></a> and <a class="reference internal" href="#unittest.mock.Mock.mock_calls" title="unittest.mock.Mock.mock_calls"><code class="xref py py-attr docutils literal notranslate"><span class="pre">mock_calls</span></code></a> are <a class="reference internal" href="#unittest.mock.call" title="unittest.mock.call"><code class="xref py py-data docutils literal notranslate"><span class="pre">call</span></code></a> objects.890These are tuples, so they can be unpacked to get at the individual891arguments and make more complex assertions. See892<a class="reference internal" href="#calls-as-tuples"><span class="std std-ref">calls as tuples</span></a>.</p>893<div class="versionchanged">894<p><span class="versionmodified changed">Changed in version 3.8: </span>Added <code class="docutils literal notranslate"><span class="pre">args</span></code> and <code class="docutils literal notranslate"><span class="pre">kwargs</span></code> properties.</p>895</div>896</dd></dl>897 898<dl class="py attribute">899<dt class="sig sig-object py" id="unittest.mock.Mock.call_args_list">900<span class="sig-name descname"><span class="pre">call_args_list</span></span><a class="headerlink" href="#unittest.mock.Mock.call_args_list" title="Link to this definition">¶</a></dt>901<dd><p>This is a list of all the calls made to the mock object in sequence902(so the length of the list is the number of times it has been903called). Before any calls have been made it is an empty list. The904<a class="reference internal" href="#unittest.mock.call" title="unittest.mock.call"><code class="xref py py-data docutils literal notranslate"><span class="pre">call</span></code></a> object can be used for conveniently constructing lists of905calls to compare with <a class="reference internal" href="#unittest.mock.Mock.call_args_list" title="unittest.mock.Mock.call_args_list"><code class="xref py py-attr docutils literal notranslate"><span class="pre">call_args_list</span></code></a>.</p>906<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</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="kc">None</span><span class="p">)</span>907<span class="gp">>>> </span><span class="n">mock</span><span class="p">()</span>908<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>909<span class="gp">>>> </span><span class="n">mock</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">'fish'</span><span class="p">,</span> <span class="nb">next</span><span class="o">=</span><span class="s1">'w00t!'</span><span class="p">)</span>910<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">call_args_list</span>911<span class="go">[call(), call(3, 4), call(key='fish', next='w00t!')]</span>912<span class="gp">>>> </span><span class="n">expected</span> <span class="o">=</span> <span class="p">[(),</span> <span class="p">((</span><span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">),),</span> <span class="p">({</span><span class="s1">'key'</span><span class="p">:</span> <span class="s1">'fish'</span><span class="p">,</span> <span class="s1">'next'</span><span class="p">:</span> <span class="s1">'w00t!'</span><span class="p">},)]</span>913<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">call_args_list</span> <span class="o">==</span> <span class="n">expected</span>914<span class="go">True</span>915</pre></div>916</div>917<p>Members of <a class="reference internal" href="#unittest.mock.Mock.call_args_list" title="unittest.mock.Mock.call_args_list"><code class="xref py py-attr docutils literal notranslate"><span class="pre">call_args_list</span></code></a> are <a class="reference internal" href="#unittest.mock.call" title="unittest.mock.call"><code class="xref py py-data docutils literal notranslate"><span class="pre">call</span></code></a> objects. These can be918unpacked as tuples to get at the individual arguments. See919<a class="reference internal" href="#calls-as-tuples"><span class="std std-ref">calls as tuples</span></a>.</p>920</dd></dl>921 922<dl class="py attribute">923<dt class="sig sig-object py" id="unittest.mock.Mock.method_calls">924<span class="sig-name descname"><span class="pre">method_calls</span></span><a class="headerlink" href="#unittest.mock.Mock.method_calls" title="Link to this definition">¶</a></dt>925<dd><p>As well as tracking calls to themselves, mocks also track calls to926methods and attributes, and <em>their</em> methods and attributes:</p>927<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>928<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">method</span><span class="p">()</span>929<span class="go"><Mock name='mock.method()' id='...'></span>930<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">property</span><span class="o">.</span><span class="n">method</span><span class="o">.</span><span class="n">attribute</span><span class="p">()</span>931<span class="go"><Mock name='mock.property.method.attribute()' id='...'></span>932<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">method_calls</span>933<span class="go">[call.method(), call.property.method.attribute()]</span>934</pre></div>935</div>936<p>Members of <a class="reference internal" href="#unittest.mock.Mock.method_calls" title="unittest.mock.Mock.method_calls"><code class="xref py py-attr docutils literal notranslate"><span class="pre">method_calls</span></code></a> are <a class="reference internal" href="#unittest.mock.call" title="unittest.mock.call"><code class="xref py py-data docutils literal notranslate"><span class="pre">call</span></code></a> objects. These can be937unpacked as tuples to get at the individual arguments. See938<a class="reference internal" href="#calls-as-tuples"><span class="std std-ref">calls as tuples</span></a>.</p>939</dd></dl>940 941<dl class="py attribute">942<dt class="sig sig-object py" id="unittest.mock.Mock.mock_calls">943<span class="sig-name descname"><span class="pre">mock_calls</span></span><a class="headerlink" href="#unittest.mock.Mock.mock_calls" title="Link to this definition">¶</a></dt>944<dd><p><a class="reference internal" href="#unittest.mock.Mock.mock_calls" title="unittest.mock.Mock.mock_calls"><code class="xref py py-attr docutils literal notranslate"><span class="pre">mock_calls</span></code></a> records <em>all</em> calls to the mock object, its methods,945magic methods <em>and</em> return value mocks.</p>946<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">MagicMock</span><span class="p">()</span>947<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">mock</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>948<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">first</span><span class="p">(</span><span class="n">a</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>949<span class="go"><MagicMock name='mock.first()' id='...'></span>950<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">second</span><span class="p">()</span>951<span class="go"><MagicMock name='mock.second()' id='...'></span>952<span class="gp">>>> </span><span class="nb">int</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span>953<span class="go">1</span>954<span class="gp">>>> </span><span class="n">result</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>955<span class="go"><MagicMock name='mock()()' id='...'></span>956<span class="gp">>>> </span><span class="n">expected</span> <span class="o">=</span> <span class="p">[</span><span class="n">call</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> <span class="n">call</span><span class="o">.</span><span class="n">first</span><span class="p">(</span><span class="n">a</span><span class="o">=</span><span class="mi">3</span><span class="p">),</span> <span class="n">call</span><span class="o">.</span><span class="n">second</span><span class="p">(),</span>957<span class="gp">... </span><span class="n">call</span><span class="o">.</span><span class="fm">__int__</span><span class="p">(),</span> <span class="n">call</span><span class="p">()(</span><span class="mi">1</span><span class="p">)]</span>958<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">mock_calls</span> <span class="o">==</span> <span class="n">expected</span>959<span class="go">True</span>960</pre></div>961</div>962<p>Members of <a class="reference internal" href="#unittest.mock.Mock.mock_calls" title="unittest.mock.Mock.mock_calls"><code class="xref py py-attr docutils literal notranslate"><span class="pre">mock_calls</span></code></a> are <a class="reference internal" href="#unittest.mock.call" title="unittest.mock.call"><code class="xref py py-data docutils literal notranslate"><span class="pre">call</span></code></a> objects. These can be963unpacked as tuples to get at the individual arguments. See964<a class="reference internal" href="#calls-as-tuples"><span class="std std-ref">calls as tuples</span></a>.</p>965<div class="admonition note">966<p class="admonition-title">Note</p>967<p>The way <a class="reference internal" href="#unittest.mock.Mock.mock_calls" title="unittest.mock.Mock.mock_calls"><code class="xref py py-attr docutils literal notranslate"><span class="pre">mock_calls</span></code></a> are recorded means that where nested968calls are made, the parameters of ancestor calls are not recorded969and so will always compare equal:</p>970<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">MagicMock</span><span class="p">()</span>971<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">top</span><span class="p">(</span><span class="n">a</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span><span class="o">.</span><span class="n">bottom</span><span class="p">()</span>972<span class="go"><MagicMock name='mock.top().bottom()' id='...'></span>973<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">mock_calls</span>974<span class="go">[call.top(a=3), call.top().bottom()]</span>975<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">mock_calls</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="n">call</span><span class="o">.</span><span class="n">top</span><span class="p">(</span><span class="n">a</span><span class="o">=-</span><span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">bottom</span><span class="p">()</span>976<span class="go">True</span>977</pre></div>978</div>979</div>980</dd></dl>981 982<dl class="py attribute">983<dt class="sig sig-object py" id="unittest.mock.Mock.__class__">984<span class="sig-name descname"><span class="pre">__class__</span></span><a class="headerlink" href="#unittest.mock.Mock.__class__" title="Link to this definition">¶</a></dt>985<dd><p>Normally the <code class="xref py py-attr docutils literal notranslate"><span class="pre">__class__</span></code> attribute of an object will return its type.986For a mock object with a <code class="xref py py-attr docutils literal notranslate"><span class="pre">spec</span></code>, <code class="xref py py-attr docutils literal notranslate"><span class="pre">__class__</span></code> returns the spec class987instead. This allows mock objects to pass <a class="reference internal" href="functions.html#isinstance" title="isinstance"><code class="xref py py-func docutils literal notranslate"><span class="pre">isinstance()</span></code></a> tests for the988object they are replacing / masquerading as:</p>989<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">(</span><span class="n">spec</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>990<span class="gp">>>> </span><span class="nb">isinstance</span><span class="p">(</span><span class="n">mock</span><span class="p">,</span> <span class="nb">int</span><span class="p">)</span>991<span class="go">True</span>992</pre></div>993</div>994<p><code class="xref py py-attr docutils literal notranslate"><span class="pre">__class__</span></code> is assignable to, this allows a mock to pass an995<a class="reference internal" href="functions.html#isinstance" title="isinstance"><code class="xref py py-func docutils literal notranslate"><span class="pre">isinstance()</span></code></a> check without forcing you to use a spec:</p>996<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>997<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="vm">__class__</span> <span class="o">=</span> <span class="nb">dict</span>998<span class="gp">>>> </span><span class="nb">isinstance</span><span class="p">(</span><span class="n">mock</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)</span>999<span class="go">True</span>1000</pre></div>1001</div>1002</dd></dl>1003 1004</dd></dl>1005 1006<dl class="py class">1007<dt class="sig sig-object py" id="unittest.mock.NonCallableMock">1008<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">unittest.mock.</span></span><span class="sig-name descname"><span class="pre">NonCallableMock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wraps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.NonCallableMock" title="Link to this definition">¶</a></dt>1009<dd><p>A non-callable version of <a class="reference internal" href="#unittest.mock.Mock" title="unittest.mock.Mock"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code></a>. The constructor parameters have the same1010meaning of <code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code>, with the exception of <em>return_value</em> and <em>side_effect</em>1011which have no meaning on a non-callable mock.</p>1012</dd></dl>1013 1014<p>Mock objects that use a class or an instance as a <code class="xref py py-attr docutils literal notranslate"><span class="pre">spec</span></code> or1015<code class="xref py py-attr docutils literal notranslate"><span class="pre">spec_set</span></code> are able to pass <a class="reference internal" href="functions.html#isinstance" title="isinstance"><code class="xref py py-func docutils literal notranslate"><span class="pre">isinstance()</span></code></a> tests:</p>1016<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">(</span><span class="n">spec</span><span class="o">=</span><span class="n">SomeClass</span><span class="p">)</span>1017<span class="gp">>>> </span><span class="nb">isinstance</span><span class="p">(</span><span class="n">mock</span><span class="p">,</span> <span class="n">SomeClass</span><span class="p">)</span>1018<span class="go">True</span>1019<span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">(</span><span class="n">spec_set</span><span class="o">=</span><span class="n">SomeClass</span><span class="p">())</span>1020<span class="gp">>>> </span><span class="nb">isinstance</span><span class="p">(</span><span class="n">mock</span><span class="p">,</span> <span class="n">SomeClass</span><span class="p">)</span>1021<span class="go">True</span>1022</pre></div>1023</div>1024<p>The <a class="reference internal" href="#unittest.mock.Mock" title="unittest.mock.Mock"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code></a> classes have support for mocking magic methods. See <a class="reference internal" href="#magic-methods"><span class="std std-ref">magic1025methods</span></a> for the full details.</p>1026<p>The mock classes and the <a class="reference internal" href="#unittest.mock.patch" title="unittest.mock.patch"><code class="xref py py-func docutils literal notranslate"><span class="pre">patch()</span></code></a> decorators all take arbitrary keyword1027arguments for configuration. For the <code class="xref py py-func docutils literal notranslate"><span class="pre">patch()</span></code> decorators the keywords are1028passed to the constructor of the mock being created. The keyword arguments1029are for configuring attributes of the mock:</p>1030<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">m</span> <span class="o">=</span> <span class="n">MagicMock</span><span class="p">(</span><span class="n">attribute</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">other</span><span class="o">=</span><span class="s1">'fish'</span><span class="p">)</span>1031<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">attribute</span>1032<span class="go">3</span>1033<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">other</span>1034<span class="go">'fish'</span>1035</pre></div>1036</div>1037<p>The return value and side effect of child mocks can be set in the same way,1038using dotted notation. As you can’t use dotted names directly in a call you1039have to create a dictionary and unpack it using <code class="docutils literal notranslate"><span class="pre">**</span></code>:</p>1040<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">attrs</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'method.return_value'</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="s1">'other.side_effect'</span><span class="p">:</span> <span class="ne">KeyError</span><span class="p">}</span>1041<span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">(</span><span class="n">some_attribute</span><span class="o">=</span><span class="s1">'eggs'</span><span class="p">,</span> <span class="o">**</span><span class="n">attrs</span><span class="p">)</span>1042<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">some_attribute</span>1043<span class="go">'eggs'</span>1044<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">method</span><span class="p">()</span>1045<span class="go">3</span>1046<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">other</span><span class="p">()</span>1047<span class="gt">Traceback (most recent call last):</span>1048<span class="w"> </span><span class="c">...</span>1049<span class="gr">KeyError</span>1050</pre></div>1051</div>1052<p>A callable mock which was created with a <em>spec</em> (or a <em>spec_set</em>) will1053introspect the specification object’s signature when matching calls to1054the mock. Therefore, it can match the actual call’s arguments regardless1055of whether they were passed positionally or by name:</p>1056<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">def</span><span class="w"> </span><span class="nf">f</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> <span class="k">pass</span>1057<span class="gp">...</span>1058<span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">(</span><span class="n">spec</span><span class="o">=</span><span class="n">f</span><span class="p">)</span>1059<span class="gp">>>> </span><span class="n">mock</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="n">c</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>1060<span class="go"><Mock name='mock()' id='140161580456576'></span>1061<span class="gp">>>> </span><span class="n">mock</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>1062<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">assert_called_with</span><span class="p">(</span><span class="n">a</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">b</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>1063</pre></div>1064</div>1065<p>This applies to <a class="reference internal" href="#unittest.mock.Mock.assert_called_with" title="unittest.mock.Mock.assert_called_with"><code class="xref py py-meth docutils literal notranslate"><span class="pre">assert_called_with()</span></code></a>,1066<a class="reference internal" href="#unittest.mock.Mock.assert_called_once_with" title="unittest.mock.Mock.assert_called_once_with"><code class="xref py py-meth docutils literal notranslate"><span class="pre">assert_called_once_with()</span></code></a>, <a class="reference internal" href="#unittest.mock.Mock.assert_has_calls" title="unittest.mock.Mock.assert_has_calls"><code class="xref py py-meth docutils literal notranslate"><span class="pre">assert_has_calls()</span></code></a> and1067<a class="reference internal" href="#unittest.mock.Mock.assert_any_call" title="unittest.mock.Mock.assert_any_call"><code class="xref py py-meth docutils literal notranslate"><span class="pre">assert_any_call()</span></code></a>. When <a class="reference internal" href="#auto-speccing"><span class="std std-ref">Autospeccing</span></a>, it will also1068apply to method calls on the mock object.</p>1069<div class="versionchanged">1070<p><span class="versionmodified changed">Changed in version 3.4: </span>Added signature introspection on specced and autospecced mock objects.</p>1071</div>1072<dl class="py class">1073<dt class="sig sig-object py" id="unittest.mock.PropertyMock">1074<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">unittest.mock.</span></span><span class="sig-name descname"><span class="pre">PropertyMock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.PropertyMock" title="Link to this definition">¶</a></dt>1075<dd><p>A mock intended to be used as a <a class="reference internal" href="functions.html#property" title="property"><code class="xref py py-class docutils literal notranslate"><span class="pre">property</span></code></a>, or other1076<a class="reference internal" href="../glossary.html#term-descriptor"><span class="xref std std-term">descriptor</span></a>, on a class. <code class="xref py py-class docutils literal notranslate"><span class="pre">PropertyMock</span></code> provides1077<a class="reference internal" href="../reference/datamodel.html#object.__get__" title="object.__get__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__get__()</span></code></a> and <a class="reference internal" href="../reference/datamodel.html#object.__set__" title="object.__set__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__set__()</span></code></a> methods1078so you can specify a return value when it is fetched.</p>1079<p>Fetching a <code class="xref py py-class docutils literal notranslate"><span class="pre">PropertyMock</span></code> instance from an object calls the mock, with1080no args. Setting it calls the mock with the value being set.</p>1081<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">class</span><span class="w"> </span><span class="nc">Foo</span><span class="p">:</span>1082<span class="gp">... </span> <span class="nd">@property</span>1083<span class="gp">... </span> <span class="k">def</span><span class="w"> </span><span class="nf">foo</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>1084<span class="gp">... </span> <span class="k">return</span> <span class="s1">'something'</span>1085<span class="gp">... </span> <span class="nd">@foo</span><span class="o">.</span><span class="n">setter</span>1086<span class="gp">... </span> <span class="k">def</span><span class="w"> </span><span class="nf">foo</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>1087<span class="gp">... </span> <span class="k">pass</span>1088<span class="gp">...</span>1089<span class="gp">>>> </span><span class="k">with</span> <span class="n">patch</span><span class="p">(</span><span class="s1">'__main__.Foo.foo'</span><span class="p">,</span> <span class="n">new_callable</span><span class="o">=</span><span class="n">PropertyMock</span><span class="p">)</span> <span class="k">as</span> <span class="n">mock_foo</span><span class="p">:</span>1090<span class="gp">... </span> <span class="n">mock_foo</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="s1">'mockity-mock'</span>1091<span class="gp">... </span> <span class="n">this_foo</span> <span class="o">=</span> <span class="n">Foo</span><span class="p">()</span>1092<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">this_foo</span><span class="o">.</span><span class="n">foo</span><span class="p">)</span>1093<span class="gp">... </span> <span class="n">this_foo</span><span class="o">.</span><span class="n">foo</span> <span class="o">=</span> <span class="mi">6</span>1094<span class="gp">...</span>1095<span class="go">mockity-mock</span>1096<span class="gp">>>> </span><span class="n">mock_foo</span><span class="o">.</span><span class="n">mock_calls</span>1097<span class="go">[call(), call(6)]</span>1098</pre></div>1099</div>1100</dd></dl>1101 1102<p>Because of the way mock attributes are stored you can’t directly attach a1103<a class="reference internal" href="#unittest.mock.PropertyMock" title="unittest.mock.PropertyMock"><code class="xref py py-class docutils literal notranslate"><span class="pre">PropertyMock</span></code></a> to a mock object. Instead you can attach it to the mock type1104object:</p>1105<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">m</span> <span class="o">=</span> <span class="n">MagicMock</span><span class="p">()</span>1106<span class="gp">>>> </span><span class="n">p</span> <span class="o">=</span> <span class="n">PropertyMock</span><span class="p">(</span><span class="n">return_value</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>1107<span class="gp">>>> </span><span class="nb">type</span><span class="p">(</span><span class="n">m</span><span class="p">)</span><span class="o">.</span><span class="n">foo</span> <span class="o">=</span> <span class="n">p</span>1108<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">foo</span>1109<span class="go">3</span>1110<span class="gp">>>> </span><span class="n">p</span><span class="o">.</span><span class="n">assert_called_once_with</span><span class="p">()</span>1111</pre></div>1112</div>1113<div class="admonition caution">1114<p class="admonition-title">Caution</p>1115<p>If an <a class="reference internal" href="exceptions.html#AttributeError" title="AttributeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AttributeError</span></code></a> is raised by <a class="reference internal" href="#unittest.mock.PropertyMock" title="unittest.mock.PropertyMock"><code class="xref py py-class docutils literal notranslate"><span class="pre">PropertyMock</span></code></a>,1116it will be interpreted as a missing descriptor and1117<a class="reference internal" href="../reference/datamodel.html#object.__getattr__" title="object.__getattr__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__getattr__()</span></code></a> will be called on the parent mock:</p>1118<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">m</span> <span class="o">=</span> <span class="n">MagicMock</span><span class="p">()</span>1119<span class="gp">>>> </span><span class="n">no_attribute</span> <span class="o">=</span> <span class="n">PropertyMock</span><span class="p">(</span><span class="n">side_effect</span><span class="o">=</span><span class="ne">AttributeError</span><span class="p">)</span>1120<span class="gp">>>> </span><span class="nb">type</span><span class="p">(</span><span class="n">m</span><span class="p">)</span><span class="o">.</span><span class="n">my_property</span> <span class="o">=</span> <span class="n">no_attribute</span>1121<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">my_property</span>1122<span class="go"><MagicMock name='mock.my_property' id='140165240345424'></span>1123</pre></div>1124</div>1125<p>See <a class="reference internal" href="../reference/datamodel.html#object.__getattr__" title="object.__getattr__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__getattr__()</span></code></a> for details.</p>1126</div>1127<dl class="py class">1128<dt class="sig sig-object py" id="unittest.mock.AsyncMock">1129<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">unittest.mock.</span></span><span class="sig-name descname"><span class="pre">AsyncMock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">side_effect</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">DEFAULT</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wraps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unsafe</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.AsyncMock" title="Link to this definition">¶</a></dt>1130<dd><p>An asynchronous version of <a class="reference internal" href="#unittest.mock.MagicMock" title="unittest.mock.MagicMock"><code class="xref py py-class docutils literal notranslate"><span class="pre">MagicMock</span></code></a>. The <code class="xref py py-class docutils literal notranslate"><span class="pre">AsyncMock</span></code> object will1131behave so the object is recognized as an async function, and the result of a1132call is an awaitable.</p>1133<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">AsyncMock</span><span class="p">()</span>1134<span class="gp">>>> </span><span class="n">inspect</span><span class="o">.</span><span class="n">iscoroutinefunction</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span>1135<span class="go">True</span>1136<span class="gp">>>> </span><span class="n">inspect</span><span class="o">.</span><span class="n">isawaitable</span><span class="p">(</span><span class="n">mock</span><span class="p">())</span>1137<span class="go">True</span>1138</pre></div>1139</div>1140<p>The result of <code class="docutils literal notranslate"><span class="pre">mock()</span></code> is an async function which will have the outcome1141of <code class="docutils literal notranslate"><span class="pre">side_effect</span></code> or <code class="docutils literal notranslate"><span class="pre">return_value</span></code> after it has been awaited:</p>1142<ul class="simple">1143<li><p>if <code class="docutils literal notranslate"><span class="pre">side_effect</span></code> is a function, the async function will return the1144result of that function,</p></li>1145<li><p>if <code class="docutils literal notranslate"><span class="pre">side_effect</span></code> is an exception, the async function will raise the1146exception,</p></li>1147<li><p>if <code class="docutils literal notranslate"><span class="pre">side_effect</span></code> is an iterable, the async function will return the1148next value of the iterable, however, if the sequence of result is1149exhausted, <code class="docutils literal notranslate"><span class="pre">StopAsyncIteration</span></code> is raised immediately,</p></li>1150<li><p>if <code class="docutils literal notranslate"><span class="pre">side_effect</span></code> is not defined, the async function will return the1151value defined by <code class="docutils literal notranslate"><span class="pre">return_value</span></code>, hence, by default, the async function1152returns a new <code class="xref py py-class docutils literal notranslate"><span class="pre">AsyncMock</span></code> object.</p></li>1153</ul>1154<p>Setting the <em>spec</em> of a <a class="reference internal" href="#unittest.mock.Mock" title="unittest.mock.Mock"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code></a> or <a class="reference internal" href="#unittest.mock.MagicMock" title="unittest.mock.MagicMock"><code class="xref py py-class docutils literal notranslate"><span class="pre">MagicMock</span></code></a> to an async function1155will result in a coroutine object being returned after calling.</p>1156<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">async_func</span><span class="p">():</span> <span class="k">pass</span>1157<span class="gp">...</span>1158<span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">MagicMock</span><span class="p">(</span><span class="n">async_func</span><span class="p">)</span>1159<span class="gp">>>> </span><span class="n">mock</span>1160<span class="go"><MagicMock spec='function' id='...'></span>1161<span class="gp">>>> </span><span class="n">mock</span><span class="p">()</span>1162<span class="go"><coroutine object AsyncMockMixin._mock_call at ...></span>1163</pre></div>1164</div>1165<p>Setting the <em>spec</em> of a <a class="reference internal" href="#unittest.mock.Mock" title="unittest.mock.Mock"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code></a>, <a class="reference internal" href="#unittest.mock.MagicMock" title="unittest.mock.MagicMock"><code class="xref py py-class docutils literal notranslate"><span class="pre">MagicMock</span></code></a>, or <code class="xref py py-class docutils literal notranslate"><span class="pre">AsyncMock</span></code>1166to a class with asynchronous and synchronous functions will automatically1167detect the synchronous functions and set them as <code class="xref py py-class docutils literal notranslate"><span class="pre">MagicMock</span></code> (if the1168parent mock is <code class="xref py py-class docutils literal notranslate"><span class="pre">AsyncMock</span></code> or <code class="xref py py-class docutils literal notranslate"><span class="pre">MagicMock</span></code>) or <code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code> (if1169the parent mock is <code class="xref py py-class docutils literal notranslate"><span class="pre">Mock</span></code>). All asynchronous functions will be1170<code class="xref py py-class docutils literal notranslate"><span class="pre">AsyncMock</span></code>.</p>1171<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">class</span><span class="w"> </span><span class="nc">ExampleClass</span><span class="p">:</span>1172<span class="gp">... </span> <span class="k">def</span><span class="w"> </span><span class="nf">sync_foo</span><span class="p">():</span>1173<span class="gp">... </span> <span class="k">pass</span>1174<span class="gp">... </span> <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">async_foo</span><span class="p">():</span>1175<span class="gp">... </span> <span class="k">pass</span>1176<span class="gp">...</span>1177<span class="gp">>>> </span><span class="n">a_mock</span> <span class="o">=</span> <span class="n">AsyncMock</span><span class="p">(</span><span class="n">ExampleClass</span><span class="p">)</span>1178<span class="gp">>>> </span><span class="n">a_mock</span><span class="o">.</span><span class="n">sync_foo</span>1179<span class="go"><MagicMock name='mock.sync_foo' id='...'></span>1180<span class="gp">>>> </span><span class="n">a_mock</span><span class="o">.</span><span class="n">async_foo</span>1181<span class="go"><AsyncMock name='mock.async_foo' id='...'></span>1182<span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">(</span><span class="n">ExampleClass</span><span class="p">)</span>1183<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">sync_foo</span>1184<span class="go"><Mock name='mock.sync_foo' id='...'></span>1185<span class="gp">>>> </span><span class="n">mock</span><span class="o">.</span><span class="n">async_foo</span>1186<span class="go"><AsyncMock name='mock.async_foo' id='...'></span>1187</pre></div>1188</div>1189<div class="versionadded">1190<p><span class="versionmodified added">Added in version 3.8.</span></p>1191</div>1192<dl class="py method">1193<dt class="sig sig-object py" id="unittest.mock.AsyncMock.assert_awaited">1194<span class="sig-name descname"><span class="pre">assert_awaited</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#unittest.mock.AsyncMock.assert_awaited" title="Link to this definition">¶</a></dt>1195<dd><p>Assert that the mock was awaited at least once. Note that this is separate1196from the object having been called, the <code class="docutils literal notranslate"><span class="pre">await</span></code> keyword must be used:</p>1197<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mock</span> <span class="o">=</span> <span class="n">AsyncMock</span><span class="p">()</span>1198<span class="gp">>>> </span><span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">main</span><span class="p">(</span><span class="n">coroutine_mock</span><span class="p">):</span>1199<span class="gp">... </span> <span class="k">await</span> <span class="n">coroutine_mock</span>1200<span class="gp">...</span>