Django 양식 디버깅

Django 양식 처리 코드를 평가하여 버그, 비효율성, 보안 문제를 식별합니다.

모델을 직접 쿼리하고 Cloud 콘솔에서 다른 매개변수 값을 사용하거나 Vertex AI API를 직접 호출하여 반환된 결과를 테스트할 수 있습니다.

Freeform 프롬프트

대학 입학 신청 및 시험 제출 절차를 위해 설계된 다음 Django 양식 처리 코드를 검토합니다. 이 코드는 개인 정보, 학업 기록, 표준화된 시험 점수를 포함한 지원자 정보 수집 및 유효성 검사를 관리합니다. 버그, 비효율성, 보안 위험 또는 Django 권장사항 및 PEP 8 표준과의 편차를 식별합니다.

from django import forms
from django.core.exceptions import ValidationError
from college.models import Application, AcademicRecord, TestScore
from django.utils.translation import gettext_lazy as _
from django.db import transaction

class CollegeApplicationForm(forms.ModelForm):
    class Meta:
        model = Application
        fields = ['first_name', 'last_name', 'email', 'phone_number', 'address', 'birthdate', 'intended_major']

    gpa = forms.DecimalField(max_digits=4, decimal_places=2, min_value=0.0, max_value=4.0)
    sat_score = forms.IntegerField(min_value=400, max_value=1600, required=False)
    act_score = forms.IntegerField(min_value=1, max_value=36, required=False)
    transcript = forms.FileField(required=True)

    def clean(self):
        cleaned_data = super().clean()
        sat_score = cleaned_data.get('sat_score')
        act_score = cleaned_data.get('act_score')

        if not sat_score and not act_score:
            raise ValidationError(_('At least one test score (SAT or ACT) is required.'))

        if cleaned_data.get('emai') and Application.objects.filter(email=cleaned_data.get('email')).exists():
            raise ValidationError(_('An application with this email already exists.'))

        return cleaned_data

    def save(self, commit=True):
        with transaction.atomic():
            application = super().save(commit=False)

            academic_record = AcademicRecord(
                application=application,
                gpa=self.cleaned_data['gpa'],
                transcript=self.cleaned_data['transcript']
            )

            if commit:
                application.save()
                academic_record.save()

            if self.cleaned_data.get('sat_score'):
                TestScore.objects.create(
                    application=application,
                    test_type='SAT',
                    score=self.cleaned_data['sat_score']
                )

            if self.cleaned_data.get('act_score'):
                TestScore.objects.create(
                    application=application,
                    test_type='ACT',
                    score=self.cleaned_data['act_score']
                )

        return application

응답

이 코드에는 몇 가지 문제가 있습니다.

1. PEP 8 위반:

  • 필드 배치: gpa, sat_score, act_score, transcript 필드는 Meta 클래스 외부에서 정의됩니다. Meta 클래스 내에 있어야 하며 클래스 내에 별도의 forms.fields로 정의되어야 하며 독립형 속성으로 정의되어서는 안 됩니다.
  • 줄 길이: 일부 줄이 권장 값인 79자(영문 기준)를 초과합니다.
  • 이름 지정: emai는 clean 메서드의 오타입니다.

2. 비효율성:

  • clean의 데이터베이스 쿼리: clean 메서드 내에서 Application.objects.filter(...) 호출은 비효율적입니다. 모든 양식 유효성 검사에 대해 데이터베이스 쿼리를 수행합니다. 더 적절한 위치(예: 커스텀 유효성 검사 함수 또는 신호)로 이동해야 합니다.

3. 버그:

  • clean 메서드의 오타: cleaned_data.get('emai')은 cleaned_data.get('email')이어야 합니다.
  • super().save()에 commit=False 누락: save 메서드는 application에 commit=False를 사용하지만 with transaction.atomic() 블록 내 super().save() 호출에는 누락되어 있습니다. 이로 인해 academic_record.save() 중에 오류가 발생하면 데이터가 일치하지 않을 수 있습니다.

4. 보안 위험:

  • 파일 업로드 처리: transcript 필드에 적절한 유효성 검사와 정리가 없습니다. 취약점이 방지되도록 저장하기 전에 파일 형식과 크기를 제한하고 잠재적으로 악성 콘텐츠를 검사하는 것이 중요합니다.
  • 입력 정리 없음: 양식에서 사용자 입력을 정리하지 않으므로 교차 사이트 스크립팅(XSS) 공격과 기타 삽입 취약점에 취약합니다.

