Pakollisten kenttien käytön edut
Pydanticissa vaadittujen kenttien käyttämisessä on useita etuja.
- Tietojen täydellisyyden varmistaminen: Pakolliset kentät auttavat meitä varmistamaan, että tietomallimme ovat täydellisiä ja kelvollisia. Tämä voi auttaa estämään virheitä koodissa ja tietojen käsittelyssä.
- Haitallisen syötteen estäminen: Pakollisia kenttiä voidaan käyttää myös estämään haitallisia käyttäjiä syöttämästä virheellisiä tietoja järjestelmääsi.
- Koodista luettavampaa: Voit parantaa koodisi luettavuutta ja ymmärtämistä käyttämällä pakollisia kenttiä.
Kuinka määritellä vaaditut kentät Pydanticissa
Pydanticissa on kolme tapaa määrittää kenttä pakolliseksi kenttään. Tutkitaan jokaista niistä yksityiskohtaisesti.
Huomautusten käyttäminen
Yksinkertaisin tapa määrittää pakollinen kenttä Pydanticissa on käyttää huomautuksia. Käyttämällä merkintöjä, eräänlaista syntaktista metatietoa, voit lisätä lisätietoja luokkien muuttujista ja attribuuteista. Pydanticissa merkintöjä käytetään osoittamaan kentän odotettu tietotyyppi, ja oletusarvoisesti kaikki huomautetut kentät katsotaan pakollisiksi, kunnes teet kentästä tai kentät valinnaisia.
alkaen pydantinen tuonti Perusmalli
luokkaa Henkilö ( Perusmalli ) :
koko nimi: str
korkeus: kellua
sähköposti : str
Tässä esimerkissä koko_nimi, pituus ja sähköpostiosoite ovat kaikki pakollisia kenttiä. Jos luot Person-luokan esiintymän antamatta arvoja näille kentille, Pydantic herättää ValidationError-ilmoituksen, joka osoittaa, että vaaditut kentät puuttuvat.
yrittää :
henkilö_tiedot = {
'korkeus' : 5.8 ,
}
henkilö = Henkilö ( **person_data )
paitsi ValueError kuten Se on:
Tulosta ( se on )
Tässä esimerkissä kenttä full_name puuttuu, ja myös korkeuskenttä puuttuu. Molemmat kentät ovat pakollisia, ja ValidationError antaa selkeät tiedot puuttuvista kentistä.
Ellipsin käyttäminen (…)
Toinen tapa ilmoittaa kenttä Pydanticissa vaaditulla tavalla on käyttää ellipsiä ( … ). Tämä on Pydanticin tarjoama eksplisiittinen lähestymistapa kentän merkitsemiseen vaaditulla tavalla.
alkaen pydantinen tuonti Perusmalli
luokkaa Tuote ( Perusmalli ) :
nimi: str = ...
hinta : kellua = ...
kuvaus : str = ...
Tässä esimerkissä kenttien nimi, hinta ja kuvaus on kaikki määritetty vaadituiksi ellipsin avulla. Tämä menetelmä tekee selväksi ja näkyväksi, että tiettyjä kenttiä ei voi ohittaa tuoteluokan esiintymää luotaessa.
yrittää :tuote_tiedot = {
'nimi' : 'Kännykkä' ,
'kuvaus' : 'Älypuhelin 16 Gt RAM-muistilla' ,
}
tuote = Tuote ( **tuotetiedot )
paitsi ValueError kuten Se on:
Tulosta ( se on )
Tässä esimerkissä hintakenttä puuttuu, ja ValidationError osoittaa selvästi puuttuvan pakollisen kentän.
Kenttäfunktion käyttäminen
Pydantic-moduulin Field-toiminto tarjoaa lisäominaisuuksia kentän validoinnin ja metatietojen mukauttamiseen. Voit käyttää Kenttä-toimintoa pakollisten kenttien ilmoittamiseen ja lisävahvistussääntöjen soveltamiseen.
Näin voit määrittää pakolliset kentät Kenttä-toiminnolla:
alkaen pydantinen tuonti Perusmalli , Alaluokkaa Osoite ( Perusmalli ) :
katu: str = Ala ( ... , kuvaus = 'Katuosoite' )
kaupunki: str = Ala ( ... )
postinumero: str = Ala ( ... )
Tässä esimerkissä käytämme Field-funktiota pakollisten kenttien street, city ja zip_code määrittämiseen sekä muita vahvistussääntöjä ja kuvauksia. Ellipsi '…' osoittaa, että nämä kentät on määritettävä pakollisiksi kentiksi.
yrittää :osoite_tiedot = {
'katu' : '111 Main Street' ,
'postinumero' : '123456'
}
osoite = Osoite ( **osoitetiedot )
paitsi ValueError kuten Se on:
Tulosta ( se on )
Tässä esimerkissä kaupunkikenttä puuttuu, ja ValidationError antaa tietoja puuttuvasta pakollisesta kentästä.
Pakolliset kentät voidaan vahvistaa käyttämällä muita Pydantic-ominaisuuksia, kuten rajoituksia ja tyyppejä. Voit esimerkiksi määrittää, että nimikentän on oltava vähintään 5 merkin pituinen merkkijono. Voit mukauttaa pakollisten kenttien toimintaa Kentän koristelutyökalulla. Voit esimerkiksi määrittää kentälle oletusarvon tai näytettävän viestin, jos kentälle ei ole annettu arvoa.
Useiden menetelmien käyttäminen vaadittujen kenttien määrittämiseen yhdessä pydantisessa mallissa
Voit käyttää useita menetelmiä pakollisten kenttien määrittämiseen yhdessä Pydantic-mallissa. Voit esimerkiksi käyttää merkintöjä joissakin kentissä, ellipsissä ( … ) muille ja Kenttä-toiminto lisämuokkausta varten. Pydanticin avulla voit valita parhaan lähestymistavan koodin järjestykseen ja luettavuusasetuksiin. Harkitse seuraavaa esimerkkiä:
alkaen pydantinen tuonti Perusmalli , Alaluokkaa Työntekijä ( Perusmalli ) :
nimi: str
osasto: str = …
palkka: kellua = Ala ( … )
Tässä esimerkissä kaikkia kenttiä on käytettävä. Olemme käyttäneet kolmea eri menetelmää pakollisten kenttien määrittämiseen. Nimikentässä käytetään huomautusta, osastolla ellipsiä ja palkassa Kenttä-toimintoa.
Vinkkejä pakollisten kenttien käyttämiseen
Hyvien käytäntöjen noudattaminen pakollisten kenttien määrittämisessä Pydanticissa on välttämätöntä sujuvan ja ylläpidettävän koodin luomiseksi. Seuraavat vinkit auttavat sinua määrittämään vaadittavat kentät Pydanticissa:
- Käytä selkeitä ja kuvaavia kenttien nimiä : Valitse kentille merkitykselliset nimet, jotka osoittavat selvästi niiden tarkoituksen. Tämä auttaa muita kehittäjiä tietämään, mitä tietoja tarvitaan, ja vähentää pakollisten kenttien puuttumisen mahdollisuuksia.
- Anna informatiiviset kenttäkuvaukset : Kun käytät Kenttä-toimintoa pakollisten kenttien määrittämiseen, anna kuvaavat kuvaukset, jotka selittävät tietojen tarkoituksen ja odotetun muodon.
- Ryhmään liittyvät kentät : Jos tietomallissasi on suuri määrä kenttiä, harkitse liittyvien kenttien ryhmittelyä sisäkkäisiksi rakenteiksi. Tämä voi auttaa koodiasi olemaan luettavampaa ja helpottaa pakollisten kenttien hallintaa.
- Käytä mukautettuja viestejä pakollisiin kenttiin: Oletusarvoisesti Pydantic herättää ValueError-poikkeuksen, jos pakolliseen kenttään ei anneta arvoa. Voit muokata virheilmoitusta määrittämällä viestin argumentin Kentän koristelulle.
Johtopäätös
Pydantic tekee oletusarvoisesti kentät tarpeen mukaan. Voit kuitenkin määrittää kentän erikseen pakollisiksi kentiksi. Ilmoittamalla kentät tarpeen mukaan varmistat, että tietomallisi ovat tarkkoja, täydellisiä ja vaatimusten mukaisia. Tässä viestissä käsittelimme kolmea eri menetelmää vaadittujen kenttien määrittämiseen Pydanticissa, eli huomautuksia, ellipsiä (…) ja Field-funktiota. Lisäksi tarkastelimme joitain suositeltuja käytäntöjä pakollisten kenttien käyttämiseen, jotta voit määrittää kenttiä tehokkaasti tietomallissasi.