2012-06-09T06:44:24Z

The Flask Mega-Tutorial, Part V: User Logins

(Great news! There is a new version of this tutorial!)

This is the fifth article in the series in which I document my experience writing web applications in Python using the Flask microframework.

The goal of the tutorial series is to develop a decently featured microblogging application that demonstrating total lack of originality I have decided to call microblog.

NOTE: This article was revised in September 2014 to be in sync with current versions of Python and Flask.

Here is an index of all the articles in the series that have been published to date:

Recap

In the previous chapter of the series we created our database and learned how to populate it with users and posts, but we haven't hooked up any of that into our app yet. And two chapters ago we've seen how to create web forms and left with a fully implemented login form.

In this article we are going to build on what we learned about web forms and databases and write our user login system. At the end of this tutorial our little application will register new users and log them in and out.

To follow this chapter along you need to have the microblog app as we left it at the end of the previous chapter. Please make sure the app is installed and running.

An Update Regarding the State of OpenID

It's been more than three years ago that I wrote this article. Back then OpenID seemed like a nice authentication method that was gaining a lot of traction, but in 2015 there are better alternatives, and OpenID is not as widely deployed as it used to be.

I do not have plans to update this tutorial in the near future, as I have written extensively about other authentication methods elsewhere. When you follow this tutorial keep in mind that Google, which was the most prominent OpenID provider in 2012, has dropped support for this protocol completely. My recommendation is to use a Yahoo account to test OpenID in this tutorial. I have a few personal projects that still use OpenID and I use Yahoo as a provider with good results.

As far as real-world authentication, I do not think it is a good idea to use OpenID, given the lack of support. I have a few resources for you that can help you create a more modern authentication experience:

  • My Flask book covers a traditional username and password implementation, complete with user registration, password reminders and resets.
  • My OAuth Authentication with Flask blog article describes in detail how to implement OAuth authentication, which has much wider support than OpenID. With this method you can implement "Login with Facebook" type functionality. The article demonstrates how to login with Facebook and Twitter. Others, such as Google, LinkedIn, etc. can be implemented easily with the same technique.

Configuration

As in previous chapters, we start by configuring the Flask extensions that we will use. For the login system we will use two extensions, Flask-Login and Flask-OpenID. Flask-Login will handle our users logged in state, while Flask-OpenID will provide authentication. These extensions are configured as follows (file app/__init__.py):

import os
from flask_login import LoginManager
from flask_openid import OpenID
from config import basedir

lm = LoginManager()
lm.init_app(app)
oid = OpenID(app, os.path.join(basedir, 'tmp'))

The Flask-OpenID extension requires a path to a temp folder where files can be stored. For this we provide the location of our tmp folder.

Python 3 Compatiblity

Unfortunately version 1.2.1 of Flask-OpenID (the current official version) does not work well with Python 3. Check what version you have by running the following command:

$ flask/bin/pip freeze

If you have a version newer than 1.2.1 then the problem is likely resolved, but if you have 1.2.1 and are following this tutorial on Python 3 then you have to install the development version from GitHub:

$ flask/bin/pip uninstall flask-openid
$ flask/bin/pip install git+git://github.com/mitsuhiko/flask-openid.git

Note that you need to have git installed for this to work.

Revisiting our User model

The Flask-Login extension expects certain properties and methods to be implemented in our User class. Outside of these there are no requirements for how the class has to be implemented.

Below is our Flask-Login friendly User class (file app/models.py):

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    nickname = db.Column(db.String(64), index=True, unique=True)
    email = db.Column(db.String(120), index=True, unique=True)
    posts = db.relationship('Post', backref='author', lazy='dynamic')

    @property
    def is_authenticated(self):
        return True

    @property
    def is_active(self):
        return True

    @property
    def is_anonymous(self):
        return False

    def get_id(self):
        try:
            return unicode(self.id)  # python 2
        except NameError:
            return str(self.id)  # python 3

    def __repr__(self):
        return '<User %r>' % (self.nickname)

The is_authenticated property has a misleading name. In general this method should just return True unless the object represents a user that should not be allowed to authenticate for some reason.

