http_utils

HTTP utilities for request validation and response handling.

Module Contents

http_utils.validate_post_request(request: django.http.HttpRequest) → django.http.JsonResponse | None

Validate that the request uses POST method.

Parameters:: request – Django HttpRequest object
Returns:: JsonResponse with error if invalid, None if valid

http_utils.validate_post_request_similarity(request: django.http.HttpRequest) → django.http.JsonResponse | None

Validate that the request uses POST method (for similarity endpoints).

Parameters:: request – Django HttpRequest object
Returns:: JsonResponse with error if invalid, None if valid

http_utils.extract_file_from_request(request: django.http.HttpRequest) → Tuple[django.core.files.uploadedfile.UploadedFile | None, django.http.JsonResponse | None]

Extract file from POST request.

Parameters:: request – Django HttpRequest object
Returns:: Tuple of (file_object, error_response). If file exists, error_response is None. If file doesn’t exist, file_object is None and error_response contains the error.

http_utils.extract_csv_file_from_request(request: django.http.HttpRequest) → Tuple[django.core.files.uploadedfile.UploadedFile | None, django.http.JsonResponse | None]

Extract CSV file from POST request (for similarity analysis).

Parameters:: request – Django HttpRequest object
Returns:: Tuple of (csv_file_object, error_response). If file exists, error_response is None. If file doesn’t exist, file_object is None and error_response contains the error.

http_utils.extract_session_id_from_request(request: django.http.HttpRequest) → Tuple[str | None, django.http.JsonResponse | None]

Extract session_id from POST request.

Parameters:: request – Django HttpRequest object
Returns:: Tuple of (session_id, error_response). If session_id exists, error_response is None. If session_id doesn’t exist, session_id is None and error_response contains the error.

http_utils.extract_validation_session_id(request: django.http.HttpRequest) → str

Extract validation session ID from POST request, with default fallback.

Parameters:: request – Django HttpRequest object
Returns:: Session ID string (defaults to “default” if not provided)

http_utils.validate_post_with_file_request(request: django.http.HttpRequest) → django.http.JsonResponse | None

Validate that request is POST and contains a file.

Parameters:: request – Django HttpRequest object
Returns:: JsonResponse with error if invalid, None if valid

http_utils.extract_csv_file_with_validation(request: django.http.HttpRequest) → Tuple[django.core.files.uploadedfile.UploadedFile | None, django.http.JsonResponse | None]

Extract and validate CSV file from POST request with format checking.

Parameters:: request – Django HttpRequest object
Returns:: Tuple of (csv_file_object, error_response). If file is valid, error_response is None. If file is invalid or missing, file_object is None and error_response contains the error.