yspecダウンロードyspecソースコードのダウンロード

yspec

AI ソースコード

v0.1.0

ダウンロード

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 )

スキーマ形式

スキーマはルールの口述です。すべてのルールは、「一致」フィールドに従ってチェックを行います。スキーマには、構造内の上部オブジェクトに適用される「ルート」ルールを含める必要があります。

たとえば、構造（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

再帰タイプの一致

それらの2つがあります：dictとlist。どちらも同じ再帰ロジックを持っています。最初は、オブジェクト自体にいくつかのチェックを適用してから、別の（または同じ）ルールを子供に適用します（リスト要素、またはDICTの値）。

dict

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

これは、2つのキー（key1とkey2）を持つdictを説明するルールです。キーの1つ（key2）が必須です。 key1は「string_rule」ルールに従ってチェックする必要がありますが、他のキー（non key1またはkey2）の他のキーはsome_other_ruleに従ってチェックされます。

default_itemを削除した場合

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

DICTは、最大2つのキー（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 "

特別な試合

1つの試合

 constraint_list_item :
  match : one_of
  variants :
    - integer_rule
    - some_other_rule

「バリアント」の成功からのルールのいずれかが成功した場合の1つの一致。

一致を設定します

果物の小さなリストを確認する必要があると仮定します。

---
- apple
- plum

セットマッチを使用できます。バリエーション節のセットマッチの句は、このタイプのすべてのposible値をリストします。

---
root :
  match : list
  item : fruits

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

キーの選択を説明します

キー/値のペアを持つDICTの個別のチェックを行う必要がある場合があります。

たとえば、次のデータがあります。

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

その例では、型キーに依存する異なるペイロードのwichがあります。これは、次のスキーマで説明することが可能です。

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