web-dev-qa-db-ja.com

Django REST例外

現在、Django RESTフレームワーク。 Django REST例外。

以下のコードから、これはおそらくREST Framework例外を最大限に活用するための最良または最もクリーンな方法ではないと感じています。

RESTビルトイン例外で問題をキャッチしてきれいに返すという良い例はありますか？

class JSONResponse(HttpResponse):
    def __init__(self, data, **kwargs):
       content = JSONRenderer().render(data)
       kwargs['content_type'] = 'application/json'
       super(JSONResponse, self).__init__(content, **kwargs)

def queryInput(request):
    try:
        auth_token = session_id = getAuthHeader(request)
        if not auth_token:
            return JSONResponse({'detail' : "fail", "error" : "No X-Auth-Token Found", "data" : None}, status=500)

        if request.method:
            data = JSONParser().parse(request)
            serializer = queryInputSerializer(data=data)

        if request.method == 'POST':
            if serializer.is_valid():
                input= serializer.data["input"]
                fetchData = MainRunner(input=input,auth_token=auth_token)
                main_data = fetchData.main()

            if main_data:
                return JSONResponse({'detail' : "success", "error" : None, "data" : main_data}, status=201)

        return JSONResponse({'detail' : "Unknown Error","error" : True, "data" : None}, status=500)

    except Exception as e:
           return JSONResponse({'error' : str(e)},status=500)
djangorestdjango-rest-framework
21
PacketPimp

Django RESTフレームワークは、いくつかの 例外に組み込まれています を提供します。これらはほとんどDRFのAPIExceptionのサブクラスです。

Pythonで通常行うように、ビューで例外を発生させることができます。

from rest_framework.exceptions import APIException

def my_view(request):
    raise APIException("There was a problem!")

APIExceptionから継承し、status_codeおよびdefault_detailを設定して、独自のカスタム例外を作成することもできます。組み込みのものには、ParseError、AuthenticationFailed、NotAuthenticated、PermissionDenied、NotFound、NotAcceptable、 ValidationErrorなど.

これらは、REST Frameworkの例外ハンドラーによってResponseに変換されます。各例外は、Responseに追加されるステータスコードに関連付けられます。デフォルトでは、例外ハンドラーは組み込みハンドラーに設定されます。

REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler'
}

ただし、settings.pyファイルでこれを変更して、自分で例外を変換する場合は、独自のカスタム例外ハンドラーに設定できます。

REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'my_project.my_app.utils.custom_exception_handler'
}

そして、その場所にカスタムハンドラーを作成します。

from rest_framework.views import exception_handler

def custom_exception_handler(exc, context):
    # Call REST framework's default exception handler first,
    # to get the standard error response.
    response = exception_handler(exc, context)

    # Now add the HTTP status code to the response.
    if response is not None:
        response.data['status_code'] = response.status_code

    return response
44
emptyflash

build in DRF exception を使用できます。インポートとレイズだけです

from rest_framework.exceptions import
...
raise ParseError('I already have a status code!')
3
haki