yspec

YSPEC

YSPEC - это смертельно простая проверка для структур. Это особенно полезно для проверки различных файлов YAML/JSON

Использование от CLI

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

Примечание: YSPEC может взять YAML/JSON для схемы и для данных

Использование из кода

 from yspec . checker import check

# Some code that prepares data and rules

check ( data , rules )

Формат схемы

Схема - это dict правил. Каждое правило делает проверку в соответствии с полем «совпадать». Схема должна включать правило «корня», которое применяется на верхнем объекте в структуре.

Например, структура (в YAML):

---
- ' string1 '
- ' string2 '

будет действительным для схемы (в YAML):

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

Соответствовать правилам

Простые типовые совпадения

Нить

 my_awesome_string :
  match : string 

Логический

 my_awesome_bool :
  match : bool 

Целое число

 my_awesome_int :
  match : int 

Плавать

 my_awesome_float :
  match : float 

Никто

 empty_object :
  match : none 

Любой

 any_type :
  match : any

Рекурсионный тип совпадает

Их два: дикта и список. Оба имеют одинаковую логику рекурсии. Сначала мы применяем некоторые проверки на самом объекте, а затем применяем другое (или то же) правило к детям (элементы списка или значения DICT).

Список

 my_list :
  match : list
  item : some_other_rule

Список - это тип повторяющегося. FIST IT проверяет, это список A, затем он проверяет каждый элемент в соответствии с правилом в «Item».

Диктат

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

Это правило, которое описывает дикт, который имеет два ключа (Key1 и Key2). Один из ключей (Key2) является обязательным. Key1 должен быть проверен в соответствии с правилом 'string_rule', в то время как любые другие ключи с любым другим (не Key1 или Key2) именем будут проверяться в соответствии с некоторым_отером_rule.

Если у нас есть удаление default_item

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

Дикт может быть с двумя клавишами (Key1, Key2) максимум

Образец простых и рекурсионных совпадений

Схема:

---
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

Данные:

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

Специальные матчи

Один матч

 constraint_list_item :
  match : one_of
  variants :
    - integer_rule
    - some_other_rule

Один из успешных матч, если какое -либо из правил из «вариантов» успеха.

Установить совпадение

Предположим, вам нужно проверить свой маленький список фруктов:

---
- apple
- plum

Вы можете использовать Set Match для него. В пункте вариантов Set Match вы перечислите все позитивные значения для этого типа:

---
root :
  match : list
  item : fruits

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

Выбор ключа DICT

Иногда вам нужно провести отдельные чеки на DICT, которые имеют некоторую пару ключей/значения.

Например, у вас есть следующие данные:

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

В этом примере у вас есть диктат, который имеет различную полезную нагрузку, зависит от ключа типа. Это возможно описать с помощью схемы:

---
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