跳到主要內容

[Django教學10]Django ModelForm客製化表單欄位驗證的技巧

Photo by Adolfo Félix on Unsplash
各位在使用多數網站填寫表單時,像是註冊資料,都有遇過填寫的資料不正確時,出現錯誤訊息,提醒使用者進行修改的情況,這就是所謂的表單驗證,用來防止使用者輸入不正確的資料,導致網站無法執行或收集到錯誤的資訊。

在使用PythonDjango框架來開發網站表單時,預設會依據資料模型(Model),所定義的欄位類型及參數設定,執行基本的檢核,但是實務上,有一些欄位可能需要特殊的檢核邏輯,這時候,就可以使用本文所分享的技巧,來客製化自己的表單驗證機制。

Django常用的FormModelForm兩大表單類別,客製化表單欄位驗證的方式大同小異,所以本文將以ModelForm為例,進行實作的說明,而Form類別,留給各位來進行練習。本文的重點包含:
  • 建立Django Model(資料模型)
  • 建立Django ModelForm(資料模型表單)
  • Django ModelForm預設表單檢核
  • Django ModelForm客製化表單檢核

一、建立Django Model(資料模型)

首先,在Django應用程式(APP)下,在models.py檔案中,新增一個資料模型類別,如下範例:
from django.db import models


class Customer(models.Model):
    name = models.CharField(max_length=30, blank=False, null=False)
    email = models.EmailField(blank=False, null=False)
    tel = models.IntegerField()
接著,執行以下的Django Migration(資料遷移)指令,將資料模型中所定義的欄位屬性,同步至資料庫中:

$ python manage.py makemigrations

$ python manage.py migrate

最後,將Django資料模型加入至Django Administration(管理員後台),並且客製化欄位顯示方式,以方便檢視資料的新增狀況,如下範例:
from django.contrib import admin
from .models import Customer


class CustomerAdmin(admin.ModelAdmin):
    list_display = ('id', 'name', 'email', 'tel')  # 顯示欄位


admin.site.register(Customer, CustomerAdmin)  # 加入至Administration(管理員後台)
啟動本地端伺服器,連線至Django Administration(管理員後台),即可看到所建立的資料模型,如下:

$ python manage.py runserver

執行結果

二、建立Django ModelForm(資料模型表單)

Django資料模型建置完成後,在應用程式(APP)下,新增forms.py檔案,利用資料模型的欄位屬性來建立表單,也就是Django ModelForm(資料模型表單),如下範例:
from django import forms
from .models import Customer


class CustomerModelForm(forms.ModelForm):

    class Meta:
        model = Customer
        fields = '__all__'
        widgets = {
            'name': forms.TextInput(attrs={'class': 'form-control', 'style': 'width:50%;'}),
            'email': forms.TextInput(attrs={'class': 'form-control', 'style': 'width:50%;'}),
            'tel': forms.TextInput(attrs={'class': 'form-control', 'style': 'width:50%;'})
        }
        labels = {
            'name': '姓名',
            'email': '電子郵件',
            'tel': '聯絡電話'
        }
範例中客製化顯示Django ModelForm(資料模型表單)的觀念,可以參考[Django教學7]透過Django ModelForm快速開發CRUD應用程式教學文章。接下來,開啟views.py檔案,撰寫初始化表單,以及送出後的儲存邏輯,最後,將表單傳遞至Template(樣板)中,如下範例:
from django.shortcuts import render, redirect
from .forms import CustomerModelForm


def index(request):

    form = CustomerModelForm()

    if request.method == "POST":
        form = CustomerModelForm(request.POST)
        if form.is_valid():
            form.save()
            return redirect('/customers')

    context = {
        'form': form
    }

    return render(request, 'customers/index.html', context)
接著,在index.html,利用Django Template(樣板)語法,來顯示傳遞過來的Django ModelForm(資料模型表單),如下範例:
{% extends 'base.html' %}

{% block content %}

    <h1>客戶基本資料</h1>

    <form action="" method="POST">
        {% csrf_token %}

        {{ form.as_p }}
        <input class="btn btn-primary" type="submit" value="" />
    </form>

