django-celery: bind=True fails, takes 2 positional arguments but 3 were given

Question

I am trying to retry a celery task if it fails. This is my task,

@shared_task(queue='es', bind=True, max_retries=3)
def update_station_es_index(doc_id, doc_body):
    """
    Celery consumer method for updating ES.
    """
    try:
        #es_client is connecting to ElasticSearch
        es_client.update_stations(id=doc_id, body=doc_body)
    except Exception as e:
        self.retry(exc=e)

But I get this error when this task is called,

TypeError: update_station_es_index() takes 2 positional arguments but 3 were given

I have not found enough help on the web for this error, just this github issue, but that does not explain much.

Can anyone tell me what is happening and what is the solution here?

Using Django2.0.5 and celery4.2.0

sytech · Accepted Answer · 2024-07-30 18:14:47Z

27

You must add self as an argument. When you specify bind=True, the task itself will be passed as the first argument.

Suppose you have a standard task add which takes two arguments

@shared_task
def add(x, y):
    return x + y

If you specify bind=True on this task, it will need to accept another argument.

@shared_task(bind=True)
def add(self, x, y):
    # ...

So change

def update_station_es_index(doc_id, doc_body):

to

def update_station_es_index(self, doc_id, doc_body):

See also related: What is the meaning of bind = True keyword in celery?

edited Jul 30, 2024 at 18:14

answered Jul 17, 2018 at 11:03

sytech

42.7k8 gold badges77 silver badges127 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

unlockme Over a year ago

saved my derrier again.

Talha Anwar Over a year ago

what is the better option (bind=True) or without it

sytech Over a year ago

@TalhaAnwar it is situational... use bind=True when you need a reference to the task object. If you don't need to reference the task, then it's OK to omit bind=True.

Collectives™ on Stack Overflow

django-celery: bind=True fails, takes 2 positional arguments but 3 were given

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related