【Python × Flask】REST APIでカスタム例外クラスでエラーハンドリングする方法

Copy
.
|-- Dockerfile
|-- api
|   |-- __init__.py
|   |-- api.py
|   |-- error_handling.py
|   |-- exceptions.py
|   |-- routes.py
|   `-- wsgi.py
|-- docker-compose.yml
|-- .env
`-- requirements.txt

Copy
FROM python:3.12

# workspaceディレクトリ作成、移動
WORKDIR /workspace

# プロジェクトディレクトリにコピー
COPY requirements.txt /workspace

# 必要モジュールのインストール
RUN pip install --upgrade pip
RUN pip install -r requirements.txt

Copy
Flask==3.0.2

Copy
# flask-REST APIコンテナ用
# Flaskがどのアプリケーションを実行するか指定(pyファイル:インスタンス)
FLASK_APP=api.wsgi:api

# Flaskがどの環境で動作するか指定
FLASK_ENV=development

#デバッグモードの指定
FLASK_DEBUG=true

Copy
version: "3"
services:
  flask-api-error:
    container_name: "flask-api-error"
    build:
      context: .
      dockerfile: Dockerfile
    ports:
      - "5000:5000"
    volumes:
      # バインドマウント
      - .:/workspace
    # 環境変数読み込み
    env_file:
      - .env
    tty: true

Copy
class CustomException(Exception):
    status_code: str
    error_message: str

    def __init__(self, error_message: str):
        self.error_message = error_message

class CustomBadRequestException(CustomException):
    status_code = 400  # override field

class CustomNotFoundException(CustomException):
    status_code = 404  # override field

class CustomInternalServerErrorException(CustomException):
    status_code = 500  # override field

Copy
from flask import jsonify
from api.exceptions import CustomException

def handle_custom_exception(error: CustomException):
    response = {
        "status_code": error.status_code,
        "error_message": error.error_message
    }
    return jsonify(response)

Copy
from flask import Flask

from api.routes import configure_user_routes
from api.exceptions import CustomException
from api.error_handling import handle_custom_exception

def create_app() -> Flask:
    # アプリケーションインスタンスの作成
    app = Flask(__name__)
    # 日本語文字化け対応
    app.json.ensure_ascii = False    
    # エラーハンドラ関数登録
    app.register_error_handler(CustomException, handle_custom_exception)
    # ルーティング設定
    configure_user_routes(app)

    return app

Copy
from api.exceptions import CustomBadRequestException
from api.exceptions import CustomInternalServerErrorException
from api.exceptions import CustomNotFoundException
from flask import Flask

class Routes:
    def __init__(self, app: Flask):
        self.app = app
        self.configure_routes()

    def configure_routes(self):

        @self.app.route('/<code>', methods=['GET'])
        def get_users(code):
            if code == '400':
                raise CustomBadRequestException(error_message="不正なリクエストです")
            elif code == '404':
                raise CustomNotFoundException(error_message="リソースが見つかりません")
            elif code == '500':
                raise CustomInternalServerErrorException(error_message="内部サーバーエラーが発生しました")
            else:
                return "Code not recognized", 200

def configure_user_routes(app: Flask):
    Routes(app)

Copy
from api.api import create_app

api = create_app()

Copy
from api.exceptions import CustomBadRequestException
from api.exceptions import CustomInternalServerErrorException
from api.exceptions import CustomNotFoundException
from flask import Flask

class Routes:
    def __init__(self, app: Flask):
        self.app = app
        self.configure_routes()

    def configure_routes(self):

        @self.app.route('/<code>', methods=['GET'])
        def get_users(code):
            if code == '400':
                raise CustomBadRequestException(error_message="不正なリクエストです")
            elif code == '404':
                raise CustomNotFoundException(error_message="リソースが見つかりません")
            elif code == '500':
                raise CustomInternalServerErrorException(error_message="内部サーバーエラーが発生しました")
            else:
                return "Code not recognized", 200

def configure_user_routes(app: Flask):
    Routes(app)

Copy
class CustomException(Exception):
    status_code: str
    error_message: str

    def __init__(self, error_message: str):
        self.error_message = error_message

class CustomBadRequestException(CustomException):
    status_code = 400  # override field

class CustomNotFoundException(CustomException):
    status_code = 404  # override field

class CustomInternalServerErrorException(CustomException):
    status_code = 500  # override field

Copy
from flask import jsonify
from api.exceptions import CustomException

def handle_custom_exception(error: CustomException):
    response = {
        "status_code": error.status_code,
        "error_message": error.error_message
    }
    return jsonify(response)

Copy
flask run --host=0.0.0.0

Copy
$ curl localhost:5000/400
{
  "error_message": "不正なリクエストです",
  "status_code": 400
}

Copy
$ curl localhost:5000/404
{
  "error_message": "リソースが見つかりません",
  "status_code": 404
}

Copy
$ curl localhost:5000/500
{
  "error_message": "内部サーバーエラーが発生しました",
  "status_code": 500
}

Copy
from flask import Flask

from api.routes import configure_user_routes
from api.exceptions import CustomException
# from api.error_handling import handle_custom_exception

def create_app() -> Flask:
    # アプリケーションインスタンスの作成
    app = Flask(__name__)
    # 日本語文字化け対応
    app.json.ensure_ascii = False    
    # # エラーハンドラ関数登録
    # app.register_error_handler(CustomException, handle_custom_exception)
    # ルーティング設定
    configure_user_routes(app)

    return app

Copy
from flask import Flask,jsonify

from api.exceptions import CustomException
from api.exceptions import CustomBadRequestException
from api.exceptions import CustomInternalServerErrorException
from api.exceptions import CustomNotFoundException

class Routes:
    def __init__(self, app: Flask):
        self.app = app
        self.configure_routes()

    def configure_routes(self):

        @self.app.route('/<code>', methods=['GET'])
        def get_users(code):
            if code == '400':
                raise CustomBadRequestException(error_message="不正なリクエストです")
            elif code == '404':
                raise CustomNotFoundException(error_message="リソースが見つかりません")
            elif code == '500':
                raise CustomInternalServerErrorException(error_message="内部サーバーエラーが発生しました")
            else:
                return "Code not recognized", 200

        @self.app.errorhandler(CustomException)
        def handle_custom_exception(error: CustomException):
            response = {
                "status_code": error.status_code,
                "error_message": error.error_message
            }
            return jsonify(response)

def configure_user_routes(app: Flask):
    Routes(app)