ABOUT ME

    -

    Today
    -
    Yesterday
    -
    Total
    -
    • Flask 기본
      언어/Python 2022. 11. 30. 21:01
      728x90
      반응형
      SMALL

      1. flask 구동 방법

      1.1 virtualenv

      진행하고 있는 더 많은 프로젝트들이 서로 다른 Python 버전에서 작동해야 한다거나 혹은 서로 다른 버전의 Python 라이브러리들 에서 작동해야 한다면 virtualenv를 이용하여 Python을 아무런 문제 없이 각각의 프로젝트 환경에 맞게 다중설치가 가능하도록 해준다.

      1.1.1 mac OS 혹은 Linux일 경우

      sudo easy_install virtualenv

      1.1.2 혹은

      sudo pip install virtualenv

      로 설치 가능하다.

      1.2 자신만의 실행환경 만들기

      mkdir myproject
cd myproject
virtualenv venv

      1.3 실행환경 활성화

      . venv/bin/activate

      1.4 Flask 설치

      sudo pip install Flask

      2. 기본 Flask 어플리케이션의 모습

      2.1 hello.py

      from flask import Flask
app = Flask(__name__)

@app.route('/')
def hello_world():
    return 'Hello World!'

if __name__ == '__main__':
    app.run()

      파일의 이름을 flask.py로 지을 경우 Flask자체와 충돌이 날 수 있다.

      2.2 실행 방법

      python hello.py

      'http://127.0.0.1:5000/' 로 접속 시 라우팅된 페이지로 이동할 수 있다.

      2.3 세부 코드 파악

      app = Flask(__name__): Flask = class의 인스턴스를 생성. 인자로 모듈이나 패키지의 이름을 넣는다.

      def hello_world():
    return 'Hello World!'

      route()데코레이터를 사용해서 Flask에게 어떤 URL이 우리가 작성한 함수를 실행시키는지 알려준다. 사용자 브라우저에 보여줄 메시지를 리턴한다.

      if __name__ == '__main__':
    app.run()

      어플리케이션 실행. 소스파일을 python 인터프리터를 이용해서 직접 실행한다면 if __name__ == '__main__': 이 문장은 우리가 실행한 서버가 현재 동작되는 유일한 서버라는 것을 보장한다.

      서버 중지 시 control-C

      3. 디버그 모드

      app.debug = True
app.run()
#혹은
app.run(debug=True)

      run()메소드는 로컬 개발 서버를 실행시키기에는 좋지만 코드 변경후에 수동으로 재시작해야한다.
      플라스크는 그런 번거러운 것을 개선한 방식을 제공한다. 디버그모드를 지원할 경우, 서버는 코드 변경을 감지하고 자동으로 리로드하고, 문제가 발생하면 문제를 찾을 수 있도록 디버거를 제공한다.

      4. 라우팅

      기본 예시

      @app.route(‘/’)
def index():
  return ‘Index Page’

@app.route(‘/hello’)
def hello():
  return ‘Hello World’

      route() 데코레이터는 함수와 URL을 연결해준다.

      5. 변수 규칙

      <variable_name>으로 URL에 특별한 영역으로 표시해야한다. 그 부분은 함수의 키워드 인수로써 넘어간다.
      converter:variable_name으로 규칙을 표시하여 변환기를 추가할 수 있다.

      @app.route('/user/<username>')
def show_user_profile(username):
    # show the user profile for that user
    return 'User %s' % username

@app.route('/post/<int:post_id>')
def show_post(post_id):
    # show the post with the given id, the id is an integer
    return 'Post %d' % post_id

      다음과 같은 변환기를 제공한다.

      int accepts integers
      float like int but for floating point values
      path like the default but also accepts slashes
         

      6. 유일한 URL과 리디렉션 동작

      @app.route('/projects/')
def projects():
    return 'The project page'