{% endblock  %}
開啟Django應用程式(APP)下的urls.py,設定此樣板的路由網址,如下範例:
from django.urls import path
from . import views

urlpatterns = [
    path('', views.index, name='Index')
]
執行結果

三、Django ModelForm預設表單檢核

這時候在沒有填寫任何資料的情況下,點擊儲存時,Django就會依據CustomerModelForm表單類別中,對應的資料模型所定義的屬性欄位及參數,進行基本的檢核,如下範例:


由於定義姓名及電子郵件的欄位不得為空,所以Django會進行表單檢核,要求填寫欄位資料。 

四、Django ModelForm客製化檢核

雖然Django預設會幫我們進行表單資料的基本檢核,但是實務上,有時候需要特殊的邏輯來驗證資料,比如說,客戶在電子郵件的欄位,不得輸入Hotmail的電子郵件,該如何實現呢?

這時候,就可以開啟Django應用程式(APP)下的forms.py檔案,在表單類別中,定義「clean_」關鍵字開頭的方法,並且加上欄位的名稱,在其中即可自訂該欄位的檢核邏輯,如下範例:
from django import forms
from .models import Customer


class CustomerModelForm(forms.ModelForm):

    class Meta:
        model = Customer
        fields = '__all__'
        widgets = {
            'name': forms.TextInput(attrs={'class': 'form-control', 'style': 'width:50%;'}),
            'email': forms.TextInput(attrs={'class': 'form-control', 'style': 'width:50%;'}),
            'tel': forms.TextInput(attrs={'class': 'form-control', 'style': 'width:50%;'})
        }
        labels = {
            'name': '姓名',
            'email': '電子郵件',
            'tel': '聯絡電話'
        }

    def clean_email(self, *args, **kwargs):
        email = self.cleaned_data.get('email') #取得樣板所填寫的資料
        if email.endswith('@hotmail.com'):
            raise forms.ValidationError('不得使用Hotmail電子郵件')
        return email
執行結果
從執行結果可以看到,當輸入Hotmail的電子郵件時,則會依照自訂的檢核邏輯,顯示相應的錯誤訊息。而如果輸入非Hotmail的電子郵件,即可成功儲存至資料庫中,如下範例:
Django Administration(管理員後台)的儲存結果,如下圖:

五、小結

以上就是Django客製化表單檢核邏輯的方式,簡單來說,就是在Django的表單類別中,定義欄位的方法,在其中實作該欄位的檢核邏輯,讓網站的表單檢核更有彈性。詳細的實作歷程,可以參考GitHub原始碼,如果在練習的過程中,有碰到任何問題,歡迎大家留言提問或分享,我將盡力為各位解答,希望有幫助到大家。

如果您喜歡我的文章,請幫我按五下Like(使用GoogleFacebook帳號免費註冊),支持我創作教學文章,回饋由LikeCoin基金會出資,完全不會花到錢,感謝大家。

GitHub網址:https://github.com/mikeku1116/django-formvalidation


有想要看的教學內容嗎?歡迎利用以下的Google表單讓我知道,將有機會成為教學文章,分享給大家😊

你可能有興趣的文章









留言

張貼留言

這個網誌中的熱門文章

[Pandas教學]資料分析必懂的Pandas DataFrame處理雙維度資料方法

Photo by Slidebean on Unsplash 現在有許多的企業或商家,都會利用取得的使用者資料來進行分析,瞭解其中的趨勢或商機,由此可見,資料分析越來越受到重視,而這時候,能夠懂得使用資料分析工具就非常的重要。 在上一篇 [Pandas教學]資料分析必懂的Pandas Series處理單維度資料方法 文章中,分享了Pandas Series資料結構用於處理單維度資料集的實用方法,而本文則要來介紹Pandas套件的另一個非常重要的資料結構,也就是 DataFrame。

[Python教學]搞懂5個Python迴圈常見用法

