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.request = req

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

    async def json(self):
        try:
            return self.request.get_json()
        except Exception:
            return {}

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

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

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

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

    def get_session(self):
        from flask import g
        if hasattr(g, 'supertokens'):
            return g.supertokens
        return None

    def set_session(self, session):
        from flask import g
        g.supertokens = session

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

    async def form_data(self):
        return self.request.form.to_dict()

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.request = req

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

    async def json(self):
        try:
            return self.request.get_json()
        except Exception:
            return {}

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

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

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

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

    def get_session(self):
        from flask import g
        if hasattr(g, 'supertokens'):
            return g.supertokens
        return None

    def set_session(self, session):
        from flask import g
        g.supertokens = session

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

    async def form_data(self):
        return self.request.form.to_dict()

Ancestors

BaseRequest
abc.ABC

Methods

async def form_data(self)

Expand source code

async def form_data(self):
    return self.request.form.to_dict()

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

Expand source code

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

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

Expand source code

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

def get_path(self) ‑> str

Expand source code

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

def get_query_param(self, key, default=None)

Expand source code

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

def get_session(self)

Expand source code

def get_session(self):
    from flask import g
    if hasattr(g, 'supertokens'):
        return g.supertokens
    return None

async def json(self)

Expand source code

async def json(self):
    try:
        return self.request.get_json()
    except Exception:
        return {}

def method(self) ‑> str

Expand source code

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

def set_session(self, session)

Expand source code

def set_session(self, session):
    from flask import g
    g.supertokens = session

def url(self)

Expand source code

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