Pytest测试框架中，setup和teardown函数的作用及使用方法

我不是女神ヾ 2024-03-16 11:07 31阅读 0赞

作为一名Python开发人员，您一定知道Pytest是一个广泛使用的Python测试框架。

它具有易用性和灵活性，可以帮助您快速编写测试用例，并且能够支持包括单元测试、集成测试、功能测试等多种测试类型。而其中，setup和teardown函数是Pytest提供的两个非常重要的特性。

**setup和teardown函数可以分别在每个测试用例之前和之后执行，以确保测试环境的准备和清除工作。通过合理使用这两个函数，您可以有效地提高测试效率，并且避免测试用例之间的相互干扰。**

本篇文章将详细介绍setup和teardown函数的作用及使用方法，让您轻松掌握这两个关键特性，为您的测试工作注入动力！

### **Pytest - setup 和 teardown** ###

*  执行用例肯定有些需要前置条件或后置操作，例如前置的用户登陆，后置的清理数据等操作；
 *  unittest提供了两种前置（setup、setupClass）和两种后置（teardown、teardownClass）；
 *  相比之下，pytest 提供了**十种** `setup` 和 `teardown` 方法：
    
     *  **模块级别：**setup\_module、teardown\_module
     *  **函数级别：**setup\_function、teardown\_function，不在类中的方法
     *  **类级别：**setup\_class、teardown\_class
     *  **方法级别：**setup\_method、teardown\_method
     *  **用例级别：**setup、teardown

> test\_py.py

<table> 
 <tbody> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">import</span> pytest</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">def</span> <span style="color:#6f42c1;">setup_module</span>():</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#397300;">print</span>(<span style="color:#032f62;">"\n！！！！ setup_module &gt; 整个.py模块开始前只执行一次:打开浏览器/获取cookie ！！！！"</span>)</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">def</span> <span style="color:#6f42c1;">teardown_module</span>():</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#397300;">print</span>(<span style="color:#032f62;">"！！！！ teardown_module &gt; 整个.py模块结束后只执行一次:关闭浏览器 ！！！！"</span>)</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">def</span> <span style="color:#6f42c1;">setup_function</span>():</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#397300;">print</span>(<span style="color:#032f62;">"\n### setup_function &gt; 每个函数级别用例开始前都执行 ###"</span>)</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">def</span> <span style="color:#6f42c1;">teardown_function</span>():</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#397300;">print</span>(<span style="color:#032f62;">"### teardown_function &gt; 每个函数级别用例结束后都执行 ###"</span>)</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">def</span> <span style="color:#6f42c1;">test_one</span>():</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#397300;">print</span>(<span style="color:#032f62;">"test case 1"</span>)</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">def</span> <span style="color:#6f42c1;">test_two</span>():</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#397300;">print</span>(<span style="color:#032f62;">"test case 2"</span>)</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">class</span> <span style="color:#6f42c1;">TestCase</span>():</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">def</span> <span style="color:#6f42c1;">setup_class</span>(self):</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#397300;">print</span>(<span style="color:#032f62;">"\n^^^ setup_class &gt; 整个测试类开始前只执行一次 ^^^"</span>)</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">def</span> <span style="color:#6f42c1;">teardown_class</span>(self):</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#397300;">print</span>(<span style="color:#032f62;">"^^^ teardown_class &gt; 整个测试类结束后只执行一次 ^^^"</span>)</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">def</span> <span style="color:#6f42c1;">setup_method</span>(self):</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#397300;">print</span>(<span style="color:#032f62;">"\n=== setup_method &gt; 类里面每个用例执行前都会执行 ==="</span>)</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">def</span> <span style="color:#6f42c1;">teardown_method</span>(self):</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#397300;">print</span>(<span style="color:#032f62;">"=== teardown_method &gt; 类里面每个用例结束后都会执行 ==="</span>)</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">def</span> <span style="color:#6f42c1;">setup</span>(self):</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#397300;">print</span>(<span style="color:#032f62;">"--- setup &gt; 类里面每个用例执行前都会执行 ---"</span>)</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">def</span> <span style="color:#6f42c1;">teardown</span>(self):</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#397300;">print</span>(<span style="color:#032f62;">"--- teardown &gt; 类里面每个用例结束后都会执行 ---"</span>)</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">def</span> <span style="color:#6f42c1;">test_three</span>(self):</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#397300;">print</span>(<span style="color:#032f62;">"test case 3"</span>)</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">def</span> <span style="color:#6f42c1;">test_four</span>(self):</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#397300;">print</span>(<span style="color:#032f62;">"test case 4"</span>)</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code><span style="color:#d73a49;">if</span> __name__ == <span style="color:#032f62;">'__main__'</span>:</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td><code>pytest.main([<span style="color:#032f62;">"-q"</span>, <span style="color:#032f62;">"-s"</span>, <span style="color:#032f62;">"-ra"</span>, <span style="color:#032f62;">"test_py.py"</span>])</code></td> 
  </tr> 
  <tr> 
   <td style="text-align:center;vertical-align:top;"> 
    <div style="margin-left:0;"></div> </td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

*  执行结果如图所示各级别（讲解顺序从上往下，级别从低到高）：
    
     *  **黄色框：用例级别 【setup、teardown】**
     *  **橙色框：方法级别【setup\_method、teardown\_method】**
     *  **蓝色框：类级别【setup\_class、teardown\_class】**
     *  **绿色框：函数级别【setup\_function、teardown\_function】**
     *  **红色框：模块级别【setup\_module、teardown\_module】**
    
    ![9d677ad90db79627a4ec77cc7c4c476d.png][]

### 结语 ###

这篇贴子到这里就结束了，最后，希望看这篇帖子的朋友能够有所收获。

如果你觉得文章还不错，请大家 **点赞、分享、留言** 下，因为这将是我持续输出更多优质文章的最强动力！

--------------------

补充：

![654ce86e2dd34d588d8ab5c88b3b1c36.png][]

如果有需要软件测试跟教学视频的小伙伴，记得关注我私❤**【资料】**哦

###  ###

[9d677ad90db79627a4ec77cc7c4c476d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/5f2288fadb9a4b36b70ad15e7296a001.png
[654ce86e2dd34d588d8ab5c88b3b1c36.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/2ba0739983c245aba317a8563ee8d477.png