Photo by Scott Webb on Unsplash 在撰寫程式的過程中,都有機會要重複執行一些相同的運算,但是重複撰寫好幾次同樣的運算看起來非常的沒有效率,所以在這個情況下我們通常會使用迴圈來幫我們完成,本篇就來介紹 Python 迴圈的使用方式,包含 For-Loops 、 Nested Loops 及 while-Loops ,並且說明用來控制迴圈流程的 break 及 continue 指令。 一、 range() 方法 在開始介紹 Python 迴圈之前,先來說明一個在執行迴圈時常用的 range() 方法,主要用來幫我們產生數列,語法如下: range( 起始值 , 結束值 , 遞增 ( 減 ) 值 ) 使用說明: range(20) :起始值預設從 0 開始,所以會產生 0 到 19 的整數序列。 range(10,20) :起始值從 10 開始,所以會產生 10 到 19 的整數序列。 range(10,20,3) :起始值從 10 開始,遞增值為 3 ,所以會產生 10,13,16,19的整數序列 。 二、 Python For-Loops 敘述 可以針對 Iterable( 可疊代的 ) 物件來進行讀取, Python 內建幾個常用的 Iterable 物件,像是 String( 字串 ) 、 List( 串列 ) 、 Tuples( 元組 ) 、 Dictionary( 字典 ) 等,往後會出文章詳細的介紹。 Python for-loop 的語法如下: 在語法中, in 的後方就是 for-loop 要讀取的目標物,這個目標物的為 Iterable ( 可疊代的 ) 物件,一次讀取一個元素,然後用 item( 自訂變數名稱 ) 來接收每次讀取到的元素,執行區塊中的運算。注意 for-loop 的結尾需加上冒號 ( : ) 及區塊中的運算式要有相同的縮排,範例如下: 在範例中, for-loop 的讀取目標物為一個字串,每一次讀取一個字母,並且用 letter 變數來接收,執行 print() 方法。 三、 Python Nested Loops ( 巢狀迴圈 ) 簡單來說,就是迴圈中又有一層迴圈,我們來看一個範例:   這...

[Python物件導向]淺談Python類別(Class)

Photo by Bram Naus on Unsplash 在學習程式語言時,或多或少都有聽過物件導向程式設計 (Object-oriented programming ,簡稱 OOP) ,它是一個具有物件 (Object) 概念的開發方式,能夠提高軟體的重用性、擴充性及維護性,在開發大型的應用程式時更是被廣為使用,所以在現今多數的程式語言都有此種開發方式, Python 當然也不例外。而要使用物件導向程式設計就必須對類別 (Class) 及物件 (Object) 等有一些基本的了解,包含了: 類別 (Class) 物件 (Object) 屬性 (Attribute) 建構式 (Constructor) 方法 (Method) 我們先來看一下今天要來建立的類別: # 汽車類別 class Cars: # 建構式 def __init__(self, color, seat): self.color = color # 顏色屬性 self.seat = seat # 座位屬性 # 方法(Method) def drive(self): print(f"My car is {self.color} and {self.seat} seats.") 接下來就針對類別 (Class) 各個部分來進行介紹。 一、類別 (Class) 簡單來說,就是物件 (Object) 的藍圖 (blueprint) 。就像要生產一部汽車時,都會有設計圖,藉此可以知道此類汽車會有哪些特性及功能,類別 (Class) 就類似設計圖,會定義未來產生物件 (Object) 時所擁有的屬性 (Attribute) 及方法 (Method) 。而定義類別的語法如下: class classname:   statement 首先會有 class 關鍵字,接著自定類別名稱,最後加上冒號。類別名稱的命名原則習慣上使用 Pascal 命名法,也就是每個單字字首大寫,不得使用空白或底線分隔單字,如下範例: #範例一 class Cars: #範例二 class MyCars: 二、物件 (Object) 就是透過...

[Python爬蟲教學]7個Python使用BeautifulSoup開發網頁爬蟲的實用技巧

