yspec

yspec

YSPEC adalah pemeriksa sederhana yang mematikan untuk struktur. Ini sangat berguna untuk validasi file YAML/JSON yang berbeda

Penggunaan dari CLI

yspec ./schema.yaml /tmp/data.json

Catatan: YSPEC dapat mengambil YAML/JSON untuk skema dan untuk data

Penggunaan dari kode

 from yspec . checker import check

# Some code that prepares data and rules

check ( data , rules )

Format Skema

Skema adalah dikt aturan. Setiap aturan melakukan beberapa cek sesuai dengan bidang 'Match'. Skema harus menyertakan aturan 'root' yang diterapkan pada objek teratas dalam struktur.

Misalnya struktur (di YAML):

---
- ' string1 '
- ' string2 '

akan valid untuk skema (di YAML):

---
root :
  match : list
  item : string
  
string :
  match : string 

Aturan cocok

Pencocokan tipe sederhana

Rangkaian

 my_awesome_string :
  match : string 

Boolean

 my_awesome_bool :
  match : bool 

Bilangan bulat

 my_awesome_int :
  match : int 

Mengambang

 my_awesome_float :
  match : float 

Tidak ada

 empty_object :
  match : none 

Setiap

 any_type :
  match : any

Jenis rekursi cocok

Ada dua dari mereka: Dikt dan Daftar. Keduanya memiliki logika rekursi yang sama. Pada awalnya kami menerapkan beberapa cek pada objek itu sendiri, dan kemudian menerapkan aturan lain (atau sama) untuk anak -anak (elemen daftar, atau nilai -nilai dikt).

Daftar

 my_list :
  match : list
  item : some_other_rule

Daftar adalah tipe yang berulang. Tinju itu memeriksa adalah objek yang Daftar A, lalu periksa setiap elemen sesuai dengan aturan di 'item' attr.

Dikt

 my_list :
  match : dict
  items :
    key1 : string_rule
    key2 : integer_rule
  default_item : some_other_rule
  required_items :
    - key2

Itu adalah aturan yang menggambarkan dikt yang memiliki dua kunci (Key1 dan Key2). Salah satu kunci (Key2) adalah wajib. KEY1 harus diperiksa sesuai dengan aturan 'String_rule', sedangkan tombol lain dengan nama lain (non -Key1 atau Key2) akan diperiksa sesuai dengan some_other_rule.

Jika kami telah menghapus default_item

 my_list :
  match : dict
  items :
    key1 : string_rule
    key2 : integer_rule
  required_items :
    - key2

Dikt bisa dengan dua kunci (key1, key2) maksimal

Contoh kecocokan sederhana dan rekursi

Skema:

---
boolean :
  match : bool

string :
  match : string

integer :
  match : int

float :
  match : float

list :
  match : list
  item : string

root :
  match : dict
  items :
    key1 : boolean
    key2 : string
    key3 : integer
    key4 : float
    key5 : list

Data:

---
key1 : true
key2 : " That is a string "
key3 : 1
key4 : 1.0
key5 :
  - " One more string "
  - " Another string "

Pertandingan khusus

Satu pertandingan

 constraint_list_item :
  match : one_of
  variants :
    - integer_rule
    - some_other_rule

Salah satu cocok dengan sukses jika ada aturan dari "varian" kesuksesan.

Setel pertandingan

Misalkan Anda perlu memeriksa daftar kecil buah Anda:

---
- apple
- plum

Anda dapat menggunakan set yang cocok untuk itu. Dalam Varian Klausul Set Kecocokan Anda mencantumkan semua nilai yang mungkin untuk jenis ini:

---
root :
  match : list
  item : fruits

fruits :
  match : set
  variants :
    - apple
    - orange
    - plum 

Dict Seleksi Kunci

Beberapa kali Anda perlu melakukan cek terpisah untuk dikt yang memiliki beberapa pasangan kunci/nilai.

Misalnya Anda memiliki data berikut:

---
- type : type1
  payload :
    - 1
    - 1
- type : type2
  payload :
    - " that is a string "
    - " that is a string2 "

Dalam contoh itu Anda memiliki dikt yang memiliki muatan yang berbeda tergantung pada kunci tipe. Itu mungkin untuk dijelaskan dengan skema berikut:

---
root :
  match : list
  item : list_item

list_item :
  match : dict_key_selection
  selector : type
  variants :
    type1 : dict_with_int
    type2 : dict_with_string

dict_with_int :
  match : dict
  items :
    type : string
    payload : list_of_int
  required_items :
    - type
    - payload

dict_with_string :
  match : dict
  items :
    type : string
    payload : list_of_string
  required_items :
    - type
    - payload
  

list_of_int :
  match : list
  item : int
  
int :
  match : int
  
list_of_string :
  match : list
  item : string
  
string :
  match : string