The is_active property should return True for users unless they are inactive, for example because they have been banned.

The is_anonymous property should return True only for fake users that are not supposed to log in to the system.

Finally, the get_id method should return a unique identifier for the user, in unicode format. We use the unique id generated by the database layer for this. Note that due to the differences in unicode handling between Python 2 and 3 we have to provide two alternative versions of this method.

User loader callback

Now we are ready to start implementing the login system using the Flask-Login and Flask-OpenID extensions.

First, we have to write a function that loads a user from the database. This function will be used by Flask-Login (file app/views.py):

@lm.user_loader
def load_user(id):
    return User.query.get(int(id))

Note how this function is registered with Flask-Login through the lm.user_loader decorator. Also remember that user ids in Flask-Login are always unicode strings, so a conversion to an integer is necessary before we can send the id to Flask-SQLAlchemy.

The login view function

Next let's update our login view function (file app/views.py):

from flask import render_template, flash, redirect, session, url_for, request, g
from flask_login import login_user, logout_user, current_user, login_required
from app import app, db, lm, oid
from .forms import LoginForm
from .models import User

@app.route('/login', methods=['GET', 'POST'])
@oid.loginhandler
def login():
    if g.user is not None and g.user.is_authenticated:
        return redirect(url_for('index'))
    form = LoginForm()
    if form.validate_on_submit():
        session['remember_me'] = form.remember_me.data
        return oid.try_login(form.openid.data, ask_for=['nickname', 'email'])
    return render_template('login.html', 
                           title='Sign In',
                           form=form,
                           providers=app.config['OPENID_PROVIDERS'])

Notice we have imported several new modules, some of which we will use later.

The changes from our previous version are very small. We have added a new decorator to our view function. The oid.loginhandler tells Flask-OpenID that this is our login view function.

At the top of the function body we check if g.user is set to an authenticated user, and in that case we redirect to the index page. The idea here is that if there is a logged in user already we will not do a second login on top.

The g global is setup by Flask as a place to store and share data during the life of a request. As I'm sure you guessed by now, we will be storing the logged in user here.

The url_for function that we used in the redirect call is defined by Flask as a clean way to obtain the URL for a given view function. If you want to redirect to the index page you may very well use redirect('/index'), but there are very good reasons to let Flask build URLs for you.

The code that runs when we get a data back from the login form is also new. Here we do two things. First we store the value of the remember_me boolean in the flask session, not to be confused with the db.session from Flask-SQLAlchemy. We've seen that the flask.g object stores and shares data though the life of a request. The flask.session provides a much more complex service along those lines. Once data is stored in the session object it will be available during that request and any future requests made by the same client. Data remains in the session until explicitly removed. To be able to do this, Flask keeps a different session container for each client of our application.

The oid.try_login call in the following line is the call that triggers the user authentication through Flask-OpenID. The function takes two arguments, the openid given by the user in the web form and a list of data items that we want from the OpenID provider. Since we defined our User class to include nickname and email, those are the items we are going to ask for.

The OpenID authentication happens asynchronously. Flask-OpenID will call a function that is registered with the oid.after_login decorator if the authentication is successful. If the authentication fails the user will be taken back to the login page.

The Flask-OpenID login callback

Here is our implementation of the after_login function (file app/views.py):

@oid.after_login
def after_login(resp):
    if resp.email is None or resp.email == "":
        flash('Invalid login. Please try again.')
        return redirect(url_for('login'))
    user = User.query.filter_by(email=resp.email).first()
    if user is None:
        nickname = resp.nickname
        if nickname is None or nickname == "":
            nickname = resp.email.split('@')[0]
        user = User(nickname=nickname, email=resp.email)
        db.session.add(user)
        db.session.commit()
    remember_me = False
    if 'remember_me' in session:
        remember_me = session['remember_me']
        session.pop('remember_me', None)
    login_user(user, remember = remember_me)
    return redirect(request.args.get('next') or url_for('index'))

The resp argument passed to the after_login function contains information returned by the OpenID provider.

The first if statement is just for validation. We require a valid email, so if an email was not provided we cannot log the user in.

