首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

如何从Sphinx autodoc中排除pytest test_*函数?

Sphinx autodoc是Sphinx文档生成工具的一个插件,用于自动提取并生成文档。pytest是一个Python的测试框架,它会自动发现并执行以"test_"开头的测试函数。

要从Sphinx autodoc中排除pytest test_*函数,可以通过配置Sphinx的autodoc插件来实现。具体步骤如下:

  1. 打开Sphinx项目的配置文件,一般为conf.py
  2. 在配置文件中找到extensions部分,确保sphinx.ext.autodoc插件已经被启用,如果没有启用,可以添加以下代码:
代码语言:txt
复制
extensions = [
    'sphinx.ext.autodoc',
]
  1. 在配置文件中添加以下代码,用于排除pytest test_*函数:
代码语言:txt
复制
import inspect

def autodoc_skip_member(app, what, name, obj, skip, options):
    if what == 'module' and inspect.isfunction(obj) and obj.__name__.startswith('test_'):
        return True
    return skip

def setup(app):
    app.connect('autodoc-skip-member', autodoc_skip_member)
  1. 保存配置文件并重新生成文档。

以上配置会在自动生成文档时,跳过以"test_"开头的函数,从而排除pytest test_*函数。

关于Sphinx autodoc的更多信息,可以参考腾讯云的产品文档:Sphinx autodoc介绍

注意:本回答中没有提及具体的云计算品牌商,如需了解相关产品和服务,建议参考腾讯云官方文档或咨询腾讯云客服。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

sphinx入门指南【1】快速入门

index.rst称之为主文档,它被sphinx作为欢迎页面。 index.rst包含了目录树指令toctree,sphinx使用它链接其他子文档。...添加内容 在sphinx源文件,使用reStructuredText标记语言进行文档编写,除此之外,sphinx还格外提供了一些指令。...自动生成文档注释 sphinx支持python源代码中提取文档注释信息,然后生成文档,我们将这称之为autodoc。...为了使用autodoc,首先需要在配置文件的extensions选项添加'sphinx.ext.autodoc'。然后我们就可以使用autodoc的指令了。...例如,生成函数io.open()的文档,只需要在rst文件添加如下语句: .. autofunction:: io.open 也可以直接生成整个类的文档: .. automodule:: io

2.2K40

如何使用Sphinx记录Python代码【Programming(Python)】