@app.route('/about')
def about():
    return 'The about page'

      URL정의에 있어서 뒷 슬래쉬가 있을 경우, 파일시스템의 폴더와 유사하게 뒷 슬래쉬 없이 URL접근하면, Flask가 뒷 슬래쉬를 가진 정규 URL로 고쳐준다.
      URL정의에 있어서 뒷 슬래쉬가 없을 경우, 뒷 슬래쉬를 포함해서 URL에 접근하면 "404 Page not Found" 에러를 유발한다.

      7. HTTP 메소드

      기본적으로 GET방식으로 제공되지만, route()데코레이터에 methods 인자를 제공하면 다른 방식으로 변경할 수 있다.

      @app.route('/login', methods=['GET', 'POST'])
def login():
    if request.method == 'POST':
        do_the_login()
    else:
        show_the_login_form()

      8. 템플릿 렌더링

      from flask import render_template

@app.route('/hello/')
@app.route('/hello/<name>')
def hello(name=None):
    return render_template('hello.html', name=name)

      render_template()메소드를 사용하여 템플릿을 렌더링해줄 수 있고, 인자를 넘겨줄 수도 있다.
      Flasksms templates폴더에서 템플릿을 찾으므로 해당 폴더 내에 템플릿들을 넣어주어야 한다.

      9. 템플릿예제

      <!DOCTYPE html>
<title>Hello from Flask</title>
{% if name %}
<h1>Hello {{ name }}!</h1>
{% else %}
<h1>Hello World!</h1>
{% endif %}

      템플릿에서 상속이 유용하게 쓰인다. 자동 이스케이핑은 켜져있고, name이란 변수가 인자로 전해졌다면 자동으로 이스케이핑 된다.

      10. 요청 데이터 접근

      클라이언트가 서버로 보내는 데이터는 request객체에 의해 제공된다.

      11. 컨텍스트 로컬

      웹에서 요청이 들어오면, 웹 서버는 새로운 쓰레드를 생성한다. Flask는 내부적으로 요청을 처리할 때, 현재 처리되는 쓰레드를 활성화된 문맥이라고 간주하고 실행되는 어플리케이션과 WSGI환경을 그 문맥에 연결한다.
      유닛테스트를 할 경우 요청 걕체에 의한 코드는 깨지게 되는데 그 이유는 요청이 들어오지 않아 활성화된 문맥이 없으므로 요청 객체가 존재하지 않기 때문이다. 그래서 문맥관리자 test_request_context()를 사용한다.
      Flaskdptj 이런 객체들은 보통 객체가 아닌 전역 객체들이다. 이 객체들은 실제로 어떤 특정한 문맥에서 생성되는 객체들에 대한 대리자들이다.

      12. 요청 객체 (기본)

      from flask import request

@app.route('/login', methods=['POST', 'GET'])
def login():
    error = None
    if request.method == 'POST':
        if valid_login(request.form['username'],
                       request.form['password']):
            return log_the_user_in(request.form['username'])
        else:
            error = 'Invalid username/password'
    # 아래의 코드는 요청이 GET 이거나, 인증정보가 잘못됐을때 실행된다.
    return render_template('login.html', error=error)
      • method속성을 이용하여 http 메소드를 확인할 수 있다.
      • form속성을 이용하여 전달된 데이터에 접근할 수 있다.
      • GET 메소드와 같이 URL로 넘겨진 파라미터에 접근하려면 args속성을 사용한다.args속성을 사용할 경우 get을 사용하거나 KeyError예외를 처리하여 URL접근할 것을 추천한다. 왜냐하면 사용자가 임의로 URL을 변경할 수도 있기 때문이다.
      • key = request.args.get('key','')

      13. 파일 업로드

      HTML form에 enctype="multipart/form-data"를 설정

      from flask import request