Next, we search our database for the email provided. If the email is not found we consider this a new user, so we add a new user to our database, pretty much as we have learned in the previous chapter. Note that we handle the case of a missing nickname, since some OpenID providers may not have that information.

After that we load the remember_me value from the Flask session, this is the boolean that we stored in the login view function, if it is available.

Then we call Flask-Login's login_user function, to register this is a valid login.

Finally, in the last line we redirect to the next page, or the index page if a next page was not provided in the request.

The concept of the next page is simple. Let's say you navigate to a page that requires you to be logged in, but you aren't just yet. In Flask-Login you can protect views against non logged in users by adding the login_required decorator. If the user tries to access one of the affected URLs then it will be redirected to the login page automatically. Flask-Login will store the original URL as the next page, and it is up to us to return the user to this page once the login process completed.

For this to work Flask-Login needs to know what view logs users in. We can configure this in the app's module initializer (file app/__init__.py):

lm = LoginManager()
lm.init_app(app)
lm.login_view = 'login'

The g.user global

If you were paying attention, you will remember that in the login view function we check g.user to determine if a user is already logged in. To implement this we will use the before_request event from Flask. Any functions that are decorated with before_request will run before the view function each time a request is received. So this is the right place to setup our g.user variable (file app/views.py):

@app.before_request
def before_request():
    g.user = current_user

This is all it takes. The current_user global is set by Flask-Login, so we just put a copy in the g object to have better access to it. With this, all requests will have access to the logged in user, even inside templates.

The index view

In a previous chapter we left our index view function using fake objects, because at the time we did not have users or posts in our system. Well, we have users now, so let's hook that up:

@app.route('/')
@app.route('/index')
@login_required
def index():
    user = g.user
    posts = [
        { 
            'author': {'nickname': 'John'}, 
            'body': 'Beautiful day in Portland!' 
        },
        { 
            'author': {'nickname': 'Susan'}, 
            'body': 'The Avengers movie was so cool!' 
        }
    ]
    return render_template('index.html',
                           title='Home',
                           user=user,
                           posts=posts)

There are only two changes to this function. First, we have added the login_required decorator. This will ensure that this page is only seen by logged in users.

The other change is that we pass g.user down to the template, instead of the fake object we used in the past.

This is a good time to run the application.

When you navigate to http://localhost:5000 you will instead get the login page. Keep in mind that to login with OpenID you have to use the OpenID URL from your provider. You can use one of the OpenID provider links below the URL text field to generate the correct URL for you.

As part of the login process you will be redirected to your provider's web site, where you will authenticate and authorize the sharing of some information with our application (just the email and nickname that we requested, no passwords or other personal information will be exposed).

Once the login is complete you will be taken to the index page, this time as a logged in user.

Feel free to try the remember_me checkbox. With this option enabled you can close and reopen your web browser and will continue to be logged in.

Logging out

We have implemented the log in, now it's time to add the log out.

The view function for logging out is extremely simple (file app/views.py):

@app.route('/logout')
def logout():
    logout_user()
    return redirect(url_for('index'))

But we are also missing a link to logout in the template. We are going to put this link in the top navigation bar which is in the base layout (file app/templates/base.html):

<html>
  <head>
    {% if title %}
    <title>{{ title }} - microblog</title>
    {% else %}
    <title>microblog</title>
    {% endif %}
  </head>
  <body>
    <div>Microblog:
        <a href="{{ url_for('index') }}">Home</a>
        {% if g.user.is_authenticated %}
        | <a href="{{ url_for('logout') }}">Logout</a>
        {% endif %}
    </div>
    <hr>
    {% with messages = get_flashed_messages() %}
    {% if messages %}
    <ul>
    {% for message in messages %}
        <li>{{ message }} </li>
    {% endfor %}
    </ul>
    {% endif %}
    {% endwith %}
    {% block content %}{% endblock %}
  </body>
</html>

Note how easy it is to do this. We just needed to check if we have a valid user set in g.user and if we do we just add the logout link. We have also used the opportunity to use url_for in our template.

Final words

We now have a fully functioning user login system. In the next chapter we will be creating the user profile page and will be displaying user avatars on them.

In the meantime, here is the updated application code including all the changes in this article:

Download microblog-0.5.zip.

See you next time!

Miguel

217 comments

  • #151 Miguel Grinberg said 2014-10-17T06:02:54Z

    @Brian: OAuth is slightly more complicated, but it can be done. A good package for this that I have used in the past is rauth. I do not plan to update the tutorial in the near future, but I am planning a new article on OAuth.

  • #152 Federico said 2014-10-29T21:37:57Z

    Hi Miguel, thanks for your amazing tutorial. Are you planning to explain also the authentication process with Flask-Oauth? Because I would prefer this method rather than Open-ID. I saw in your book but there is also nothing about Oauth authentication and login in Flask. Thanks for your answer!

  • #153 Miguel Grinberg said 2014-10-30T17:39:08Z

    @Federico: OpenID is sort of losing ground. I'll be publishing an article on OAuth authentication with Flask in the near future, but it won't be part of this series.

  • #154 Jacob said 2014-11-02T21:48:37Z

    Hello! Thank you very very much for your tutorial, it's surely the best one in the web. I was able to create fully working microblog, awesome adventure for python-beginner, but I am getting really frustrated now because OpenID is very much depreciated. That would be so very cool if you could write an article about implementing flask-social instead of openid into microblog, do you think it's possible? Documentation of flask-social is somehow weird for beginners, your tutor skills are awesome and I am sure that all of us (your readers) would really appreciated if you could do it in a free moment.

    Thank you again and best regards.

  • #155 Miguel Grinberg said 2014-11-03T07:37:17Z

    @Jacob: I will be posting an article on OAuth authentication soon.

  • #156 Aleksandr said 2014-11-23T05:22:39Z

    Thank you!

  • #157 p.nagalakshmi said 2014-11-24T10:25:31Z

    sir i got an error to practice userlogins in flask.... File "run.py", line 2, in from app import app File "/home/satinos-pc-02/microblog/app/init.py", line 8, in from app import views, models File "/home/satinos-pc-02/microblog/app/views.py", line 40 form = LoginForm() ^ IndentationError: unindent does not match any outer indentation level

  • #158 Miguel Grinberg said 2014-11-26T00:23:52Z

    @p.nagalakshmi: the error is pretty clear, check your indentation.

  • #159 micheal said 2014-12-12T19:45:10Z

    hi miguel, i was wondering.. what changes do i need to make in order to do just a regular registration? i mean without openid

  • #160 Miguel Grinberg said 2014-12-14T00:59:52Z

    @micheal: I discuss regular username/password logins in very good detail in my book. The source code is freely available on github: https://github.com/miguelgrinberg/flasky

  • #161 Rick said 2014-12-15T23:37:26Z

    Thanks for the blog, yes people are still using it 2 years on! I was wondering f you have or planned on doing a version that doesnt use OpenId as it authentication? Or point me somewhere (other than the docs, im still learning!) that shows examples of logins

  • #162 Miguel Grinberg said 2014-12-17T17:25:35Z

    @Rick: my O'Reilly book and videos show how to create a standard username/password solution (http://flaskbook.com), and not too long ago I've written an article here regarding OAuth (http://blog.miguelgrinberg.com/post/oauth-authentication-with-flask).

  • #163 Aaron said 2015-01-08T05:49:53Z

    Dear Miguel, Many thanks for the tutorial. I have had great difficulty these past two days wrestling with OpenID. Simply put the open_id url passed was not being recognised, reaching this point in the flask_openid.py module:

    except discover.DiscoveryFailure: self.signal_error(u'The OpenID was invalid') return redirect(self.get_current_url())

    There's every chance some configuration on my computer (Mac OS, Yosimite (and reformatted in the past week!)) was causing an issue. I have worked around my issue by combining your other tutorial regarding OAuth with Facebook/Twitter into this one.

    Now on to the remainder of your tutorial! Thanks!

  • #164 Suresh said 2015-01-15T16:14:29Z

    Hey MG, awesome blog posts and tutorials! I had a question regarding Flask-Login and your HTTPAuth library. Are they mutually exclusive? Designed to work together? Etc?

    Basically, if I want to do token-based authentication and let Flask-Login handle.. .Well... Logins... Is that possible?

    Thanks!

  • #165 Miguel Grinberg said 2015-01-15T17:24:19Z

    @Suresh: Flask-Login is not a good match for a REST API. In an API you need to authenticate every request, so there is no need to maintain a user session or keep track of the logged in state of the user.

  • #166 Andrii said 2015-01-17T18:43:51Z

    For all those who has issue: ImportError: cannot import name lm Pay attention in app__init__.py line with import "from app import views, models" should follow after position where lm object is being created and all operation with it accomplished I've placed "from app import views, models" as last line, and that fixed the problem.

    p.s. Awesome tut! Thanks Miguel

  • #167 Chris said 2015-01-25T19:09:07Z

  • #168 Miguel Grinberg said 2015-01-26T01:44:50Z

    @Chris: I don't have plans to update this tutorial at this time, since there are other OpenID providers that still work. I do agree that using OpenID is not a good idea, though, that is why I have blogged about using OAuth with Flask: http://blog.miguelgrinberg.com/post/oauth-authentication-with-flask

  • #169 Vivek said 2015-01-29T15:06:42Z

    Hi ,

    I am a beginner to python as well as flask, so may be my error sound stupid. While i am compiling init.py it is showing "no module named config".

    Not sure what to do and stuck here.

  • #170 Miguel Grinberg said 2015-02-01T03:17:41Z

    @Vivek: you are probably starting the application from the wrong directory. Your current directory should be the root directory, where config.py is.

  • #171 Michael said 2015-02-03T02:01:16Z

    I just ran into the same issue with "ImportError: cannot import name 'lm'". I managed to trace the issue back to the code in app/init.py, where made a rather newbie mistake of adding all the new code from this lesson AFTER "from app import views, models". Of course, since app/views.py imports has "from app import app, db, lm, oid", initializing "lm = LoginManager()" needs to come BEFORE app/views tries to import it.

    THEN I ran into another issue "ImportError: No module named 'forms'". It seems these two lines in app/views.py...

    from forms import LoginForm from models import User

    ...need to be changed to from app.forms import LoginForm from app.models import User

    Given that the previous chapters of the tutorial say to create the both forms.py and models.py in the app/ folder, I'm not sure how no one else commented on this. Is this just me being a newbie to Flask? Is there something else I missed that allowed everyone else to get the code to work as is?

    (Otherwise, I'm really enjoying this tutorial so far!)

  • #172 Brandon said 2015-02-07T22:02:35Z

    This is one of the worst tutorials I've ever read. The content is good, but the organization is so frustrating I'm going to have to quit. No real mention of what code is being changed, no hints to the organization of the code itself "(does this go before or after this block of code...oh, this part goes here and part goes here"). Really disappointed.

  • #173 Miguel Grinberg said 2015-02-08T00:21:34Z

    @Brandon: Did you notice there is a Github project where the entire working code for each chapter is hosted?

  • #174 Dilshad Abdulla said 2015-02-13T13:29:55Z

    Hi Miguel

    I follow your blog from beginning read and write the code line by line so far working good at the end of part v I have an error which I am not sure what is wrong. I have checked many times can't find any error to fix it myself and I don't like copy your code if not type own code not able to learn, could you please give a tip as an idea please? Here is the error: ValueError

    ValueError: invalid key 'username' App/venv/lib/python2.7/site-packages/flask_openid.py", line 495, in decorated [Display the sourcecode for this frame] [Open an interactive python shell in this frame] return f(args, *kwargs)

    App/views.py", line 49, in login [Display the sourcecode for this frame] [Open an interactive python shell in this frame] return oid.try_login(form.openid.data, ask_for=['username', 'email'])

    App/venv/lib/python2.7/site-packages/flask_openid.py", line 540, in try_login raise ValueError('invalid key %r' % key)

    Many thanks.

  • #175 Miguel Grinberg said 2015-02-13T19:32:44Z

    @Dilshad: you don't have to copy my code, but you can at least compare it to find the mistake. Try using 'nickname' instead of 'username'.