因此,您可以向函数添加文档字符串。 我最喜欢的文档字符串样式之一是“ Google”样式 。 标记很轻巧,当它位于源代码时很好。...我们有一个文件的文本。应该有人来看看。 使Python文档更漂亮 为了使您的文档看起来更漂亮,您可以利用Sphinx ,它旨在制作漂亮的Python文档。...这三个Sphinx扩展特别有用: sphinx.ext.autodoc模块内部获取文档 sphinx.ext.napoleon :支持Google样式的文档字符串 sphinx.ext.viewcode...:将ReStructured Text源与生成的文档打包在一起 为了告诉Sphinx什么以及如何生成,我们在docs / conf.py配置一个辅助文件: extensions = [ 'sphinx.ext.autodoc...我们可以docstrings开始,添加.rst文件,然后添加Sphinx和Tox为用户美化结果。 对于好的文档,您欣赏什么? 你还有其他喜欢的策略吗? 请在评论中分享它们!

1.2K00
  • Pytest系列(1) - 快速入门和基础讲解

    知识点 如果只执行 ,会查找当前目录及其子目录下以 test_*.py 或 *_test.py 文件,找到文件后,在文件中找到以 test 开头函数并执行 pytest 如果只想执行某个文件,可以...文件名以 test_*.py 文件和*_test.py 以 开头的函数 test_ 以 开头的类,不能包含 __init__ 方法 Test 以 开头的类里面的方法 test_ 所有的包...pakege 必项要有__init__.py 文件 Pytest执行用例规则 注意,下面讲的都是在cmd执行pytest命令 1、某个目录下所有的用例 pytest 2、执行某一个 py 文件下用例...http的所有用例 pytest -s -k http start.py 11、-k 根据用例名称排除某些用例 1 pytest -s -k "not http" start.py 12、-k 同时匹配不同的用例名称...Pycharm如何运行Pytest 首先,我们先要去settings里面设置单元测试框架为Pytest 如果是nosetests的话,右键运行是以python脚本运行的哦 如果设置了unittest则是以

    71820

    pytest系列教程——1、pytest快速入门

    _*.py 文件和 *_test.py 以test_开头的函数 以Test开头的类,不能包含__init__方法 以test_开头的类里面的方法 所有的包 package 必须要有__init__.py...文件 4、运行方式 以前文test.py测试文件举例 (1) 主函数方式运行: 指定运行文件:pytest.main(['-s','test.py']) 注意:如果py文件是以test_开头或者以_test...py文件是以test_开头或者以_test结尾则可以使用pytest命令运行,因为pytest会运行当前目录下所有以test_开头或者以_test结尾的文件。...5、运行参数说明 -s显示打印内容 如:pytest test.py -s 等价于:pytest.main(['-s','test.py']) ::指定测试用例运行 运行函数:如:pytest pytest-demo.py...test.py —maxfail=3 -k 匹配用例名称 ,执行测试用例名称包含关键字的所有用例 如:pytest test.py -k 关键字 排除某些用例 如:pytest test.py -k '

    2.1K30

    Python测试框架pytest(01)简介、安装、快速入门

    官方网址: http://pytest.org/ GitHub网址: https://github.com/pytest-dev/pytest 2、安装 1、在命令行运行以下命令进行安装: pip...总结: 1、如果只执行 pytest,会查找当前目录及其子目录下以 test_*.py 或 *_test.py 文件,找到文件后,在文件中找到以 test 开头函数并执行。...1、文件名以 test_*.py 文件和 *_test.py 文件。 2、以 test_ 开头的函数。 3、以 Test 开头的类,不能包含 __init__ 方法。...3.2、pytest执行用例规则 在命令行执行pytest命令 3.2.1、目录下执行所有的用例 pytest 或者 py.test 3.2.2、执行单独一个pytest模块 pytest 文件名.py...-x 文件名.py 3.2.10、-k运行包含关键字的用例 pytest -v -k "one" 文件名.py 执行测试用例名称包含 one 的所有用例 3.2.11、-k运行排除关键字的用例 pytest

    48820

    Pytest学习(一)- 入门及基础

    我猜想大部分人都和我一样,早期是虫师开始接触和熟悉Python自动化的 。...说明: 只执行 pytest ,会查找当前目录及其子目录下以 test_*.py 或 *_test.py 文件,找到文件后,在文件中找到以 test 开头函数并执行 只想执行某个文件,可以 pytest...用例的设计原则 文件名以 test_.py 文件和_test.py 以 test_ 开头的函数 以 Test 开头的类,不能包含 init 方法 以 test_ 开头的类里面的方法 所有的包 pakege...pytest 文件名.py 3、运行test_demo.py文件模块里面的某个函数,或者某个类,某个类里面的方法 说明:加v和不加-v都可以,加-v的话,打印的信息更详细 pytest -v test_demo.py...-s -k _in test_demo.py 11、-k 根据用例名称排除某些用例 pytest -s -k "not _in" test_demo.py 12、-k 同时匹配不同的用例名称 pytest

    77310

    Pytest(十一) pytest ini文件

    系列分享 Pytest系列(一)初次了解 Pytest(二)执行规则以及编写执行多条用例 Pytest(三)Pytest执行命令 Pytest(四)Pytest断言 Pytest(五)标记函数...Pytest(六)跳过测试 Pytest(七) pytest之参数化 Pytest(八) pytest Fixture(一) Pytest(九) pytest Fixture(二) Pytest...与之相反的是norecursedirs,这个指定后,就排除掉对应的配置目录选择执行测试用例 python_classes (args)配置 配置python_classes =Test* 匹配...类名称 如Test*,可配置多个,空格隔开,和python_files (args)方法配置类似 python_functions (args)配置 配置python_functions = test..._* 匹配函数和class里面方法 如test_*可配置多个,空格隔开,和python_files (args)方法配置类似。

    1.5K60

    关于深度学习框架Hamaa与Python API文档生成工具Sophon

    2、了解到了softmax输出层为什么通常配合cross entropy损失函数以及negative log likelihood优化方法一起使用。 了解到了神经网络权重初始化的原因与各种方法。...学会了如何编写Python C Extension。...另外,Hamaa其实已经完成了有一个月了,之所以拖了那么久才介绍是因为: 本来是打算用Sphinx+reStructuredText写API文档的,但是如果用Sphinx+reST写API文档,就意味着和...考虑到文档编写、网站外貌(Sphinx很强大,但是他的autodoc功能导出的API文档在RTD主题下实在有点丑),最终选择了MkDocs+Markdown来编写文档。...但是这样又有了另外一个问题,MkDocs没有autodoc功能。如果手动编写,就意味着我要同时保持代码的注释与API文档的介绍一致。

    72331

    日常积累 | 初识pytest (二)

    日常积累 | 初识Pytest 继上篇pytest环境成功安装之后, 在cmd终端使用pytest执行脚本进行知识点细化以及先介绍一下pytest脚本命名以及编写规范 用过unittest肯定知道...同样也有它定义的规则,我们一起来看看 01. pytest框架测试用例脚本设计原则 - 文件名以test_*.py/*_test.py ?...- 函数test_开头 - 类以test_开头 - 方法以test_开头 ? - 断言使用assert ? - 所有的pakege下必须含有_init_.py文件 ?...-k 匹配关键词运行(包括文件名、函数名、类名) >>pytest -k "Test_API_list" 4.按导入的包来运行 >>pytest --pyargs pkg.testing 5....Pycharm设置pytest运行 如何安装戳历史教程:Pycharm安装以及快速下载小技巧 进入pycahrm按照路径点击设置 File | Settings | Tools | Python Integrated

    72820

    猿创征文|Python基础——Visual Studio版本——pytest

    pytest特点 非常容易上手,入门简单,文档丰富,文档中有很多实例可以参考 能够支持简单的单元测试和复杂的功能测试 支持参数化 执行测试过程可以将某些测试跳过(skip),或者对某些预期失败的case...版本查看命令 pip show pytest 注意点 测试文件以test_开头(以_test结尾也可以) 测试类以Test开头,并且不能带有 init 方法 测试函数test_开头 断言使用基本的...assert即可 控制台基础示例 # 基础函数用于输入值 def test(x): return x +1 # 测试函数是由test_开头的,这里assert断言是判断结果与目标返回是否相同...如果是通过则会告知passed # 基础函数用于输入值 def test(x): return x +1 # 测试函数是由test_开头的,这里assert断言是判断结果与目标返回是否相同...() 示例能看到  但是依然建议使用cmd控制台。

    56530

    Python测试框架之pytest详解

    6.8 生成 JUnitXML 格式的结果文件 6.9禁用插件 6.10 Python代码调用pytest 6.11 测试脚本迁移后快速部署包含pytest的virtualenv 遇到的问题 -...在单测文件,测试类以Test开头,并且不能带有 init 方法(注意:定义class时,需要以T开头,不然pytest是不会去运行该class的) 在单测类,可以包含一个或多个test_开头的函数...此时,在执行pytest命令时,会自动当前目录及子目录寻找符合上述约束的测试函数来执行。...如何获取帮助信息 查看 pytest 版本 pytest --version 显示可用的内置函数参数 pytest --fixtures 通过命令行查看帮助信息及配置文件选项 pytest --help...-p no:doctest 6.10 Python代码调用pytest pytest.main() # 基本用法 pytest.main(['-x', '

    2.3K20

    pytest测试框架常用功能_unittest批量加载用例

    2、单元测试框架主要做什么 测试发现:多个文件里面去找到我们需要的测试用例。 测试执行:按照一定的顺序和规则去执行测试用例,并生成结果。 测试判断:通过断言判断预期结果和实际结果的差异。...Pytest测试框架: 1、基于Unittest的扩展框架,比Unittest更简洁、更高效。 2、测试文件必须test_开头。 3、测试类命名必须以test_开头。...4、测试方法必须test_开头(函数也一样)。 (规则可自定义。) 总结: Unittest:用例格式复杂,不能兼客Pytest用例。 Pytest:用例格式简单,可以兼容Unittest用例。...类级setup_class/teardown_class:只在类前后运行一次(类)。 函数级setup_function/teardow_function:只对函数用例生效(不在类)。...2、函数前加@pytest.fixtures()装饰器,在测试用例中使用Fixture函数。 可作用于function\module\class\session

    89630

    《带你装B,带你飞》pytest成神之路2- 执行用例规则和pycharm运行的三种姿态

    今天主要学习一下pytest的执行用例的规则。 2. 通过help帮助查看pytest如何使用   1.查看pytest命令行参数,可以用pytest -h 或pytest --help查看 ?...用例设计原则 文件名以test_*.py文件和*_test.py 以test_开头的函数 以Test开头的类 以test_开头的方法 所有的包pakege必须要有__init__.py文件 4.开始用例设计...6.包里面运行 pytest —pyargs pkg.testing 这将导入pkg.testing并使用其文件系统位置来查找和运行测试。...7.pytest -x( 遇到错误时停止测试) pytest -x test_class.py 运行结果可以看出,本来有3个用例,第二个用例失败后就没继续往下执行了 ?...所以很有必要学习如何在pycharm里面运行pytest用例 8.1xx.py脚本方式直接执行 1.以xx.py脚本方式直接执行,当写的代码里面没用到unittest和pytest框架时,并且脚本名称不是以

    1.3K30

    【python自动化】pytest系列(

    书接上文:【python自动化】pytest系列(上) 本篇为中篇,后面还有两篇,本篇开始,知识点会增加,难度会一丢丢的一次递增。...Pytest Exist Code含义 Pytest命令常见用法 Pytest如何执行测试 这几个知识点如果大家能够脑海里回忆起来,并且能够大致写出来,那说明上一节的内容你是掌握的非常不错。...2、Pytest的前置后置操作 「用例函数的前置后置,模块定义:setup,teardown」 setup_method或setup : 在每个用例函数执行之前都会执行 teardown_method...⽂件名 (s是带控制台输出结果,也是输出详细) 2. pytest将在当前⽬录及其⼦⽬录运⾏test_*.py或*_test.py形式的所有⽂件。...以test_开头的函数,以Test开头的类,以test_开头的⽅法。所有包package都要有__init__.py⽂件。 4.

    29820

    PyTest运行指定的测试集

    帮忙多点点文章末右下角的“好看”支持下,也可以将本文分享到朋友圈或你身边的朋友,谢谢 在PyTest,提供了几种从命令行运行指定的测试集方式。...方式二,目录级运行,即指定运行某一目录下所有测试集方式,在命令行下: 命令格式: pytest 目录名 > pytest testing/ 注: testing为目录 方式三,指定运行某个模块的某个测试用例...的一个测试用例 方式四,指定运行某个模块的测试类的测试用例, 在命令行如下 命令格式:pytest 文件名.py::测试类::测试方法 > pytest test_file::TestSuite:...下面我们看下pytest用例发现的基本规则: pytest可以在不同的函数、包中发现用例,发现的规则如下 文件名以test_开头的py文件 以test_开头的函数、方法 以Test开头的类 要注意的是所有的包必须要有...至于如何写实际的pytest测试代码,大家可以自己看看相应的官方文档,本文主要分享些基本的知识

    7.3K40

    Python3,Pytest单元测试框架有多简单,几分钟就能入门

    这个测试用例涉及pytest的3个简单的规则: 测试模块以 test_ 前缀命名- 测试用例(函数)同样以 test_ 前缀命名- 结果判断使用 assert 断言即可 2.1.2....异常处理 捕获异常,及异常处理,是每段代码必要条件, 当然,pytest也支持异常的捕获, 方法为:使用 with + pytest.raises 捕获目标函数的异常: # -*- coding:utf...deselect with '-m "not slow"') 使用下面命令可以跳过标记的函数,加快测试速度: pytest test_sample.py -m "not slow" 也可以仅仅运行标记的函数...先创建一个目录a,然后再目录a创建conftest.py和test_sub.py 两个文件。...使用pytest_runtest_setup可以实现测试框架的setup类似功能。

    1.1K20
    领券