[flask] Do it 점프 투 플라스크 _ 2. 프로젝트 구조 및 개념 이해

출처 :https://wikidocs.net/81044

---

출처 : https://velog.io/

해당 자료 및 실습은 모두 위키독스(점프 투 플라스크) 내용을 참고 후 작성한 것입니다.

---

 

 

* 아래는 각 파일이 어떠한 기능을 하는지 나타낸 것이다. (출처 : 위키독스)

데이터베이스를 처리하는 models.py 파일

파이보 프로젝트는 ORM(object relational mapping)을 지원하는 파이썬 데이터베이스 도구인 SQLAlchemy를 사용한다. SQLAlchemy는 모델 기반으로 데이터베이스를 처리한다. 지금은 모델 기반으로 데이터베이스를 처리한다는 말이 이해되지 않겠지만, 이후 프로젝트를 진행하면 잘 알 수 있을 것이다. 아무튼 지금 여러분이 알아야 할 내용은 파이보 프로젝트에는 "모델 클래스들을 정의할 models.py 파일이 필요하다"는 것이다.

 

서버로 전송된 폼을 처리하는 forms.py 파일

파이보 프로젝트는 웹 브라우저에서 서버로 전송된 폼을 처리할 때 WTForms라는 라이브러리를 사용한다. WTForms 역시 모델 기반으로 폼을 처리한다. 그래서 폼 클래스를 정의할 forms.py 파일이 필요하다.

 

화면을 구성하는 views 디렉터리

pybo.py 파일에 작성했던 hello_pybo 함수의 역할은 화면 구성이었다. views 디렉터리에는 바로 이런 함수들로 구성된 뷰 파일들을 저장한다. 파이보 프로젝트에는 기능에 따라 main_views.py, question_views.py, answer_views.py 등의 뷰 파일을 만들 것이다.

 

CSS, 자바스크립트, 이미지 파일을 저장하는 static 디렉터리

static 디렉터리는 파이보 프로젝트의 스타일시트(.css), 자바스크립트(.js) 그리고 이미지 파일(.jpg, .png) 등을 저장한다.

 

HTML 파일을 저장하는 templates 디렉터리

templates 디렉터리에는 파이보의 질문 목록, 질문 상세 등의 HTML 파일을 저장한다. 파이보 프로젝트는 question_list.html, question_detail.html과 같은 템플릿 파일을 만들어 사용할 것이다.

 

파이보 프로젝트를 설정하는 config.py 파일

config.py 파일은 파이보 프로젝트의 환경을 설정한다. 파이보 프로젝트의 환경변수, 데이터베이스 등의 설정을 이 파일에 저장한다.

 

 

#플라스크 애플리케이션 팩토리

플라스크는 app 객체를 사용해 여러 가지 설정을 진행한다. 그런데 이와 같은 방식으로 app 객체를 전역으로 사용하면 프로젝트 규모가 커질수록 문제가 발생할 확률이 높아진다. 순환 참조(circular import) 오류가 대표적이다.

순환 참조란 A 모듈이 B 모듈을 참조하고 B 모듈이 다시 A 모듈을 참조하는 경우를 말한다.

 

app 객체를 전역으로 사용할 때 발생하는 문제를 예방하려면 어떻게 해야 할까? 플라스크 공식 홈페이지에서는 "애플리케이션 팩토리(application factory)를 사용하라"고 권한다.

 

# pybo.py를 __init__.py 파일로 변경

플라스크 기본 앱을 FLASK_APP=pybo로 설정하면, 기존에 pybo는 프로젝트 루트에 있는 pybo.py 파일을 가리켰지만,
또 다르게 pybo 모듈 즉 pybo/__init__.py 파일을 가리킨다.

pybo.py 와 pybo/__init__.py는 동일한 pybo 모듈이다.

따라서 pybo.py 파일을 pybo/__init__.py 파일로 바꾸어도 오류없이 잘 동작한다.

정상으로 flask run 실행

 

# 애플리케이션 팩토리

from flask import Flask

def create_app():
    app = Flask(__name__)
    @app.route('/')
    def hello_pybo():
        return 'string test'

    return app

create_app 함수가 app 객체를 생성해 반환하도록 코드를 수정했다. 이때 app 객체가 함수 안에서 사용되므로 hello_pybo 함수를 create_app 함수 안에 포함했다. 바로 여기서 사용된 create_app 함수가 바로 애플리케이션 팩토리다.

함수명으로 create_app 대신 다른 이름을 사용하면 정상으로 동작하지 않는다.
create_app은 플라스크 내부에서 정의된 함수명이다.

 

# 라우팅 함수 

hello_pybo 함수는 / URL과 매핑되는 함수인데, 이러한 URL 매핑을 @app.route('/')라는 애너테이션이 만들어 준다. 이때 @app.route와 같은 애너테이션으로 URL을 매핑하는 함수를 라우팅 함수라고 한다.

 

 

# ORM