5. Django 권장사항:

  • ModelForms 및 관련 모델: 양식은 save 메서드 내에서 관련 모델(AcademicRecord 및 TestScore)을 직접 처리합니다. 일반적으로 관련 모델에 별도의 ModelForms를 사용하거나 Django의 신호를 활용하여 더 명확하게 문제를 분리하는 것이 좋습니다.
  • 오류 처리: save 메서드에 오류 처리가 없습니다. save 호출 중 하나라도 실패하면 데이터 일관성이 유지되도록 트랜잭션을 롤백해야 합니다. 더 강력한 오류 처리가 필요합니다.
  • 양식 필드 선택사항: TestScore의 test_type 필드는 'SAT' 및 'ACT'로 하드코딩됩니다. 모델을 더 유지 관리 및 확장 가능하게 하려면 모델에서 선택사항을 정의하는 것이 좋습니다.

개선된 코드:

from django import forms
from django.core.exceptions import ValidationError
from college.models import Application, AcademicRecord, TestScore
from django.utils.translation import gettext_lazy as _
from django.db import transaction
from django.core.files.storage import default_storage


class CollegeApplicationForm(forms.ModelForm):
    class Meta:
        model = Application
        fields = ['first_name', 'last_name', 'email', 'phone_number', 'address', 'birthdate', 'intended_major']
        widgets = {
            'birthdate': forms.DateInput(attrs={'type': 'date'}),
        }

    gpa = forms.DecimalField(max_digits=4, decimal_places=2, min_value=0.0, max_value=4.0, label="GPA")
    sat_score = forms.IntegerField(min_value=400, max_value=1600, required=False, label="SAT Score")
    act_score = forms.IntegerField(min_value=1, max_value=36, required=False, label="ACT Score")
    transcript = forms.FileField(required=True, label="Transcript")

    def clean_email(self):
        email = self.cleaned_data['email']
        if Application.objects.filter(email=email).exists():
            raise ValidationError(_('An application with this email already exists.'))
        return email

    def clean(self):
        cleaned_data = super().clean()
        sat_score = cleaned_data.get('sat_score')
        act_score = cleaned_data.get('act_score')

        if not sat_score and not act_score:
            raise ValidationError(_('At least one test score (SAT or ACT) is required.'))
        return cleaned_data

    def save(self, commit=True):
        try:
            with transaction.atomic():
                application = super().save(commit=False)
                application.save()  # Save the application first

                AcademicRecord.objects.create(
                    application=application,
                    gpa=self.cleaned_data['gpa'],
                    transcript=self.cleaned_data['transcript']
                )

                if self.cleaned_data.get('sat_score'):
                    TestScore.objects.create(
                        application=application,
                        test_type='SAT',
                        score=self.cleaned_data['sat_score']
                    )

                if self.cleaned_data.get('act_score'):
                    TestScore.objects.create(
                        application=application,
                        test_type='ACT',
                        score=self.cleaned_data['act_score']
                    )
            return application
        except Exception as e:
            # Handle exceptions appropriately, log the error, and potentially raise a more user-friendly exception.
            print(f"Error saving application: {e}")  # Replace with proper logging
            raise ValidationError(_("An error occurred while saving your application. Please try again later."))

이 개선된 버전에서는 많은 문제를 해결하지만 추가 개선사항은 다음과 같습니다.

  • 파일 형식 및 크기 유효성 검사: transcript 필드의 파일 형식과 크기를 제한하는 유효성 검사를 추가합니다.
  • 바이러스 백신/멀웨어 스캔: 업로드된 파일에서 악성 콘텐츠를 스캔하는 메커니즘을 통합합니다.
  • 커스텀 유효성 검사 함수: 가독성과 유지보수성을 높이기 위해 유효성 검사 로직을 별도의 함수로 리팩터링합니다.
  • 별도의 ModelForms: 더욱 우수한 구성을 위해 AcademicRecord 및 TestScore에 별도의 ModelForms를 사용하는 것이 좋습니다.
  • 신호: Django 신호를 사용하여 관련 모델 생성을 더 분리된 방식으로 처리합니다.
  • 적절한 로깅: 적절한 로깅을 구현하여 오류를 추적하고 문제를 디버그합니다.

보안 취약점을 방지하려면 항상 사용자 입력을 철저히 정리해야 합니다. 이 수정된 코드는 더 강력하고 안전한 기반을 제공하지만 추가 보안 조치를 취하는 것이 좋습니다.
모델: gemini-1.5-flash-002
강도: 0.2
최대 출력 토큰: 8192
최상위 K: 40.0
최상위 P: 0.95