표준 Index Page 가이드

0. Pre•requisite

1. manage.py 파일이 있는 폴더 내 `helper.py` 가 존재해야 합니다.

2. templatetags

   |- index.py

3. templates/standard
   |-create.html
   |-detail.html
   |-update.html

1. What?

표준 인덱스는 Target 모델 record 항목들을 보여주는 Html Page 을 뜻함.
표준 Index page 는 standard_index() 을 통해 생성된 코드 및 HTML 을 의미한다.

def standard_index(request, model, model_filter, form_class, url_path, base, crud_table, callback, **callback_kwargs):
    added_contents = []
    instances = model.objects.filter(**model_filter)

    # url
    full_url = request.build_absolute_uri()
    base_url = get_base_url(full_url)

    # crud standard table
    crud_table_html = crud_table(base_url, instances, form_class._meta.fields, url_path)
    added_contents.append(crud_table_html)

    # callback
    if callback:
        callback(request=request, model=model, model_filter=model_filter, form_class=form_class, url_path=url_path,
                 base=base, instances=instances, crud_table_html=crud_table_html, added_contents=added_contents,
                 **callback_kwargs)

    # render
    ret_html = add_content(request, base, *added_contents)
    return HttpResponse(ret_html)

스크린샷 2024-01-26 오전 8 36 16

2. How to use ?(Basic)

def index(request):
    return standard_index(request, File, {}, FileCreateForm, 'file', None,
                          generate_crud_filetable,
                          None)

2.1 예상 결과물

2.2 인자 설명

:param request: HttpRequest 객체
:param model: Django 모델 클래스 (예: Project)
:param model_filter: 모델 쿼리셋 필터링을 위한 딕셔너리
:param form_class: Django 폼 클래스 (예: ProjectCreateForm)
:param url_path: 문자열로 구성된 URL 경로
:param base: 문자열로 구성된 기본 템플릿 경로
:param crud_table: CRUD 테이블 생성 함수
:param callback: 선택적인 콜백 함수 (함수 또는 메서드)
:param callback_kwargs: 콜백 함수에 전달할 추가 키워드 인자들
:return: HttpResponse 객체

함수는 Django 모델에 대한 표준 인덱스 뷰를 생성하며 CRUD 작업을 포함합니다.

2.3 CRUD Table 생성 하기

model, model_filter,form_class , curd_table 4가지 인자와 **kwargs 은 CRUD 테이블을 생성하는데 사용합니다.

2.3.1 사용 방법

가장 기본적인 table 은 helper.generate_crud_table 을 사용하면 됩니다. 사용 방법은 아래와 같습니다.

def index(request):
    return standard_index(request, File, {}, FileCreateForm, 'file', None,
                          generate_crud_filetable,
                          None)

2.3.2 로직

2.3.2.1 로직 개요

helper.generate_crud_table 은 Model 내 Form 내 정의되어 있는 field 을 table 형태로 만들어 반환합니다. 만약 model_filter 내 key-value 가 추가되어 있다면 filter 을 수행해 조건에 맞는 정보만을 테이블로 만들어 제공합니다.

코드 수준에서 이야기하자면 아래와 같습니다.

Model.objects.filter(key=value)

2.3.2.2 CRUD button 추가하기

위에서 만들어진 테이블에 create button , detail button , update button , delete button 생성해 추가합니다.

![스크린샷 2024-01-31 오후 6.43.51](/Users/kimseongjung/Library/Application Support/typora-user-images/스크린샷 2024-01-31 오후 6.43.51.png)

인자 url_path 은 crud_table function 에서 사용하는 인자로서 create, deatil, update, delete button 의 url 을 생성하는데 사용됩니다.(⚠️아래 그림에서 Url path 을 참조해 주세요. )

url_path 중 create, update, delete, datail 부분을 제외한 url_path 을 입력하면 된다.

각 button 별 url 은 아래와 같이 생성됩니다. Create : {base_url}/{url_path}/create Update : {base_url}/{url_path}/update Delete : {base_url}/{url_path}/delete Detail(Read) : {base_url}/{url_path}/Detail

2.3.3 Custom generate crud table

사용자 목적에 맞게 CRUD Table 내부 로직을 추가해야 할때가 있습니다.

예를들어 가령 파일을 다운로드 받을수 있는 링크를 건다던가 말이죠.

이때 사용자는 자신만의 custom generate crud table 을 생성 할 수 있습니다.

def fn(base_url, objects, field_names, url_path, **kwargs):

사용자는 목적에 맞게 여러개의 table 을 만들어 적용 할 수 있습니다. 가령 가장기본적인 crud table 은 아래 함수를 사용합니다.

