Что подразумевают тестовые каталоги в исходном коде на github?

Question

Когда вы просматриваете некоторый исходный код в github, например исходные коды для pinax-уведомлений ,asticsearch-dsl и многих других, вы обычно видите папку с именем «Test». Какова функция этой папки? Это пример того, как использовать исходный код и его функциональность в вашем собственном коде или как?

Например, я увидел папку «test» в репозитории pinax-уведомлений. Это дает пример того, как использовать это в моем коде? Также, если нет, пожалуйста, кто-нибудь поделится со мной примером того, как использовать Pinax-уведомления, чтобы отправить уведомление по электронной почте и отображать уведомление для пользователей через шаблон django?

Answer 1

Папка, на которую вы ссылаетесь, содержит тесты, которые (будем надеяться) доказывают, что все части кода работают так, как задумано. Все приложения Pinax используют папку с именем «tests». Вот содержимое папки тестов pinax-уведомлений:

Тесты полезны несколькими способами. Помимо подтверждения намерений кода, они также могут показать, как используется приложение. В случае уведомлений pinax тесты обеспечивают работу различных методов и представлений модели в соответствии с ожиданиями. Однако эти тесты не показывают, как достичь вашей цели.

Использование Pinax-уведомлений освещено в демонстрационном проекте Cloudspotting2 . В частности, обращайтесь к receivers.py вызовам "send ()" для отправки уведомлений. Что касается отображения уведомлений для пользователей с помощью шаблонов Django, см. Любой из трех шаблонов уведомлений в Cloudspotting2, например Invite_accepted / full.txt .

Наконец, документация по pinax-уведомлениям содержит полезное руководство по использованию здесь https://github.com/pinax/pinax-notifications#usage.