napari-plugin-devtools

一个用于napari插件开发者的工具和服务仓库

安装

此工具可以通过pip安装：pip install napari-plugin-devtools，您也可以将其添加到requirements.txt中，与其他依赖项自动安装。

验证工具

验证工具为插件开发者提供自动化测试，这些检查验证插件是否可供napari用户安装，并将条目点注册到napari。

验证工具包含两部分。一部分是命令行界面，另一部分是pytest固定装置。

命令行界面 (CLI) 使用

CLI可以通过持续集成 (CI) 管道使用，以执行插件设置的快速验证，而无需任何特定输入。它作为快速“合理性检查”。（它也可以通过validation.py中的python访问）

该工具可以运行为npd <cmd>。其中目前我们支持cmd validate

npd validate：验证分类器和功能钩子是否可以被 napari 识别。验证将在 dist 文件夹下的构建包上运行，以检查它们是否已正确标注了框架分类器，以及验证钩子是否已正确标注，以便 napari 可以找到它们。

npd validate -i|--include-plugin INCLUDE_PLUGIN [INCLUDE_PLUGIN ...] 仅在列出的插件上运行钩子检查，这在复杂的 Python 环境中过滤其他插件很有用。

npd validate -e|--exclude-plugin EXCLUDE_PLUGIN [EXCLUDE_PLUGIN ...] 在列出的插件上不运行钩子检查，这在复杂的 Python 环境中过滤其他插件很有用。

npd validate -v|--verbose 启用详细模式，在验证过程的底层发现上提供更多信息。

Pytest 固定装置的使用

devtools 在 plugin_tester.py 中提供了一个 pytest 固定装置：napari_plugin_tester，它扩展了 napari 使用的插件管理器，并具有额外的断言模式。

def test_pm(napari_plugin_tester):
    napari_plugin_tester.assert_plugin_name_registered("test-plugin")
    napari_plugin_tester.assert_module_registered(_test)
    napari_plugin_tester.assert_implementations_registered(
        "test-plugin", "napari_get_reader"
    )

您可以在 napari 注释下注册的模块或函数上执行更具体的检查，请参阅 钩子规范 以找到除 napari_get_reader 之外的其他可用注释。