Photo by Stanley Dai on Unsplash 在實務上開發專案時,很多時候會利用其他網站的資料來進行分析或運用,而取得的方式除了透過網站所提供的 API(Application Programming Interface) 外,也可以利用 Python 來開發爬蟲程式,將網頁的 HTML 內容下載下來,接著利用 BeautifulSoup 套件 (Package) ,擷取所需的資訊。 本文將開發一個簡單的爬蟲程式,爬取「 ETtoday 旅遊雲 」網頁,擷取桃園旅遊景點的標題資訊,如下圖: 取自ETtoday 的旅遊雲 而在開發的過程中,常會需要搜尋 HTML 的節點,本文將分享幾個常用的方法,包含: BeautifulSoup 安裝 以 HTML 標籤及屬性搜尋節點 以 CSS 屬性搜尋節點 搜尋父節點 搜尋前、後節點 取得屬性值 取得連結文字 一、 BeautifulSoup 安裝 BeautifulSoup 是一個用來解析 HTML 結構的 Python 套件 (Package) , 將取回的網頁 HTML 結構, 透過其提供的方法 (Method) ,能夠輕鬆的搜尋及擷取網頁上所需的資料,因此廣泛的 應用在網頁爬蟲的開發上 。 Beautifulsoup 套件 (Package) 可以透過 pip 指令來進行安裝,如下範例: pip install beautifulsoup4 而要解析網頁的 HTML 程式碼前,還需要安裝 Python 的 requests 套件 (Package) ,將要爬取的網頁 HTML 程式碼取回來,安裝方式如下: pip install requests 安裝完成後,首先引用 requests 套件 (Package) ,並且 透過 get() 方法 (Method) 存取 ETtoday 旅遊雲的桃園景點網址,如下範例: import requests response = requests.get( "https://travel.ettoday.net/category/%E6%A1%83%E5%9C%92/") 將網頁的 HTML 程式碼取回來後,接著引用 BeautifulSoup...

[Python教學]5個必知的Python Function觀念整理

