Django passing dynamic URL parameter into reverse function

Question

I have just stated to learn Django. So far I pass dynamic URL parameters into reverse function inside the get_absolute_url() method in the following ways:

# By using kwargs:
def get_absolute_url(self):
    return  reverse('book-detail', kwargs={'id':self.id})

# Or by using the args:
def get_absolute_url(self):
    return reverse('book-detail', args=[self.id])

# But I found several examples of the following code:
def get_absolute_url(self):
    return reverse('book-detail', args=[str(self.id)]

I have used the simple library app to pass id of the book into URL in order to get book details. All three variants work fine without any problem. Can somebody explain to me why and when we should use args=[str(self.id)]?

I found examples of using str() in MDN Django tutorial (https://developer.mozilla.org/en-US/docs/Learn/Server-side/Django/Models) and Django Best Practices: Models (https://learndjango.com/tutorials/django-best-practices-models). Using str() is not in accordance with official Django documentation for the reverse() function. — Racz, Feb 09 '23 at 22:04

score 0 · Accepted Answer · answered Feb 09 '23 at 20:32

0

Using args=[str(self.id)] works because you are not using self.id as an int when you create a URL via reverse(), but as part of the string that makes up a URL. The Reverse function actually converts it to a (urlescaped) string as part of its process.

So you never actually have to use str(), it's redundant as it already happens later in the process, but it won't break anything either.

answered Feb 09 '23 at 20:32

SamSparx

4,629
1
4
16

I found example of use str() in MDN Django tutorial – Racz Feb 09 '23 at 21:50
While I can't speak as to their intent, they may have simply been making its use as a string explicit, a pythonic virtue. As you have discovered, it works either way. – SamSparx Feb 10 '23 at 08:57

Django passing dynamic URL parameter into reverse function

1 Answers1