Экземпляр объекта Python не сохраняется в контексте приложения Flask - PullRequest
0 голосов
/ 06 марта 2019

Я сделал простое расширение Flask, включающее Клиент Google API для Python :

class ProximityBeaconAPI:
    '''
    Simple Flask extension for accessing Google Proxmity Beacon API.
    https://developers.google.com/resources/api-libraries/documentation/proximitybeacon/v1beta1/python/latest/
    '''

    def __init__(self, app=None, credentials=None):
        if app:
            self.init_app(app)
        if credentials:
            self.init_api(credentials)

    def init_app(self, app):
        '''
        Initialize Flask app for extension
        '''
        self.app = app
        self._project_id = app.config.PROJECT_ID

    @property
    def is_initialized(self):
        '''
        Checks if Proximity Beacon API is initialized.

        :return: bool
        '''
        ctx = _app_ctx_stack.top
        return hasattr(ctx, 'proximitybeaconapi')


    def init_api(self, credentials):
        ''' Initialize Proximity Beacon API

        :param credentials: google.oauth2.credentials.Credentials object  
        '''
        proximitybeaconapi = discovery.build(
            OAUTH2.API_NAME, OAUTH2.API_VERSION, credentials=credentials)
        ctx = _app_ctx_stack.top
        if ctx is not None:
            if not hasattr(ctx, 'proximitybeaconapi'):
                ctx.proximitybeaconapi = proximitybeaconapi

    def get_utoken(self):
        ''' Checks if for beacon with given name u_token attachment
        is set.

        :param beacon_name: name of the beacon
        :param namespace: namespace
        '''
        beacon_name = self.get_default_auth_beacon_name()
        ctx = _app_ctx_stack.top
        namespace = self.get_default_project_namespace().split('/')[1]
        namespaced_type = '{}/u_token'.format(namespace)
        query = {
            'beaconName': beacon_name,
            'namespacedType': namespaced_type
        }
        resp = ctx.proximitybeaconapi.beacons().attachments().list(**query).execute()
        b64_data = resp['attachments'][0]['data']
        return self._base64_to_str(b64_data)

    def is_utoken_valid(self, u_token):
        ''' Checks if recieved token is valid with current
        u_token attachment.

        :param u_token: incomming u_token
        :return: True or False
        '''
        incomming_token = self._base64_to_str(u_token)
        current_token = self.get_utoken()
        return incomming_token == current_token

В моем представлении обратного вызова oauth2 я инициализирую API Google, вызывая метод init_api, который на основе учетных данных создает экземпляр клиента API:

def init_api(self, credentials):
     ''' Initialize Proximity Beacon API
     :param credentials: google.oauth2.credentials.Credentials object  
     '''
     proximitybeaconapi = discovery.build(
         OAUTH2.API_NAME, OAUTH2.API_VERSION, credentials=credentials)
     ctx = _app_ctx_stack.top
     if ctx is not None:
         if not hasattr(ctx, 'proximitybeaconapi'):
             ctx.proximitybeaconapi = proximitybeaconapi

Затем в другой моей конечной точке я вызываю метод get_token, который использует инициализированную ранее клиентскую библиотеку. Моя конечная точка

def post(self):
    data = api.payload
    u_token = data.pop('u_token')
    token = beaconapi.get_utoken()
    # other code ...

get_utoken метод, который использует клиента:

def get_utoken(self):
    ''' Checks if for beacon with given name u_token attachment
    is set.
    :param beacon_name: name of the beacon
    :param namespace: namespace
    '''
    beacon_name = self.get_default_auth_beacon_name()
    ctx = _app_ctx_stack.top # getting client from application context
    # ...
    response = ctx.proximitybeaconapi.beacons().attachments().list(**query)
    return response

Но я получаю AttributeError: 'AppContext' object has no attribute 'proximitybeaconapi' несмотря на ошибку Я установил этот атрибут в контексте приложения ранее:

  File "/home/devaerial/Source/automoticz-server/automoticz/utils/beacons.py", line 61, in get_default_auth_beacon_name
    response = ctx.proximitybeaconapi.beacons().list(q=query).execute()
AttributeError: 'AppContext' object has no attribute 'proximitybeaconapi'

Похоже, ctx контекст не сохранил мой proximitybeaconapi экземпляр клиента, когда я установил его с помощью init_api при вызове последней конечной точки

Что я здесь не так делаю?

P.S .: Я следовал этому примеру из официальных документов Flask.

1 Ответ

0 голосов
/ 12 марта 2019

Нашли решение проблемы без использования _app_ctx_stack. Использовал этот подход с использованием app.extensions объекта, где приложение Flask хранит все ссылки на расширения и немного перестраивает мой код:

def init_api(self, credentials):
    ''' Initialize Proximity Beacon API

    :param credentials: google.oauth2.credentials.Credentials object  
    '''
    proximitybeaconapi = discovery.build(
           OAUTH2.API_NAME, OAUTH2.API_VERSION, credentials=credentials)
    self.app.extensions['api'] = proximitybeaconapi

Теперь, если я хочу позвонить клиенту Goolge API, я просто получаю его ссылку от extensions

def get_pin(self):
    ''' Checks if for beacon with given name pin attachment
    is set.

    :param beacon_name: name of the beacon
    :param namespace: namespace
    '''
    beacon_name = self.get_default_auth_beacon_name()
    api = self.app.extensions.get('api')
    namespace = self.get_default_project_namespace().split('/')[1]
    namespaced_type = '{}/pin'.format(namespace)
    query = {'beaconName': beacon_name, 'namespacedType': namespaced_type}
    resp = api.beacons().attachments().list(**query).execute()
    b64_data = resp['attachments'][0]['data']
    return self._base64_to_str(b64_data)
...