Celery のコードをテストする方法とドキュメントを生成する方法

• 概要
• 環境
• ユニットテスト
• ドキュメント生成
• 参考サイト

概要

celery のコントリビュータになりたい人向けの記事です
docker でもできるのですがイメージの作成がかなり大変なのでローカルで直接コマンドを叩いたほうが簡単です

環境

• macOS 10.15.5
• Python 3.8.3
  
  • celery 4.4.4

ユニットテスト

• git clone https://github.com/celery/celery.git
• cd celery
• pipenv install -r requirements/default.txt
• pipenv install -r requirements/test.txt
• vim t/unit/tasks/test_result.py

    def test_prtest(self):
        uid = uuid()
        x = self.app.AsyncResult(uid)
        assert x.id == uid

• pipenv run py.test t/unit

ドキュメント生成

• pipenv install -r requirements/docs.txt
• rm -rf docs/_build
• pipenv run sphinx-build -b html -d docs/_build/doctrees docs/ docs/_build/html
• open docs/_build/html/index.html

参考サイト

• https://github.com/celery/celery/blob/master/CONTRIBUTING.rst