def generate_crud_table(base_url, objects, field_names, url_path, **kwargs):
      field_names = field_names + ['detail', 'update', 'delete']
    if objects:  # 테이블 내 instance 존재 시 아래 코드 수행
        object_df = pd.DataFrame.from_records(objects.values())

        # detail button (read)
        append_onclick_button('detail', base_url, object_df, url_path)

        # generate update urls, (update)
        append_onclick_button('update', base_url, object_df, url_path)

        # delete button (delete)
        append_onclick_button('delete', base_url, object_df, url_path)


    else:  # 테이블이 하나도 존재하지 않으면 아래 코드 수행
        object_df = pd.DataFrame(columns=field_names)

    object_df = object_df.loc[:, field_names]
    # df -> html
    table_html = object_df.to_html(escape=False)

    # create button
    url = generate_url(base_url, os.path.join(url_path, 'create'))
    button_tag = create_button(url, 'create')
    crud_table = button_tag + table_html
    return crud_table

사용자는 위 코드를 변형하여 각자의 목적에 맞는 crud table 을 생성할수 있습니다. 아래 예시를 보겠습니다. 파일을 다운로드 할수 있는 링크가 같이 있는 table 을 생성하는 예제입니다.

def generate_crud_filetable(base_url, objects, field_names, url_path, **kwargs):
    """
    다운로드 링크를 제공합니다.
    제공된 객체와 필드 이름을 기반으로 한 CRUD 테이블을 HTML 형식으로 생성합니다.
    생성될 table 가장 오른쪽 field Detail,  Update , Delete field 을 생성하고 button 을 생성합니다.
    +----------+
    | create   |
    | <button> |
    +--------+-------+----------+----------+----------+
    | Object | Field | Detail   | Update   | Delete   |
    +--------+-------+----------+----------+----------+
    | Object1| Field1| <button> | <button> | <button> |
    | Object2| Field2| <button> | <button> | <button> |
    +--------+-------+----------+----------+----------+

    """
    target_column = kwargs['target_column'] #<-- 추가된 코드
    field_names = field_names + ['detail', 'update', 'delete']

    if objects:  # 테이블 내 instance 존재 시 아래 코드 수행

        # 파일 다운로드를 위한 URL 리스트 생성
        urls = [file.filecontent.url for file in objects] #<-- 추가된 코드
        # filecontent column 에 파일 다운로드 링크 생성 
        object_df = pd.DataFrame.from_records(objects.values()) #<-- 추가된 코드
        target_series = object_df.loc[:, target_colname]#<-- 추가된 코드
        url_tags = [wrap_with_tag(str(ele), tag_name='a', href=url) for ele, url in zip(target_series, urls)]#<-- 추가된 코드
        object_df.loc[:, target_colname] = url_tags#<-- 추가된 코드

        # detail button (read)
        append_onclick_button('detail', base_url, object_df, url_path)

        # generate update urls, (update)
        append_onclick_button('update', base_url, object_df, url_path)

        # delete button (delete)
        append_onclick_button('delete', base_url, object_df, url_path)


    else:  # 테이블이 하나도 존재하지 않으면 아래 코드 수행
        object_df = pd.DataFrame(columns=field_names)

    object_df = object_df.loc[:, field_names]
    # df -> html
    table_html = object_df.to_html(escape=False)

    # create button
    url = generate_url(base_url, os.path.join(url_path, 'create'))
    button_tag = create_button(url, 'create')
    crud_table = button_tag + table_html
    return crud_table

하지만 파일 다운로드 링크가 있는 crud table 은 아래 table 을 사용합니다.#<-- 추가된 코드을 확인하면 됩니다. ⚠️ 키워드 인자가 공통적으로 generate crud table 에서도 사용되는것에 주의해 주세요.

2.4 Callback function

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

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 에 추가된 자료는 순서대로 화면에 랜더링 됩니다.

사용자는 키워드 인자를 통해 보다 자유롭게 작업들을 수행 할수 있습니다. ⚠️ 키워드 인자가 공통적으로 generate crud table 에서도 사용되는것에 주의해 주세요.

standard index - pai-plznw4me/django-initializer GitHub Wiki

표준 Index Page 가이드

0. Pre•requisite

1. What?

2. How to use ?(Basic)

2.1 예상 결과물

2.2 인자 설명

2.3 CRUD Table 생성 하기

2.3.1 사용 방법

2.3.2 로직

2.3.2.1 로직 개요

2.3.2.2 CRUD button 추가하기

2.3.3 Custom generate crud table

2.4 Callback function

⚠️ GitHub.com Fallback ⚠️

standard index - pai-plznw4me/django-initializer GitHub Wiki

표준 Index Page 가이드

0. Pre•requisite

1. What?

2. How to use ?(Basic)

2.1 예상 결과물

2.2 인자 설명

2.3 CRUD Table 생성 하기

2.3.1 사용 방법

2.3.2 로직

2.3.2.1 로직 개요

2.3.2.2 CRUD button 추가하기

2.3.3 Custom generate crud table

2.4 Callback function

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️