Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more context to warnings emitted from Django when unpickling objects #381

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Tenzer
Copy link

@Tenzer Tenzer commented Apr 25, 2019

When upgrading Django, Django will emit a warning whenever an object is being
unpickled which was created with a different version of Django. This warning
isn't very easy to action as it doesn't contain any context about what object
it is or where it may have got the object from. The warning might look
something like this:

WARNING [2019-04-25 09:41:48,525] warnings: /path/to/virtualenv/lib/python3.7/site-packages/django_redis/serializers/pickle.py:35: RuntimeWarning: Pickled model instance's Django version 2.1.8 does not match the current version 2.2.
return pickle.loads(value)

This change will loop through each warning emitted during the deserialization
of the cached item and append the cache key to the warning which at least would
give some context as to why that is happening, so the warning message instead
becomes:

WARNING [2019-04-25 09:41:48,525] warnings: /path/to/virtualenv/lib/python3.7/site-packages/django_redis/serializers/pickle.py:35: RuntimeWarning: Pickled model instance's Django version 2.1.8 does not match the current version 2.2. (cache key: :1:user)
return pickle.loads(value)

given the cache key user.

When upgrading Django, Django will emit a warning whenever an object is being
unpickled which was created with a different version of Django. This warning
isn't very easy to action as it doesn't contain any context about what object
it is or where it may have got the object from. The warning might look
something like this:

> WARNING [2019-04-25 09:41:48,525] warnings: /path/to/virtualenv/lib/python3.7/site-packages/django_redis/serializers/pickle.py:35: RuntimeWarning: Pickled model instance's Django version 2.1.8 does not match the current version 2.2.
>   return pickle.loads(value)

This change will loop through each warning emitted during the deserialization
of the cached item and append the cache key to the warning which at least would
give some context as to why that is happening, so the warning message instead
becomes:

> WARNING [2019-04-25 09:41:48,525] warnings: /path/to/virtualenv/lib/python3.7/site-packages/django_redis/serializers/pickle.py:35: RuntimeWarning: Pickled model instance's Django version 2.1.8 does not match the current version 2.2. (cache key: :1:user)
>   return pickle.loads(value)

given the cache key `user`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant