web-dev-qa-db-ja.com

Python Flask:ユーザーセッションを追跡しますか?セッションCookie IDを取得する方法は?

学習活動の一環として、簡単なwebappを構築したいと思います。 Webappは、初めての訪問者に遭遇した場合、email_idを入力するようにユーザーに要求することになっています。

ユーザーベースのWebアプリを作成するのはこれが初めてです。私は心の中で青写真を持っていますが、それを実装する方法を理解することはできません。主に、ユーザーCookieの収集方法に関して混乱しています。さまざまなチュートリアルとflask_loginを検討しましたが、実装するものは、flask_loginが実装しているものと比べてはるかに簡単だと思います。

また、flask.sessionしかし、それは理解するのが少し難しく、私は欠陥のある実装になりました。

ここに私がこれまでに持っているものがあります(これは初歩的なものであり、私のユースケースを伝えることを意図しています):

from flask import render_template, request, redirect, url_for


@app.route("/", methods= ["GET"])
def first_page():
  cookie = response.headers['cookie']
  if database.lookup(cookie):
   user = database.get(cookie) # it returns user_email related to that cookie id 
  else:
    return redirect_url(url_for('login'))
  data = generateSomeData() # some function
  return redirect(url_for('do_that'), user_id, data, stats)

@app.route('/do_that', methods =['GET'])
def do_that(user_id):
  return render_template('interface.html', user_id, stats,data) # it uses Jinja template

@app.route('/submit', methods =["GET"])
def submit():
  # i want to get all the information here
  user_id = request.form['user_id']# some data
  answer = request.form['answer'] # some response to be recorded
  data = request.form['data'] # same data that I passed in do_that to keep 
  database.update(data,answer,user_id)
  return redirect(url_for('/do_that'))

@app.route('/login', methods=['GET'])
def login():
  return render_template('login.html')

@app.route('/loggedIn', methods =['GET'])
def loggedIn():
  cookie = response.headers['cookie']
  user_email = response.form['user_email']
  database.insert(cookie, user_email)
  return redirect(url_for('first_page'))
15
pg2455

request.cookies辞書 を介してリクエストCookieにアクセスし、make_responseを使用するか、変数にrender_templateを呼び出して呼び出した結果を保存するだけでCookieを設定できます- set_cookie応答オブジェクト

@app.route("/")
def home():
    user_id = request.cookies.get('YourSessionCookie')
    if user_id:
        user = database.get(user_id)
        if user:
            # Success!
            return render_template('welcome.html', user=user)
        else:
            return redirect(url_for('login'))
    else:
        return redirect(url_for('login'))

@app.route("/login", methods=["GET", "POST"])
def login():
    if request.method == "POST":
        # You should really validate that these fields
        # are provided, rather than displaying an ugly
        # error message, but for the sake of a simple
        # example we'll just assume they are provided

        user_name = request.form["name"]
        password = request.form["password"]
        user = db.find_by_name_and_password(user_name, password)

        if not user:
            # Again, throwing an error is not a user-friendly
            # way of handling this, but this is just an example
            raise ValueError("Invalid username or password supplied")

        # Note we don't *return* the response immediately
        response = redirect(url_for("do_that"))
        response.set_cookie('YourSessionCookie', user.id)
        return response

@app.route("/do-that")
def do_that():
    user_id = request.cookies.get('YourSessionCookie')
    if user_id:
        user = database.get(user_id)
        if user:
            # Success!
            return render_template('do_that.html', user=user)
        else:
            return redirect(url_for('login'))
    else:
        return redirect(url_for('login'))

コードを乾燥させる

これで、homeメソッドとdo_thatメソッドにボイラープレートのlotがあり、すべてログインに関連していることに注意してください。 。独自のデコレータを記述することで、これを回避できます(詳細については、 デコレータとは を参照してください):

from functools import wraps
from flask import flash

def login_required(function_to_protect):
    @wraps(function_to_protect)
    def wrapper(*args, **kwargs):
        user_id = request.cookies.get('YourSessionCookie')
        if user_id:
            user = database.get(user_id)
            if user:
                # Success!
                return function_to_protect(*args, **kwargs)
            else:
                flash("Session exists, but user does not exist (anymore)")
                return redirect(url_for('login'))
        else:
            flash("Please log in")
            return redirect(url_for('login'))
    return wrapper

homeメソッドとdo_thatメソッドはmuch短くなります:

# Note that login_required needs to come before app.route
# Because decorators are applied from closest to furthest
# and we don't want to route and then check login status

@app.route("/")
@login_required
def home():
    # For bonus points we *could* store the user
    # in a thread-local so we don't have to hit
    # the database again (and we get rid of *this* boilerplate too).
    user = database.get(request.cookies['YourSessionCookie'])
    return render_template('welcome.html', user=user)

@app.route("/do-that")
@login_required
def do_that():
    user = database.get(request.cookies['YourSessionCookie'])
    return render_template('welcome.html', user=user)

提供されているものを使用する

Cookieに特定の名前を付ける必要がない場合、 flask.session を使用することをお勧めします既に多くの機能が組み込まれています(改ざんされないように署名されているため、HTTPのみに設定できます)。これにより、login_requiredデコレータがさらに乾燥します。

# You have to set the secret key for sessions to work
# Make sure you keep this secret
app.secret_key = 'something simple for now' 

from flask import flash, session

def login_required(function_to_protect):
    @wraps(function_to_protect)
    def wrapper(*args, **kwargs):
        user_id = session.get('user_id')
        if user_id:
            user = database.get(user_id)
            if user:
                # Success!
                return function_to_protect(*args, **kwargs)
            else:
                flash("Session exists, but user does not exist (anymore)")
                return redirect(url_for('login'))
        else:
            flash("Please log in")
            return redirect(url_for('login'))

そして、個々のメソッドは次の方法でユーザーを取得できます。

user = database.get(session['user_id'])
32
Sean Vieira