표준 Update 가이드

What?

• 표준 수정 인덱스는 Target record 보여주고 사용자를 통해 수정할수 있도록 합니다.
• 표준 update page 는 standard_update() 을 통해 생성된 코드 및 HTML 을 의미한다.

def standard_update(request, id, template_name, model, form_class, redirect_view, redirect_path_variables, base,
                    callback, **callback_kwargs):
    model_inst = model.objects.get(id=id)
    # POST 요청 처리
    if request.method == 'POST':
        form = form_class(request.POST, request.FILES, instance=model_inst)  # <-- FILES 와 같이 입력이 되어야 한다.

        # 유효성 검사 통과 시
        if form.is_valid():
            valid_inst = form.save(commit=False)  # instance load

            # 콜백 함수 호출
            if callback:
                callback(request=request, id=id, template_name=template_name, model=model, form_class=form_class,
                         redirect_view=redirect_view, redirect_path_variables=redirect_path_variables, base=base,
                         valid_inst=valid_inst, **callback_kwargs)
            # 데이터베이스에 저장
            valid_inst.save()  # instance save

            # 리디렉션
            if redirect_path_variables:  # redirect_path_variables 이 None 이 아니면
                return redirect(redirect_view, **redirect_path_variables)
            else:
                return redirect(redirect_view)
        # 유효성 검사 실패 시
        else:
            content = render(request, template_name=template_name, context={'form': form}).content
            ret_html = add_content(request, base, content)
            return HttpResponse(ret_html)

    # GET 요청 처리
    elif request.method == 'GET':
        added_contents = []
        form = form_class(instance=model_inst)  # <-- FILES 와 같이 입력이 되어야 한다.
        content = render(request, template_name=template_name, context={'form': form}).content.decode('utf-8')
        added_contents.append(content)

        # 콜백 함수 호출
        if callback:
            callback(request=request, id=id, template_name=template_name, model=model, form_class=form_class,
                     redirect_view=redirect_view, redirect_path_variables=redirect_path_variables, base=base,
                     added_contents=added_contents, **callback_kwargs)
        # 최종 렌더링
        ret_html = add_content(request, base, *added_contents)
        return HttpResponse(ret_html)

속성

• UpdateForm 을 활용해 Record 추가시 필요한 필드 항목을 가져온다.

• 추가가 모두 끝나면 redirect 를 통해 신호를 송신한다.

• callback 함수는 GET, POST 모두 실행된다.

  if method == 'GET' or method == 'POST' 을 통해서 작성

  POST 에서 callback 함수가 작동하는 단계는 유효성 통과 이후이다.

  GET 에서 callback 함수가 작동하는 단계는 form render 이후 added_content 에 추가된 이후이다.

How to use ?

def update(request, id):
    """
    프로젝트를 업데이트하는 뷰 함수입니다.

    :param request: HttpRequest 객체
    :param id: 프로젝트의 식별자
    :return: HttpResponse 객체
    """
    def _callback(**kwargs):
        if kwargs['request'].method == 'GET':
            title = h_tag(2, '프로젝트 업데이트')
            kwargs['added_contents'][0] = title + card_row((kwargs['added_contents'][0], 12))

    return standard_update(request, id, 'standard/update.html', Project, ProjectUpdateForm, 'project:index', None,
                           'doctris', _callback)

    
    def projectfile_update(request, id):
    """
    프로젝트 산출물을 업데이트하는 뷰 함수입니다.

    :param request: HttpRequest 객체
    :param id: 산출물의 식별자
    :return: HttpResponse 객체
    """
    def _callback(**kwargs):
        if kwargs['request'].method == 'POST':
            valid_inst = kwargs['valid_inst']
            redirect_path_variables = kwargs['redirect_path_variables']
            redirect_path_variables['id'] = valid_inst.project_id  # => redirect(project:detail, id=valid_inst.project_id)
        if kwargs['request'].method == 'GET':
            title = h_tag(2, '산출물 업데이트')
            kwargs['added_contents'][0] = title + card_row((kwargs['added_contents'][0], 12))

    return standard_update(request, id, 'standard/update.html', ProjectFile, ProjectFileUpdateForm, 'project:detail',
                           {}, 'doctris', _callback)

Callback function

위 그림과 같이 callback function 을 통해서 우리는 다양한 작업들을 수행 할 수 있습니다. 해당 function 에서의 callback function 은 딱히 정해진 목적은 없지만 대표적으로 2가지 목적을 가지고 수행합니다.

1. POST 일 때, 생성된 instance 을 활용해 작업을 할때 사용됩니다.

2. POST 일 때, redirect 시 필요한 키워드인자를 추가할때 사용합니다.

3. GET 일 때, content design 을 입히거나 html 을 추가하는 작업들을 수행합니다.

   1. 제목 을 추가하는 작업들을 수행합니다.

      title = h_tag(2, '프로젝트 목록')
      

   2. 위 예제에서는 curd_table_html 에 div class=card 에 curd_table_html 을 삽입하는 작업들을 수행합니다.

      added_contents = kwargs['added_contents']
      added_contents[0] = title + card_row((added_contents[0], 12)
      

⚠️ 추가적으로 added_contents 에 추가된 자료는 순서대로 화면에 랜더링 됩니다.