@app.route('/upload', methods=['GET', 'POST'])
def upload_file():
    if request.method == 'POST':
        f = request.files['the_file']
        f.save('/var/www/uploads/uploaded_file.txt')
    ...

      request객체의 속성인 files를 사용한다. files는 file명을 key로 해당 파일을 value로 하는 dictionary이다.
      files속성으로 얻어온 file에 대한 참조는 표준 파이썬 file객체처럼 행동한다. 그래서 save()메소드를 가지고 있어 서버의 파일시스템에 저장할 수 있다.

      14. 쿠키

      쿠키에 접근하기 위해서는 request 객체의 cookies속성을 사용한다.
      쿠키를 저장하기 위해서는 response 객체의 set_cookie메소드를 사용한다.
      Reading cookies

      from flask import request

@app.route('/')
def index():
    username = request.cookies.get('username')

      Storing cookies

      from flask import make_response

@app.route('/')
def index():
    resp = make_response(render_template(...))
    resp.set_cookie('username', 'the username')
    return resp

      15. 리다이렉션과 에러

      redirect시 redirect() 함수를 사용.
      에로코드로 일찍 중단하고 싶다면 abort()함수 사용

      from flask import request, render_template, make_resopnse

@app.route('/signup')
def sign_up():
  user_id = request.form['user_id']
  password = request.form['password']
  store_user_info(user_id,password):
  return redirect(url_for('login'))

      에러 페이지를 변경하려면 errorhandler()데코레이터를 사용한다.

      from flask import render_template

@app.errorhandler(404)
def page_not_found(error):
    return render_template('page_not_found.html'), 404

      16. 응답

      • 만약 정확한 유형의 response객체가 반환된다면 그 객체는 그대로 뷰로부터 반환되어 진다.
      • 만약 문자열이 반환된다면, response객체는 해당 데이타와 기본 파라미터들을 갖는 reponse객체가 생성된다.
      • 만약 튜플이 반환된다면 튜플 안에 있는 아이템들이 추가적인 정보를 제공할 수 있다. 그런 퓨틀들은 지정된 폼 (response, status, headers) 이여야 하며, 그 중 적어도 하나의 아이템이 튜플 안에 있어야 한다. status 값은 status code를 오버라이드하면 headers는 추가적인 정보의 list, dictionary가 될 수 있다.
      • 만약 위의 것들이 아무것도 적용되지 않는다면, Flask는 반환값이 유효한 WSGI application 이라고 가정하고 WSGI application을 response객체로 변환할 것이다.

      아래와 같은 뷰가 있다.

      @app.errorhandler(404)
def not_found(error):
    return render_template('error.html'), 404

      make_response()함수를 사용하여 뷰 안에서 결과 resopnse객체를 찾을 수 있다.
      make_response()함수를 사용하여 반환되는 표현을 래핑하고, 변경을 위해 결과 객체를 얻은 다음 반환하면 된다.

      17. 세션

      request 객체 외에도 session객체로 하나의 요청에서 다음 요청까지 사용자에 대한 구체적인 정보를 저장할 수 있다.
      세션은 쿠키위에서 구현되어 지고 암호키를 생성하여 그 쿠키를 서명한다.
      세션에 저장은 session객체 dirctionary처럼 저장하면 된다.

      from flask import session,redirect,request

@app.route('login', methods=['GET','POST'])
def login():
  if request.method == 'POST':
    session['username'] = request.form['username']
    return redirect(url_for'index'))
  ...

      세션에 저장된 값을 없앨 경우 pop을 사용

      @app.route('/logout')
def logout():
  session.pop('username', None)
  return redirect(url_for('index'))

      reference

      본 내용은 flask docs의 내용을 참고하여 작성하였습니다.
      필자 연습 Repo GitHub

      반응형
      LIST
      저작자표시 비영리 변경금지

      '언어 > Python' 카테고리의 다른 글

      virtualenv로 가상환경 설정하기  (0) 2022.07.16
      Python 몰랐던 문법 정리  (0) 2022.07.16

      관련글 관련글 더보기

      댓글

    Designed by Tistory.

    티스토리툴바