ORM(object relational mapping)을 이용하면 파이썬 문법만으로도 데이터베이스를 다룰 수 있다.
즉, ORM을 이용하면 개발자가 쿼리를 직접 작성하지 않아도 데이터베이스의 데이터를 처리할 수 있다.

• ORM은 데이터베이스에 데이터를 저장하는 테이블을 파이썬 클래스로 만들어 관리하는 기술로 이해해도 좋다.

 

비교하자면 아래와 같음

insert into question (subject, content) values ('안녕하세요', '가입 인사드립니다 ^^');

question1 = Question(subject=’안녕하세요’, content='가입 인사드립니다 ^^')
db.session.add(question1)

위 Insert 문은 기존의 sql 이고, 아래 question1이라는 변수 안 쿼리문이 ORM이다.

# ORM 장점
1. ORM을 이용하면 데이터베이스 종류에 상관 없이 일관된 코드를 유지할 수 있어서 프로그램을 유지·보수하기가 편리하다. 
2. 내부에서 안전한 SQL 쿼리를 자동으로 생성해 주므로 개발자가 달라도 통일된 쿼리를 작성할 수 있다.
3. 오류 발생률도 줄일 수 있다.
4. 파이썬만으로 데이터베이스 처리가 가능하다. 등등..

 

# 라이브러리 설치

Flask-Migrate 라이브러리를 설치하면 SQLAlchemy도 함께 설치되므로 myproject 가상 환경에서 다음 명령을 수행하여 Flask-Migrate 라이브러리를 설치하자.

# 설정파일 추가

flask_project 아래의 config.py 파일을 생성하고 다음과 같은 코드를 작성한다.

import os

BASE_DIR = os.path.dirname(__file__)

SQLALCHEMY_DATABASE_URI = 'sqlite:///{}' .format(os.path.join(BASE_DIR,'pybo.db'))
SQLALCHEMY_TRACK_MODIFICATIONS = False

SQLALCHEMY_DATABASE_URI 는 : 
데이터베이스 접속 주소

SQLALCHEMY_TRACK_MODIFICATIONS는 :
SQLAlchemy의 이벤트를 처리하는 옵션이다. 이 옵션은 파이보에 필요하지 않으므로 False로 비활성화 한다.

SQLALCHEMY_DATABASE_URI :
설정에 의해 SQLite 데이터베이스가 사용되고 데이터베이스 파일은 프로젝트 홈 디렉터리 바로 밑에  pybo.db 파일로 저장된다.

#데이터베이스 초기화

먼저 init.py 파일을 다음과 같이 수정해준다.

from flask import Flask
from flask_migrate import Migrate
from flask_sqlalchemy import SQLAlchemy

import config

# 전역변수로 객체를 만듬
db = SQLAlchemy()
migrate = Migrate()

def create_app():
    app = Flask(__name__)
    app.config.from_object(config) #config 파일을 읽기 위함임

    # ORM
    db.init_app(app)
    migrate.init_app(app, db)

    # 블루프린트
    from .views import main_views
    app.register_blueprint(main_views.bp)

    return app



'''
    이부분이 기존의 route부분인데, 블루프린트로 view로 따로 뺐음
    @app.route('/')
    def hello_pybo():
        return 'string test'
'''

 

이후 flask db init  명령어를 통해 데이터베이스를 초기화 해준다.

그럼 아래와 같이 migrations 가 자동으로 생김

오른쪽에 DB명령어 2개는 꼭 외우는 것이 좋다.

 

# data base query 작성하기

pybo 아래 models.py를 생성 후 다음과 같이 작성한다.  각 코드에 대한 설명은 > https://wikidocs.net/81045 참고하면 좋을 것 같다.

2-04 모델로 데이터 처리하기

from pybo import db

# 질문 모델
class Question(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    subject = db.Column(db.String(200), nullable=False) # nullable은 빈 값의 대한 허용 여부를 나타내며 false는 빈 값이 불허하다는 의미이다.
    content = db.Column(db.text(), nullable=False)
    create_data = db.Column(db.DateTime(), nullable=False)

class Answer(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    question_id = db.Column(db.Integer, db.ForeignKey('question.id', ondelete='CASCADE'))
    question = db.relationship('Question', backref=db.backref('answer_set'))
    content = db.Column(db.Text(), nullable=False)
    create_date = db.Column(db.DateTime(), nullable=False)

작성 후 적용해준다. 

> flask db migrate

적용 시, ef96 ~~ 라고 하는 데이터베이스 변경 작업을 위한 리비전 파일이 생성된다.

리비전(revision)이란 생성된 파일에서 .py 확장자를 제외한 ef96.._와 같은 버전 번호를 가리킨다.

리비전은 flask db migrate 명령을 수행할 때 무작위로 만들어진다.

이어서 flask db upgrade 명령으로 만들어진 리비전 파일을 실행하자. (리비전 파일 내에는 테이블 생성을 위한 쿼리문들이 저장되어 있다.) -> pybo.db가 생성됨 => pybo.db가 바로 SQLite 데이터베이스의 데이터 파일이다.