Module `supertokens_python.framework.flask.flask_request`

Expand source code

# Copyright (c) 2021, VRAI Labs and/or its affiliates. All rights reserved.
#
# This software is licensed under the Apache License, Version 2.0 (the
# "License") as published by the Apache Software Foundation.
#
# You may not use this file except in compliance with the License. You may
# obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.

from typing import Any, Union
from supertokens_python.framework.request import BaseRequest


class FlaskRequest(BaseRequest):

    def __init__(self, req):
        super().__init__()
        self.req = req

    def get_query_param(self, key, default=None):
        self.req.args.get(key)

    def json(self):
        return self.req.get_json()

    def method(self) -> str:
        if isinstance(self.req, dict):
            return self.req['REQUEST_METHOD']
        return self.req.method

    def get_cookie(self, key: str) -> Union[str, None]:
        return self.req.cookies.get(key, None)

    def get_header(self, key: str) -> Any:
        if isinstance(self.req, dict):
            return self.req.get(key, None)
        return self.req.headers.get(key)

    def url(self):
        return self.req.url

    def get_session(self):
        return self.req.environ['additional_storage']

    def set_session(self, session):
        if session is None:
            self.req.environ['additional_storage'] = None
        else:
            self.req.environ['additional_storage'] = {
                'new_access_token_info': session['new_access_token_info'],
                'new_anti_csrf_token': session['new_anti_csrf_token'],
                'new_id_refresh_token_info': session['new_id_refresh_token_info'],
                'new_refresh_token_info': session['new_refresh_token_info'],
                'remove_cookies': session['remove_cookies'],
                'user_id': session['user_id'],
                'jwt_payload': session['jwt_payload'],
            }

    def get_path(self) -> str:
        if isinstance(self.req, dict):
            return self.req['PATH_INFO']
        return self.req.base_url

Classes

class FlaskRequest (req)

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code

class FlaskRequest(BaseRequest):

    def __init__(self, req):
        super().__init__()
        self.req = req

    def get_query_param(self, key, default=None):
        self.req.args.get(key)

    def json(self):
        return self.req.get_json()

    def method(self) -> str:
        if isinstance(self.req, dict):
            return self.req['REQUEST_METHOD']
        return self.req.method

    def get_cookie(self, key: str) -> Union[str, None]:
        return self.req.cookies.get(key, None)

    def get_header(self, key: str) -> Any:
        if isinstance(self.req, dict):
            return self.req.get(key, None)
        return self.req.headers.get(key)

    def url(self):
        return self.req.url

    def get_session(self):
        return self.req.environ['additional_storage']

    def set_session(self, session):
        if session is None:
            self.req.environ['additional_storage'] = None
        else:
            self.req.environ['additional_storage'] = {
                'new_access_token_info': session['new_access_token_info'],
                'new_anti_csrf_token': session['new_anti_csrf_token'],
                'new_id_refresh_token_info': session['new_id_refresh_token_info'],
                'new_refresh_token_info': session['new_refresh_token_info'],
                'remove_cookies': session['remove_cookies'],
                'user_id': session['user_id'],
                'jwt_payload': session['jwt_payload'],
            }

    def get_path(self) -> str:
        if isinstance(self.req, dict):
            return self.req['PATH_INFO']
        return self.req.base_url

Ancestors

BaseRequest
abc.ABC

Methods

def get_cookie(self, key: str) ‑> Optional[str]

Expand source code

def get_cookie(self, key: str) -> Union[str, None]:
    return self.req.cookies.get(key, None)

def get_header(self, key: str) ‑> Any

Expand source code

def get_header(self, key: str) -> Any:
    if isinstance(self.req, dict):
        return self.req.get(key, None)
    return self.req.headers.get(key)

def get_path(self) ‑> str

Expand source code

def get_path(self) -> str:
    if isinstance(self.req, dict):
        return self.req['PATH_INFO']
    return self.req.base_url

def get_query_param(self, key, default=None)

Expand source code

def get_query_param(self, key, default=None):
    self.req.args.get(key)

def get_session(self)

Expand source code

def get_session(self):
    return self.req.environ['additional_storage']

def json(self)

Expand source code

def json(self):
    return self.req.get_json()

def method(self) ‑> str

Expand source code

def method(self) -> str:
    if isinstance(self.req, dict):
        return self.req['REQUEST_METHOD']
    return self.req.method

def set_session(self, session)

Expand source code

def set_session(self, session):
    if session is None:
        self.req.environ['additional_storage'] = None
    else:
        self.req.environ['additional_storage'] = {
            'new_access_token_info': session['new_access_token_info'],
            'new_anti_csrf_token': session['new_anti_csrf_token'],
            'new_id_refresh_token_info': session['new_id_refresh_token_info'],
            'new_refresh_token_info': session['new_refresh_token_info'],
            'remove_cookies': session['remove_cookies'],
            'user_id': session['user_id'],
            'jwt_payload': session['jwt_payload'],
        }

def url(self)

Expand source code

def url(self):
    return self.req.url