TIL_220520_팀 프로젝트 flask_blueprint

이번 머신러닝 팀 프로젝트 발제 중 도전과제인 flask-blueprint 를 적용시켜 보았다.

 

가장 먼저 blueprint 가 뭔지 알아보자.

 

Blueprint 란

기본적인 매우 간단한 구조의 웹 애플리케이션에서 시작해 실제로 서비스할 웹 애플리케이션을 개발한다면 코드가 길어지면서 복잡해져 기능을 찾기 다소 어려워진다. 또한 한 서비스가 플라스크 확장을 포함해 여러 개의 플라스크 애플리케이션을 가지게 되는 경우도 있다.

​

이때 플라스크에서는 블루프린트(Blueprint) 객체를 사용한다. 앞서 언급한 것처럼 블루프린트 객체는 큰 애플리케이션을 단순화시키고 확장 프로그램과 라이브러리 등록을 위한 중심 수단으로도 사용된다. 디장고(Django)와 달리 url들을 데코레이터를 붙여 관리하기 때문에 기능이 필요할 때마다 계속 추가해야 하는 번거로움도 해결해준다.

​

플라스크 블루프린트에서 제공하는 기능은 다음과 같다.

- 블루프린트별 URL 규칙 설정 (접두어 및 서브도메인)

- 블루프린트별 URL 핸들러 설정 (before_request 등)

- 블루프린트별 정적 파일 및 템플릿 필터와 폴더 설정

[출처] [Python Flask] #20 플라스크 모듈화, 블루프린트 Blueprint|작성자 넬티아

 

라고 한다. 

 

쉽게 말해서 윈도우의 게임은 게임별로 사진은 사진별로 등 깔끔하게 폴더를 정리 하듯이 프로젝트 파일들도 정리해주는 것을 말한다.

 

어떻게 적용시켰는지 한 번 보자.

 

run.py

실행하는 포트를 지정한다.

from main import app


if __name__ == '__main__':
    app.run('0.0.0.0', port=9999, debug=True)

 

 

__init__.py

app 의 객체 선언, 각종 모듈, 데이터베이스, 블루프린트 설정

app.register_blueprint() 를 통해 연결

# app 객체 선언, 각종 모듈, 데이터베이스, 블루프린트 설정
from datetime import datetime, timedelta
from functools import wraps
import hashlib
import json
import re
from unittest import result
from bson import ObjectId
from flask import Flask, abort, jsonify, request, Response, Blueprint
from flask_cors import CORS  # flask 연결
from pymongo import MongoClient  # DB
import jwt
# from flask import g


from . import member  # member 호출


# 객체 선언
app = Flask(__name__)  # app 객체 선언
cors = CORS(app, resources={r"*": {"origins": "*"}})
client = MongoClient('localhost', 27017)
db = client.ladder


# url 연결
app.register_blueprint(member.blueprint)

 

config.py(DB, 시크릿키 등)

공통적으로 사용되는 DB 를 함수화 하여 return 해준다.

from pymongo import MongoClient  # DB

SECRET_KEY = ''

def get_db():
    client = MongoClient('localhost', 27017)
    return client.ladder

def get_key():
    return SECRET_KEY

 

member.py (연결하고자 하는 .py)

실행하고자 하는 함수를 모아둔 경로를 @blueprint.route() 으로 변경하고,

__init__.py 로 넘겨줄 blueprint = Blueprint("member", __name__, url_prefix='') 객체를 정의한다.

from main import *
from flask import Blueprint

from . import config


db = config.get_db()
SECRET_KEY = config.get_key()


blueprint = Blueprint("member", __name__, url_prefix='')


@blueprint.route('/')
@authorize  # decorated 함수 적용
def index(user):
    # print(user)
    return jsonify({'message': 'success'})

 

 

 

어려웠던 점

구글링을 통해서 적용 방법에 대해서 많이 찾아보았는데 생각보다 너무 단순하게 알려진 느낌이였는데 막상 적용해보니 어렵더라.

 

1) DB 연결 문제 & SECRET_KEY

__init__.py 에 한번에 다 넣어주면 되는 줄로만 알았는데, 안되더라. 그래서 튜터님께 질문해보니 db.py 만의 파일로 만들어 함수로 쏴주면 어떨까 하셔서 해봤다. 잘 되었다 ^^

 

2) from & import 할 부분을 꼭꼭 확인할 것

결국 파일마다 연결해주는 역할을 하고 있는 from & import 는 자칫 오타를 내어서 에러가 나는 상황을 내용 탓으로 볼 수 있기 때문에 꼭꼭 위에도 확인할 필요가 있다.