heavy_celery
managed celery task
Documentation
The full documentation is at https://heavy_celery.readthedocs.io.
Quickstart
Install heavy_celery:
pip install heavy_celery
Add it to your INSTALLED_APPS:
INSTALLED_APPS = (
...
'heavy_celery.apps.HeavyCeleryConfig',
...
)Add heavy_celery's URL patterns:
from heavy_celery import urls as heavy_celery_urls
urlpatterns = [
...
url(r'^', include(heavy_celery_urls)),
...
]Features
settings.py
CELERY_DEFAULT_QUEUE = 'default'
CELERY_DEFAULT_EXCHANGE_TYPE = 'topic'
CELERY_DEFAULT_ROUTING_KEY = 'default'
CELERY_QUEUES = (
Queue('default', Exchange('default'), routing_key='default'),
Queue('time_sensitive', Exchange('time_sensitive'), routing_key='time_sensitive_tasks'),
Queue('background', Exchange('background'), routing_key='background'),
)cronの機能を使うために
from celery.schedules import crontab
from <project_name>.celery_conf import app
from heavy_celery.cron import spawner as _cron_scheduler
@app.task()
def cron_scheduler():
_cron_scheduler()
app.conf.beat_schedule = {
'cron_scheduler': {
'task': '<appname>.tasks.cron_scheduler',
'schedule': crontab(),
'args': (),
'options': dict(queue='time_sensitive', routing_key='time_sensitive_tasks'),
},
}task定義の仕方
from heavy_celery import base
@app.task(base=base.Task)
def command(command_name, *args, **kw):
call_command(command_name, *args, **kw)タスクの定期実行のやり方
- TaskSignatureの追加
- name : タスク名
- description : タスク詳細
- task_path : タスクパス e.g) apps.foo.tasks.example_task
- args : タスクに渡す引数
- kwargs : タスクに渡すkw引数
- options : タスクのスケジュールオプション、どのQueueにいれるかとか したみたいにしておけば、time_sensitiveのQueueで走るようになる
- queue: time_sensitive routing_key: time_sensitive_tasks
- CronScheduleの追加
- name : cronタスク名
- description : cronタスク詳細
- cron_expr : cron表記
- task : TaskSignatureオブジェクト
- max_run_count : 最大繰り返し回数
Running Tests
Does the code actually work?
source <YOURVIRTUALENV>/bin/activate (myenv) $ pip install tox (myenv) $ tox
Credits
Tools used in rendering this package:
Development
$ cookiecutter https://github.com/pydanny/cookiecutter-djangopackage
$ mkvirtualenv --no-site-packages heavy_celery $ pip install tox twine
# test $ make test-all
# release $ python setup.py publish # at first $ pip install readme_renderer # at first $ python setup.py check -r -s # syntax check $ make release
