首页 > 解决方案 > 测试目录在 github 上的源代码中意味着什么?

问题描述

当您浏览 github 中的一些源代码(例如 pinax-notification、elasticsearch-dsl 等的源代码)时,您通常会看到一个名为“Test”的文件夹。这个文件夹的作用是什么?它是如何在您自己的代码中使用源代码及其功能的示例还是什么?

例如,我在 pinax-notification 存储库中看到了一个“测试”文件夹,这是否给出了如何在我的代码中使用它的示例?另外,如果没有,请与我分享一个关于如何使用 pinax-notification 发送电子邮件通知并通过 django 模板向用户显示通知的示例?

标签: djangogithubpinax

解决方案


您引用的文件夹包含测试(希望)证明代码的所有部分都按预期工作。所有 Pinax 应用程序都使用名为“tests”的文件夹。这是 pinax-notifications 测试文件夹的内容:

pinax-notifications 测试文件夹

测试有多种用途。除了证明代码意图之外,它们还可以展示应用程序的使用方式。在 pinax 通知的情况下,测试确保各种模型方法和视图按预期运行。但是,这些测试并未显示如何实现您的目标。

Cloudspotting2演示项目中阐明了 Pinax 通知的使用。特别是请参考receivers.py调用“send()”来发送通知。至于通过 Django 模板向用户显示通知,请参阅 Cloudspotting2 中的三个通知模板中的任何一个,例如invite_accepted/full.txt

最后 pinax-notifications 文档在https://github.com/pinax/pinax-notifications#usage中包含有关使用的有用指导。


推荐阅读