Djangoのキャッシュ(cache)にはキーを文字列として指定しましょう。
>>> from django.core.cache import cache >>> cache.get("mykey") # OK >>> cache.get("1") # OK >>> cache.get(1) # よくない
キャッシュバックエンドの実装によっては数値でも指定できますが、ドキュメントでは「キーは必ず文字列で」とあります。
key should be a str, and value can be any picklable Python object.
だいたいのキャッシュバックエンドでは make_key を内部で先に実行するので、数値だろうが文字列に変換されるのであまり問題にはなりません。 例えば以下のような処理でも問題になっていない場合もあります。
>>> from django.core.cache import caches >>> cache = caches["somemycache"] >>> cache.set(1, "users-value")
user.id
をキーとして使ってしまったときなど、キーを数値として渡してしまいます。
ちゃんと str(...)
としておきましょう 。
Django2.2から、DBバックエンド(DatabaseCache)を使っているときに cache.get(1)
、 cache.delete(1)
をするとTypeErrorになります。
>>> cache = caches["..."] <django.core.cache.backends.db.DatabaseCache object at 0x7f2d5ce37ac8> >>> cache.get(1) Traceback (most recent call last): File "/usr/lib/python3.7/code.py", line 90, in runcode exec(code, self.locals) File "<console>", line 1, in <module> File "/home/hirokiky/.../venv/lib/python3.7/site-packages/django/core/cache/backends/db.py", line 52, in get return self.get_many([key], version).get(key, default) File "/home/hirokiky/.../venv/lib/python3.7/site-packages/django/core/cache/backends/db.py", line 60, in get_many self.validate_key(key) File "/home/hirokiky/.../venv/lib/python3.7/site-packages/django/core/cache/backends/base.py", line 245, in validate_key if len(key) > MEMCACHE_MAX_KEY_LENGTH:
ここの validate_key
が make_key
より前に呼ばれるよう動作に2.2からなっていて、エラーになります。
django/db.py at 2.2.3 · django/django · GitHub
もちろんこの動作はバグではありません。もともと、cache.get
などのキーには文字列を渡すべきです。
ですが、今まで動作していたり他のLocMemBackendでは数値でも動作していたりで問題に気づきにくいです。気をつけてください。
一応、DjangoのTracに「Release Noteにこのことを書いたら」と起票しましたが、まぁ仕様どおり使ってないのが悪いので却下されるかなぁとは思っています。
#30625 (DatabaseCache backend raises TypeError if get/delete received key as integer.) – Django