Djangoで画像を表示する際に起きるValueErrorの対処法

Question

class Product(models.Model):
    name = models.CharField(max_length=200, null=True)
    price = models.FloatField()
    digital = models.BooleanField(default=False, null=True, blank=False)
    image = models.ImageField(null=True, blank=True)

    def __str__(self):
        return self.name

    @property
    def image_url(self):
        try:
            url = self.image.url
        except:
            url = ''
        return url

{% for product in products %}
   <div class="col-lg-4">
       <img class="thumbnail" src="{{ product.image_url }}">
   </div>
{% endfor %}

<img>内でproduct.image.urlと記述すると、画像がuploadされていなかった場合にValueErrorになるのでProduct(Model)内でメソッドを使って、urlを場合分けをするところまでは理解できます。

しかし、なぜdef image_url(self):に@propertyをつけているのでしょうか。

関数名をdef image(self)にして@propertyをつけると、setterを作る必要がでてくるため(管理画面で画像をuploadするfieldがなくなります)、関数名をdef image_url(self):としているのだと理解しています。であれば、もはやgetterとしての役割がない気がしているのですが、@propertyをつける理由は何でしょうか。

ちなみに、@propertyのありなしで動作に違いがありませんでした。
(stackoverflowで調べるとほとんどのものが@propertyを使用しています)

Answer 1

propertyはdjangoとは関係ないpythonの機能で、属性のような呼び出し方をしながらメソッドを実行する方法です。

公式ドキュメントの説明が一番的確なので一読してみてください。

質問文のコードでは、Product.image_url()ではなくProduct.image_urlでurlを取得できます。中でメソッドが動いているのでtry-exceptのような処理が可能です。

おそらくdjangoのテンプレートではpropertyだったらProduct.image_urlを、そうでなかったらProduct.image_url()を呼ぶようになっていると思われますので、実質的な違いはなさそうです。
ただ、「これをプロパティとして扱う」と明示するために@propertyはつけておいた方が後からソースを見返したり他の人がソースを見るときに役に立つかと思います。

個人で開発しているならどちらでも良いとは思いますが、他の人がソースを見た時の印象はちょっと違ってくるかもしれません。