Django 2, python 3.4 cannot decode urlsafe_base64_decode(uidb64)

Question

i am trying to activate a user by email, email works, encoding works, i used an approach from django1.11 which was working successfully.

In Django 1.11 the following decodes successfully to 28, where uidb64 = b'Mjg'

force_text(urlsafe_base64_decode(uidb64))

In django 2 (2, 0, 0, 'final', 0) the above code decode does not work and results in an error

django.utils.encoding.DjangoUnicodeDecodeError: 'utf-8' codec can't decode byte 0xc8 in position 1: invalid continuation byte. You passed in b'l\xc8\xe0' (<class 'bytes'>)

I am also posting my views just in case

from django.utils.encoding import force_bytes, force_text
from django.utils.http import urlsafe_base64_encode, urlsafe_base64_decode    
def signup(request):
    if request.method == 'POST':
        form = SignUpForm(request.POST)
        if form.is_valid():
            user = form.save(commit=False)
            user.is_active = False
            user.save()
            # auth_login(request, user)
            message = render_to_string('user_activate_email.html', {
                'user': user,
                'domain': Site.objects.get_current().domain,
                'uidb64': urlsafe_base64_encode(force_bytes(user.pk)),
                'token': account_activation_token.make_token(user),
            })
            mail_subject = 'Activate your blog account.'
            to_email = form.cleaned_data.get('email')
            email = EmailMessage(mail_subject, message, to=[to_email])
            email.send()
            messages.info(
                request, 'Activation link has been sent to your email!')
            # return redirect('home')
            return render(request, 'index.html')
    else:
        form = SignUpForm()
        return render(request, 'user_action.html', {'form': form})


def activate(request, uidb64, token):
    try:
        import pdb;
        pdb.set_trace()
        uid = urlsafe_base64_decode(uidb64).decode()
        user = User.objects.get(pk=uid)
    except(TypeError, ValueError, OverflowError):
        user = None
    if user is not None and account_activation_token.check_token(user, token):

        user.refresh_from_db()
        user.is_active = True

        user.save()
        auth_login(request, user)
        messages.info(request, 'Your account has been activated successfully!')
        return redirect('events:home')
    else:
        messages.info(
            request, 'Activation link is invalid or has been activated')
        return redirect('events:home')

PS: This is just a trial before i work with CBV.

edit: including traceback

System check identified no issues (0 silenced).
December 15, 2017 - 05:51:01
Django version 2.0, using settings 'event_management.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.
> /home/vipinmohan/django2-0/event/event_management/users/views.py(88)activate()
-> uid = urlsafe_base64_decode(uidb64).decode()
(Pdb) n
UnicodeDecodeError: 'utf-8' codec can't decode byte 0xcc in position 1: invalid continuation byte
> /home/vipinmohan/django2-0/event/event_management/users/views.py(88)activate()
-> uid = urlsafe_base64_decode(uidb64).decode()
(Pdb) n
> /home/vipinmohan/django2-0/event/event_management/users/views.py(90)activate()
-> except(TypeError, ValueError, OverflowError):
(Pdb) n
> /home/vipinmohan/django2-0/event/event_management/users/views.py(91)activate()
-> user = None
(Pdb) 

With

Please show the full traceback. – Glorygloryofthesnow

can you please specify what you are trying to do ? the question is unclear that it states a general problem get the problem you are trying to solve and please do add full traceback which might be helpful in guiding you – Curative

I have included the traceback. I am trying to activate user by an activation email. When i click on the link, it doesn't work. By using pdb.set_trace(), unicode decode error is thrown. – With

Answer 1

Ok. after hour long search (still beginner at python django), a relevant change was pointed in release notes whose definitions were little difficult for a newcomer. https://docs.djangoproject.com/en/2.0/releases/2.0/#removed-support-for-bytestrings-in-some-places

To support native Python 2 strings, older Django versions had to accept both bytestrings and unicode strings. Now that Python 2 support is dropped, bytestrings should only be encountered around input/output boundaries (handling of binary fields or HTTP streams, for example). You might have to update your code to limit bytestring usage to a minimum, as Django no longer accepts bytestrings in certain code paths.

For example, reverse() now uses str() instead of force_text() to coerce the args and kwargs it receives, prior to their placement in the URL. For bytestrings, this creates a string with an undesired b prefix as well as additional quotes (str(b'foo') is "b'foo'"). To adapt, call decode() on the bytestring before passing it to reverse().

Totally unable to work on its implications, i had to go deeper into the actual django core code.

So from django 1.11 to 2.0 the encode change is as follows

'uid': urlsafe_base64_encode(force_bytes(user.pk)),

to

'uid': urlsafe_base64_encode(force_bytes(user.pk)).decode(),

and decode from

uid = force_text(urlsafe_base64_decode(uidb64))

to

 uid = urlsafe_base64_decode(uidb64).decode()

Thats it. Hope this helps someone.

*************EDIT******************

As of Django 2.2

django.utils.http.urlsafe_base64_encode() now returns a string instead of a bytestring.

And django.utils.http.urlsafe_base64_decode() may no longer be passed a bytestring.

Thanks to Hillmark for pointing it out

With

Changed in 2.2 and now returns a string instead of a bytestring docs.djangoproject.com/en/2.2/releases/2.2/#miscellaneous – Erupt