notion-sdk-py测试指南：使用pytest和VCR录制测试

notion-sdk-py测试指南使用pytest和VCR录制测试【免费下载链接】notion-sdk-pyNotion API client SDK, rewritten in Python! (sync async)项目地址: https://gitcode.com/gh_mirrors/no/notion-sdk-pynotion-sdk-py是一个用Python重写的Notion API客户端SDK支持同步和异步操作。本文将详细介绍如何使用pytest和VCR录制测试帮助开发者快速掌握测试技巧确保SDK的稳定性和可靠性。测试环境准备要开始使用notion-sdk-py的测试功能首先需要准备好测试环境。项目的测试文件主要集中在tests/目录下包括测试客户端、端点、错误处理和辅助函数等。安装测试依赖项目的测试依赖在requirements/tests.txt中定义你可以通过以下命令安装pip install -r requirements/tests.txt配置测试环境变量测试过程中需要一些环境变量来配置Notion API的访问主要包括NOTION_TOKENNotion API的访问令牌NOTION_TEST_PAGE_ID测试用的Notion页面ID你可以在系统环境中设置这些变量或者创建一个.env文件来管理它们。pytest基础使用notion-sdk-py使用pytest作为测试框架提供了丰富的测试功能和灵活的测试配置。测试文件结构项目的测试文件结构如下tests/test_client.py测试客户端功能tests/test_endpoints.py测试API端点tests/test_errors.py测试错误处理tests/test_helpers.py测试辅助函数基本测试用例下面是一个简单的测试用例示例来自tests/test_client.pyimport pytest from notion_client import Client from notion_client.errors import APIResponseError pytest.mark.vcr() def test_client_request_error(client): with pytest.raises(APIResponseError): client.databases.retrieve(database_idinvalid_id)这个测试用例使用pytest.mark.vcr()装饰器来启用VCR录制功能后面会详细介绍。测试用例中使用pytest.raises来断言API调用会抛出APIResponseError异常。VCR录制测试详解VCR是一个用于录制和回放HTTP请求的库可以帮助我们创建可靠的测试而不需要每次都实际调用Notion API。VCR配置notion-sdk-py在tests/conftest.py中提供了VCR的配置pytest.fixture(scopesession) def vcr_config() - Dict[str, Any]: def remove_headers(response: Dict[str, Any]) - Dict[str, Any]: headers_to_keep: Dict[str, Any] {} if response.get(headers): for key, value in response[headers].items(): key_lower key.lower() if key_lower in [content-type, content-encoding, content-length]: headers_to_keep[key] value response[headers] headers_to_keep return response return { filter_headers: [ (authorization, ntn_...), (user-agent, None), (cookie, None), ], before_record_response: remove_headers, match_on: [method, remove_page_id_for_matches], decode_compressed_response: True, }这个配置做了几件重要的事情过滤敏感头信息如授权令牌只保留必要的响应头使用自定义的匹配器来忽略URL中的页面ID启用压缩响应的解码录制和回放测试使用VCR非常简单只需要在测试函数上添加pytest.mark.vcr()装饰器即可。当第一次运行测试时VCR会录制API请求和响应并保存在tests/cassettes/目录下的YAML文件中。后续运行测试时VCR会直接使用录制的响应而不会实际调用API。例如在tests/test_endpoints.py中import pytest pytest.mark.vcr() def test_pages_create(client, parent_page_id): response client.pages.create( parent{page_id: parent_page_id}, properties{title: [{text: {content: Test Page}}]}, ) assert response[object] page第一次运行这个测试时会创建一个新的Notion页面并将API请求和响应录制到tests/cassettes/test_pages_create.yaml中。后续运行时会直接使用这个录制的响应测试速度更快也更可靠。自定义VCR使用除了使用装饰器还可以手动使用VCR的use_cassette上下文管理器在tests/conftest.py中可以看到这样的例子try: with vcr.use_cassette(test_pages_create.yaml) as cass: response cass._serializer.deserialize(cass.data[0][1][body][string]) return response[parent][page_id] except Exception: pytest.exit( Missing base page id. Restore test_pages_create.yaml or add NOTION_TEST_PAGE_ID to your environment., )这种方式允许更精细地控制VCR的行为例如从录制的响应中提取特定信息。高级测试技巧参数化测试pytest支持参数化测试可以用不同的参数多次运行同一个测试函数。在notion-sdk-py的测试中你可以看到很多这样的例子例如在tests/test_helpers.py中import pytest pytest.mark.parametrize(input, expected, [ (page_id, page_id), (database_id, database_id), (invalid_type, ValueError), ]) def test_get_id_type(input, expected): if expected is ValueError: with pytest.raises(ValueError): helpers.get_id_type(input) else: assert helpers.get_id_type(input) expected测试 fixturesnotion-sdk-py使用pytest fixtures来管理测试依赖在tests/conftest.py中定义了很多有用的fixtures例如client创建一个同步客户端async_client创建一个异步客户端page_id创建一个临时页面并返回其IDdatabase_id创建一个临时数据库并返回其ID这些fixtures可以在测试函数中直接使用例如def test_database_query(client, database_id): response client.databases.query(database_iddatabase_id) assert results in response异步测试notion-sdk-py支持异步操作测试异步代码需要使用pytest.mark.asyncio装饰器例如在tests/test_errors.py中import pytest import asyncio pytest.mark.asyncio async def test_async_request_timeout(async_client): with pytest.raises(RequestTimeoutError): await async_client.pages.retrieve(page_idinvalid_id, timeout0.1)测试用例管理录制文件管理所有的VCR录制文件都保存在tests/cassettes/目录下每个测试用例对应一个YAML文件。这些文件记录了API请求和响应的详细信息可以帮助你调试测试问题。更新录制文件当API发生变化或者你需要更新测试数据时可以删除对应的录制文件然后重新运行测试来生成新的录制文件。你也可以使用--vcr-record命令行选项来控制VCR的录制行为pytest --vcr-recordall # 重新录制所有测试 pytest --vcr-recordnone # 不录制只使用已有的录制文件 pytest --vcr-recordonce # 只录制新的测试已有的录制文件不变测试最佳实践保持测试独立每个测试应该是独立的不依赖于其他测试的结果。notion-sdk-py的测试使用fixtures来创建和清理测试资源确保测试之间不会相互干扰。测试覆盖关键功能确保测试覆盖了SDK的关键功能包括各种API端点、错误处理、数据转换等。你可以使用pytest-cov来生成测试覆盖率报告pytest --covnotion_client tests/定期运行测试在开发过程中定期运行测试确保你的更改没有破坏现有功能。你也可以设置CI/CD流程在每次提交时自动运行测试。总结notion-sdk-py提供了完善的测试体系使用pytest和VCR可以轻松创建可靠的测试。通过本文的介绍你应该已经掌握了notion-sdk-py测试的基本方法和高级技巧。开始编写你自己的测试确保SDK的质量和稳定性吧希望这篇测试指南对你有所帮助如果你有任何问题或建议欢迎在项目中提出issue或PR。【免费下载链接】notion-sdk-pyNotion API client SDK, rewritten in Python! (sync async)项目地址: https://gitcode.com/gh_mirrors/no/notion-sdk-py创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考