Photo by Susan Holt Simpson on Unsplash 在寫程式碼時有一個非常重要的觀念是 DRY(Don’t Repeat Yourself) ,意思是避免 同樣的程式碼重複出現在很多個地方, 除了可讀性很低外,也不易維護。所以 要適當的進行封裝,來達到程式碼的重用性 (Reusable) 。 今天要來教大家如何建構自己的   Python 函式 (Function) ,就是能夠讓你的程式碼被重複的使用 (Reusable) ,並且提高維護性 及可讀性。其中有五個必須要知道的重要觀念, 包含了: 函式 (Function) 結構 函式(Function) 參數 函式(Function) *args 、 **kwargs 運算子 函式(Function) 種類 函式(Function) 變數範圍 (Scope) 一、函式 (Function) 結構 首先Python 函式 的結構包含了 def 關鍵字、 函式 名稱、參數及實作內容,如下範例: 函式 名稱的命名習慣上會使用小寫字母,並且以底線來分隔單字。參數用來接收外部資料,而實作的內容則是這個 函式 所要執行的任務,需注意縮排。接下來就針對 函式 的各個部分進行詳細的說明。 二、 函式(Function) 參數 參數簡單來說就是接收外部所傳來的資料,進而執行相關的邏輯運算。參數個數取決於 函式 內部運算時所需的資料個數,所以在一般情況下,呼叫 函式 時一定要傳入相對的參數個數資料,否則就會出現例外錯誤,如下範例: 函式 的參數,又可分為: 關鍵字參數 (Keyword Argument) : 呼叫函式時,在傳入參數值的前面加上函式所定義的參數名稱,如下範例。除了提高可讀性外,也可將此種參數打包成 字典 (Dictionary) 資料型態,在等一下的 xargs 、 xxargs 運算子部分會來進行說明。 預設值參數 (Default Argument) : 在函式定義的參數中,將可以選擇性傳入的參數設定一個預設值,當來源端有傳入該資料時,使用來源端的資料,沒有傳入時,則依照設定的預設值來進行運算,如下範例: 範例中沒有傳入日期參數資料,所以 函式 使用預設值 (...

[Pandas教學]5個實用的Pandas讀取Excel檔案資料技巧

Photo by LinkedIn Sales Navigator on Unsplash 日常生活中,不免俗的都會有需要整理大量資料的需求,而最常用的文書軟體就是Excel,這時候該如何有效讀取Excel檔中的資料,進行額外的整理及操作呢? 本文將以 政府開放資料平台-歷年國內主要觀光遊憩據點遊客人數月別統計 的資料內容為例, 利用Python的Pandas套件,來和大家分享實務上最常見的Excel讀取操作,藉此來提升資料處理的效率。

[Python教學]Python Lambda Function應用技巧分享

Photo by Fatos Bytyqi on Unsplash Lambda 函式,也就是匿名函式,不需要定義名稱,只有一行運算式,語法非常簡潔,功能強大,所以現代程式語言如 Java、C# 及 Python 等都支援 Lambda 函式,適用於小型的運算, Python的 一些內建函式甚至使用它作為參數值的運算。現在就來介紹 如何 在 Python 中使用 Lambda 函式與技巧吧,包含: Lambda 語法與範例 Python Lambda 函式的應用 Lambda 函式 vs 一般函式 (Function) 一、 Lambda 語法與使用範例 由於 Lambda 函式只有一行程式碼,所以在撰寫時有一些限制,我們來看一下它的語法: lambda parameter_list: expression 這邊教大家一個技巧,在撰寫 Lambda 函式時,於 Visual Studio Code 輸入 lambda 關鍵字,接著按下 Tab 鍵,就會自動產生範例中的語法,包含了三個部分: lambda 關鍵字 parameter_list( 參數清單 ) expression( 運算式 ) 其中, parameter_list( 參數清單 ) 也就是 Lambda 函式的傳入參數,可以有多個,以逗號分隔。而 expression( 運算式 ) 則是針對傳入參數來進行運算,只能有一行運算式,不像 一般函式(Function) 可以有多行。接下來,我們透過幾個範例來了解如何使用 Lambda 函式吧。 範例 1 : 範例中將 Lambda 函式指派給一個變數,接著就可以透過此變數並傳入參數來進行呼叫。 範例 2 : Lambda 函式支援 IIFE(immediately invoked function expression)語法 ,意思是 利用  function expression 的方式來建立函式,並且立即執行它,語法如下 : (lambda parameter: expression)(argument) 範例中即是利用此語法在 Lambda函式 定義後,立即傳入參數執行。 範例 3 : 透過此範例可以知道,當 Lambda 函...

[Python+LINE Bot教學]6步驟快速上手LINE Bot機器人

Photo by Yura Fresh on Unsplash 每當朋友或家人要聚餐時,是不是總要花很長的時間尋找評價不錯的餐廳?不但要確認營業時間、消費價格及地點,還要觀看許多的美食文章才有辦法決定,這時候如果有人能夠明確提供幾間符合條件且有人氣的餐廳作為選擇,想必會省事許多。 所以筆者開發了一個美食的 LINE Bot 小作品,透過對談的方式瞭解使用者所要尋找的餐廳條件後,利用 Python 網頁爬蟲取得目前正在營業的五間最高人氣餐廳資料,回覆給使用者作為參考。 為了要讓想學習的您能夠由淺入深,瞭解其中的實作過程,所以將會分成三篇文章來進行教學。 2020/06/30 補充說明 而在進行實作前,先來看一下 LINE Bot 主要的執行架構,如下圖: 使用者透過 LINE 發送訊息時, LINE Platform 將會進行接收,並且傳遞至我們所開發的 LINE Bot 執行邏輯運算後,透過 LINE 所提供的 Messaging API 回應訊息給 LINE Platform ,最後再將訊息傳遞給使用者。 其中 Messaging API(Application Programming Interface) ,就是 LINE 官方定義的 回應訊息 標準介面,包含 Text (文字)、 Sticker (貼圖)、 Video (影片)、 Audio (聲音)及 Template (樣板)訊息等,完整的說明可以參考 LINE 的 官方文件 。 所以在我們的 LINE Bot 回應訊息時,就要依據 Messaging API 定義的規範,傳入相應的參數後, Messaging API 就會回應使用者相對的訊息類型。簡單來說,就是 LINE Platform 與 LINE Bot 的溝通橋樑。 而本文就先以最基本的使用者發送什麼訊息, LINE Bot 就回應什麼訊息為例,讓讀者體會其中的運作方式,整體架構如下圖: 在 LINE Bot 的部分,使用 Django 框架來進行建置,並且透過 Messaging API 回應 Text (文字)訊息。在下一篇文章中,將會加入 Python 網頁爬蟲,取得美食網站的資訊回應給使用者。 本文的實作步驟包含: 建立 Provider 建立 Messaging API channel 設定 LINE Bot 憑證 開發 LINE B...

[Python爬蟲教學]整合Python Selenium及BeautifulSoup實現動態網頁爬蟲

Photo by LAUREN GRAY on Unsplash 相信大家都知道,取得資料後能夠進行許多的應用,像是未來的趨勢預測、機器學習或資料分析等,而有效率的取得資料則是這些應用的首要議題,網頁爬蟲則是其中的一個方法。 網頁爬蟲就是能夠取得網頁原始碼中的元素資料技術,但是,有一些網頁較為特別,像是社群平台,需先登入後才能進行資料的爬取,或是電商網站,無需登入,但是要透過滾動捲軸,才會動態載入更多的資料,而要爬取這樣類型的網頁爬蟲,就稱為動態網頁爬蟲。 該如何實作呢? 本文將使用 Python Selenium 及 BeautifulSoup套件 來示範動態網頁爬蟲的開發過程,重點包含: BeautifualSoup vs Selenium 安裝 Selenium 及 Webdriver 安裝 BeautifulSoup Selenium get() 方法 Selenium 元素定位 Selenium send_keys() 方法 Selenium execute_script 方法 BeautifulSoup find_all() 方法 BeautifulSoup getText() 方法 一、 BeautifualSoup vs Selenium BeautifulSoup套件 相信對於 開發 網頁爬蟲的人員來說,應該都有聽過,能夠解析及取得 HTML 原始碼各個標籤的元素資料,擁有非常容易上手的方法 (Method) ,但是,對於想要爬取 動態 網頁資料來說,則無法達成,因為 BeautifulSoup套件 並沒有模擬使用者操作網頁的方法 (Method) ,像是輸入帳號密碼進行登入或滾動捲軸等,來讓網頁動態載入資料,進行爬取的動作。 所以,這時候,就可以使用被設計於自動化測試的 Selenium 套件,來模擬使用者的動作,進行登入後爬取資料或滾動卷軸,並且能夠執行 JavaScript 程式碼,這些就是 Selenium 與 BeautifulSoup套件 最大不同的地方。對於開發 Python 動態爬蟲來說,就可以結合 Selenium套件 以上的特點,讓網頁動態載入資料後,再利用 BeautifulSoup套件簡潔的 方法 (Method) ,將所需的資料爬取下來。 本文就是利用這樣的概念,利用 Selenium 套件登入 Facebook 後,前往...

[Python爬蟲教學]有效利用Python網頁爬蟲爬取免費的Proxy IP清單

Photo by Cytonn Photography on Unsplash 在開發網頁爬蟲的過程中,是不是會擔心被偵測或封鎖,而爬不到所需的資料呢? 有些大型網站為了保護網頁上的資料不被大量的爬取,會特別偵測像Python網頁爬蟲這種非人工的自動化請求,這時候 Python網頁爬蟲 使用相同的IP來發送請求就很容易被發現。 所以,如果有多組IP能夠讓Python網頁爬蟲在發送請求時輪流使用,就能夠大幅降低被偵測的風險。 而現在有許多網站上也有提供免費的Proxy IP,本文就以 Free Proxy List 網站為例,透過Python網頁爬蟲來蒐集上面的Proxy IP,製作我們的IP清單。實作步驟包含: