链接Avro数据模式注释（SALAD）

导航

验证详情

这些详情已经由PyPI 验证
维护者
Avatar for mcrusoe from gravatar.com mcrusoe Avatar for mvdbeek from gravatar.com mvdbeek Avatar for rwn from gravatar.com rwn Avatar for tetron from gravatar.com tetron

未验证详情

这些详情尚未由PyPI验证
项目链接
元数据
分类器

项目描述

Linux Build Status Code coverage Documentation Status CII Best Practices

Schema Salad

沙拉是一种用于描述JSON或YAML结构化链接数据文档的模式语言。沙拉模式描述了用于预处理、结构验证和超链接检查的规则，这些规则适用于由沙拉模式描述的文档。沙拉支持具有继承、模板专用化、对象标识符、对象引用、文档生成、代码生成以及转换为RDF的丰富数据建模。沙拉为面向文档和面向记录的数据建模与语义网之间提供了一个桥梁。

Schema Salad库仅支持Python 3.8及以上版本。

安装

pip3 install schema_salad

如果您打算使用schema-salad-tool –codegen=python功能，请包含额外组件[pycodegen]。

pip3 install schema_salad[pycodegen]

从源代码安装

git clone https://github.com/common-workflow-language/schema_salad
cd schema_salad
pip3 install .
# or pip3 install .[pycodegen] if needed

命令

Schema salad可以用作命令行工具或作为Python模块导入。

$ schema-salad-tool
usage: schema-salad-tool [-h] [--rdf-serializer RDF_SERIALIZER] [--skip-schemas]
                      [--strict-foreign-properties] [--print-jsonld-context]
                      [--print-rdfs] [--print-avro] [--print-rdf] [--print-pre]
                      [--print-index] [--print-metadata] [--print-inheritance-dot]
                      [--print-fieldrefs-dot] [--codegen language] [--codegen-target CODEGEN_TARGET]
                      [--codegen-examples directory] [--codegen-package dotted.package]
                      [--codegen-copyright copyright_string] [--print-oneline]
                      [--print-doc] [--strict | --non-strict]
                      [--verbose | --quiet | --debug] [--only ONLY] [--redirect REDIRECT]
                      [--brand BRAND] [--brandlink BRANDLINK] [--brandstyle BRANDSTYLE]
                      [--brandinverse] [--primtype PRIMTYPE] [--version]
                      [schema] [document]

$ python
>>> import schema_salad

验证模式

$ schema-salad-tool myschema.yml

使用模式验证文档

$ schema-salad-tool myschema.yml mydocument.yml

生成HTML文档

$ schema-salad-tool --print-doc myschema.yml > myschema.html
$ # or
$ schema-salad-doc myschema.yml > myschema.html

获取JSON-LD上下文

$ schema-salad-tool --print-jsonld-context myschema.yml mydocument.yml

将文档转换为JSON-LD

$ schema-salad-tool --print-pre myschema.yml mydocument.yml > mydocument.jsonld

为描述模式中文档的Python类生成加载/生成代码（需要额外组件[cite][pycodegen]）

$ schema-salad-tool --codegen=python myschema.yml > myschema.py

将类之间的继承关系显示为graphviz 'dot'文件，并渲染为SVG

$ schema-salad-tool --print-inheritance-dot myschema.yml | dot -Tsvg > myschema.svg

代码生成示例

下表中的示例有助于了解如何在不同语言中加载和/或创建/编辑/保存对象，以使用schema-salad-tool –codegen的输出。

以下示例使用CWL v1.2模式

语言

仓库

序列化示例 | 反序列化示例

Python

https://github.com/common-workflow-language/cwl-utils/

create_cwl_from_objects.py

load_document()

Java

https://github.com/common-workflow-language/cwljava/

（尚未实现）

PackedWorkflowClassTest.java

TypeScript

https://github.com/common-workflow-lab/cwl-ts-auto

使用TypeScript创建、编辑和保存CWL文档

使用TypeScript加载CWL文档

.Net

https://github.com/common-workflow-lab/CWLDotNet

使用.NET创建、编辑和保存CWL文档

使用.NET加载CWL文档

C++

https://github.com/common-workflow-lab/cwl-cpp-auto

cwl_output_example.cpp

cwl_input_example.cpp

D

https://github.com/common-workflow-lab/cwl-d-auto

如何使用

如何使用

以下示例是针对Galaxy Workflow Format 2模式的

语言

路径

Python

https://github.com/galaxyproject/gxformat2/blob/master/gxformat2/schema/v19_09.py

Java

https://github.com/galaxyproject/gxformat2/tree/master/java

TypeScript

https://github.com/galaxyproject/gxformat2/tree/master/typescript

快速入门

假设您有一个可以包含按重量或按计数测量的项目“篮子”记录。以下是一个示例

basket:
  - product: bananas
    price: 0.39
    per: pound
    weight: 1
  - product: cucumbers
    price: 0.79
    per: item
    count: 3

我们希望验证所有预期的字段都存在，测量已知，以及“计数”不能是分数值。以下是一个执行此操作的示例模式

- name: Product
  doc: |
    The base type for a product.  This is an abstract type, so it
    can't be used directly, but can be used to define other types.
  type: record
  abstract: true
  fields:
    product: string
    price: float

- name: ByWeight
  doc: |
    A product, sold by weight.  Products may be sold by pound or by
    kilogram.  Weights may be fractional.
  type: record
  extends: Product
  fields:
    per:
      type:
        type: enum
        symbols:
          - pound
          - kilogram
      jsonldPredicate: '#per'
    weight: float

- name: ByCount
  doc: |
    A product, sold by count.  The count must be a integer value.
  type: record
  extends: Product
  fields:
    per:
      type:
        type: enum
        symbols:
          - item
      jsonldPredicate: '#per'
    count: int

- name: Basket
  doc: |
    A basket of products.  The 'documentRoot' field indicates it is a
    valid starting point for a document.  The 'basket' field will
    validate subtypes of 'Product' (ByWeight and ByCount).
  type: record
  documentRoot: true
  fields:
    basket:
      type:
        type: array
        items: Product

您可以在schema_salad/tests/basket_schema.yml和schema_salad/tests/basket.yml中检查模式和文档

$ schema-salad-tool basket_schema.yml basket.yml
Document `basket.yml` is valid

文档

请参阅规范和元模式（沙拉模式用于自身）。有关Schema Salad的示例应用，请参阅通用工作流语言。

理由

JSON数据模型是表示结构化数据的一种流行方式。它吸引人是因为其相对简单，并且与许多编程语言的标准化类型自然兼容。然而，这种简单性是以基本JSON缺乏表达性特征为代价的，这些特征对于处理复杂数据结构和文档格式（如模式、对象引用和命名空间）非常有用。

JSON-LD是一种W3C标准，它通过“上下文”提供了一种将JSON文档解释为链接数据的方法。JSON-LD提供了一种强大的解决方案，用于在基于标准Web URI的JSON中表示对象引用和命名空间，但它本身并不是一种模式语言。没有提供良好定义结构的模式，很难将任意的JSON-LD文档作为习惯性的JSON进行处理，因为存在许多逻辑上等效但结构上不同的数据表达方式。

存在几种用于描述和验证JSON数据的模式语言，例如JSON Schema和Apache Avro数据序列化系统，但它们都不理解链接数据。因此，为了充分利用JSON-LD来构建下一代链接数据应用，必须维护单独的JSON模式、JSON-LD上下文、RDF模式和人类文档，尽管这些文档内容存在显著重叠，并且显然需要保持这些文档同步。

Schema Salad旨在填补这一空白。它提供了一种模式语言和处理规则，用于描述结构化JSON内容，允许URI解析和严格的文档验证。该模式语言通过描述内容的链接数据解释来支持链接数据，能够生成JSON-LD上下文和RDF模式，并通过应用JSON-LD上下文生成RDF三元组。该模式语言还提供了对内联文档的强大支持。

项目详情

验证详情

这些详情已经由PyPI 验证
维护者
Avatar for mcrusoe from gravatar.com mcrusoe Avatar for mvdbeek from gravatar.com mvdbeek Avatar for rwn from gravatar.com rwn Avatar for tetron from gravatar.com tetron

未验证详情

这些详情尚未由PyPI验证
项目链接
元数据
分类器

发布历史 发布通知 | RSS源

本版本

8.7.20240905150001

8.7.20240820070935

8.7.20240818162459

8.7.20240718183047

8.6.20240710082410

8.5.20240503091721

8.5.20240410123758

8.5.20240311110950

8.5.20240102191335

8.5.20231201181309

8.4.20231117150958

8.4.20231113094720

8.4.20231024070348

8.4.20230927144413

8.4.20230808163024

8.4.20230606143604

8.4.20230601112322

8.4.20230511084951

8.4.20230426093816

8.4.20230213094415

8.4.20230201194352

8.4.20230128170514

8.4.20230127112827

8.3.20230109181936

8.3.20221209165047

8.3.20221115203138

8.3.20221028160159

8.3.20221016151607

8.3.20220916115321

8.3.20220913105718

8.3.20220909144501

8.3.20220831150015

8.3.20220825133457

8.3.20220825123345

8.3.20220825114525

8.3.20220801194920

2022年7月21日 撤回

撤回此版本的原因

回归 https://github.com/common-workflow-language/schema_salad/issues/575

8.3.20220717184004

8.3.20220717021618

8.3.20220626185350

8.3.20220626094427

8.3.20220525163636

8.3.20220518163624

8.3 撤回

撤回此版本的原因

无效的发布标签

8.2.20220204150214

8.2.20220103095339

8.2.20211222191353

8.2.20211116214159

8.2.20211104054942

8.2.20211103155537

8.2.20211029004247

8.2.20211020114435

8.2.20211015115235

8.2.20211014150008

8.2.20211014142459

8.2.20210918131710

8.2.20210914115719

8.2.20210902094147

8.1.20210721123742

8.1.20210716111910

8.1.20210627200047

8.0.20210624154013

8.0.20210624101613

8.0.20210624094941

7.1.20210611090601

7.1.20210518142926

7.1.20210316164414

7.1.20210309094900

7.0.20210124093443

7.0.20201119201711

7.0.20200811075006

7.0.20200612160654

6.0.20200601095207

6.0.20200523200656

5.0.20200416112825

5.0.20200302192450

5.0.20200220195218

5.0.20200126033820

5.0.20200122085940

5.0.20200105154004

4.5.20191229160203

4.5.20191204060541

4.5.20191203162929

4.5.20191023134839

4.5.20191017101802

4.5.20190906201758

4.5.20190815125611

4.5.20190729164411

4.5.20190621200723

4.4.20190620173027

4.3.20190604170443

4.3.20190603183756

4.2.20190417121603

4.1.20190305210046

4.1.20190227145202

4.1.20190221213919

4.0.20190130225346

3.1.20190125161400

3.0.20181206233650

3.0.20181129082112

2.7.20181126142424

2.7.20181116024232

2.7.20181017120439

2.7.20181012180226

2.7.20180905124720

2.7.20180809223002

2.7.20180731120629

2.7.20180724081820

2.7.20180719125426

2.7.20180717111941

2.7.20180611133406

2.7.20180514132321

2.7.20180514111532

2.7.20180501211602

2.7.20180322174040

2.7.20180302220026

2.6.20180214144209

2.6.20171201034858

2.6.20171116190026

2.6.20171102064032

2.6.20171101113912

2.6.20171031091636

2.6.20170927145003

2.6.20170806163416

2.6.20170712194300

2.6.20170630075932

2.6.20170628130600

2.5.20170623152720

2.5.20170428142041

2.5.20170328195758

2.5.20170327140858

2.5.1.20170628121527

2.4.20170308171942

2.3.20170302225134

2.3.20170302150835

2.2.20170222151604

2.2.20170216125639

2.2.20170208112505

2.2.20170126160727

2.2.20170119151016

2.2.20170111180227

2.1.20161227191302

2.1.20161223160831

2.1.20161221160224

2.1.20161216210732

2.0.20161122040508

1.21.20161215163938

1.21.20161206204028

1.21.20161206181442

1.21.20161202201331

1.20.20161122192122

1.18.20161005190847

1.18.20160930145650

1.18.20160907135919

1.17.20160820171034

1.17.20160820165726

1.16.20160819133325

1.16.20160810195039

1.15.20160810152809

1.14.20160708181155

1.14.20160707164023

1.13.20160702001514

1.13.20160630144631

1.12.20160610104117

1.12.20160610092802

1.11.20160524152859

1.11.20160506154702

1.10.20160505185111

1.10.20160505184637

1.9.20160421133216

1.7.20160316203940

1.7.20160316150109

1.7.20160316145902

1.7.20160315232142

1.7

1.6.20160202222448

1.5.20160126213649

1.5.20160126190004

1.5.20160126150511

1.4.20160108200836

1.4.20160108152457

1.3.20160108151816

1.2.20151210153655

1.1.1

1.1.0

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0

下载文件

下载适合您平台的文件。如果您不确定该选择哪个，请了解有关安装包的更多信息。

源代码分发

schema_salad-8.7.20240905150001.tar.gz (593.3 kB 查看哈希值)

上传时间 源代码

构建的分发

schema_salad-8.7.20240905150001-py3-none-any.whl (636.1 kB 查看哈希值)

上传时间 Python 3

schema_salad-8.7.20240905150001-cp312-cp312-musllinux_1_2_x86_64.whl (1.5 MB 查看哈希值)

上传时间 CPython 3.12 musllinux: musl 1.2+ x86-64

schema_salad-8.7.20240905150001-cp312-cp312-musllinux_1_2_aarch64.whl (1.5 MB 查看哈希值)

上传时间 CPython 3.12 musllinux: musl 1.2+ ARM64

schema_salad-8.7.20240905150001-cp312-cp312-musllinux_1_1_x86_64.whl (1.6 MB 查看哈希值)

上传于 CPython 3.12 musllinux: musl 1.1+ x86-64

schema_salad-8.7.20240905150001-cp312-cp312-musllinux_1_1_aarch64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.12 musllinux: musl 1.1+ ARM64

schema_salad-8.7.20240905150001-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.12 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.28+ x86-64

schema_salad-8.7.20240905150001-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.manylinux_2_28_aarch64.whl (1.4 MB 查看哈希值)

上传于 CPython 3.12 manylinux: glibc 2.17+ ARM64 manylinux: glibc 2.28+ ARM64

schema_salad-8.7.20240905150001-cp312-cp312-macosx_11_0_arm64.whl (1.3 MB 查看哈希值)

上传于 CPython 3.12 macOS 11.0+ ARM64

schema_salad-8.7.20240905150001-cp312-cp312-macosx_10_9_x86_64.whl (1.4 MB 查看哈希值)

上传于 CPython 3.12 macOS 10.9+ x86-64

schema_salad-8.7.20240905150001-cp311-cp311-musllinux_1_2_x86_64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.11 musllinux: musl 1.2+ x86-64

schema_salad-8.7.20240905150001-cp311-cp311-musllinux_1_2_aarch64.whl (1.4 MB 查看哈希值)

上传于 CPython 3.11 musllinux: musl 1.2+ ARM64

schema_salad-8.7.20240905150001-cp311-cp311-musllinux_1_1_x86_64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.11 musllinux: musl 1.1+ x86-64

schema_salad-8.7.20240905150001-cp311-cp311-musllinux_1_1_aarch64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.11 musllinux: musl 1.1+ ARM64

schema_salad-8.7.20240905150001-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.11 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.28+ x86-64

schema_salad-8.7.20240905150001-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.manylinux_2_28_aarch64.whl (1.4 MB 查看哈希值)

上传于 CPython 3.11 manylinux: glibc 2.17+ ARM64 manylinux: glibc 2.28+ ARM64

schema_salad-8.7.20240905150001-cp311-cp311-macosx_11_0_arm64.whl (1.3 MB 查看哈希值)

上传于 CPython 3.11 macOS 11.0+ ARM64

schema_salad-8.7.20240905150001-cp311-cp311-macosx_10_9_x86_64.whl (1.4 MB 查看哈希值)

上传于 CPython 3.11 macOS 10.9+ x86-64

schema_salad-8.7.20240905150001-cp310-cp310-musllinux_1_2_x86_64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.10 musllinux: musl 1.2+ x86-64

schema_salad-8.7.20240905150001-cp310-cp310-musllinux_1_2_aarch64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.10 musllinux: musl 1.2+ ARM64

schema_salad-8.7.20240905150001-cp310-cp310-musllinux_1_1_x86_64.whl (1.6 MB 查看哈希值)

上传于 CPython 3.10 musllinux: musl 1.1+ x86-64

schema_salad-8.7.20240905150001-cp310-cp310-musllinux_1_1_aarch64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.10 musllinux: musl 1.1+ ARM64

schema_salad-8.7.20240905150001-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.10 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.28+ x86-64

schema_salad-8.7.20240905150001-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.manylinux_2_28_aarch64.whl (1.4 MB 查看哈希值)

上传于 CPython 3.10 manylinux: glibc 2.17+ ARM64 manylinux: glibc 2.28+ ARM64

schema_salad-8.7.20240905150001-cp310-cp310-macosx_11_0_arm64.whl (1.3 MB 查看哈希值)

上传于 CPython 3.10 macOS 11.0+ ARM64

schema_salad-8.7.20240905150001-cp310-cp310-macosx_10_9_x86_64.whl (1.4 MB 查看哈希值)

上传于 CPython 3.10 macOS 10.9+ x86-64

schema_salad-8.7.20240905150001-cp39-cp39-musllinux_1_2_x86_64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.9 musllinux: musl 1.2+ x86-64

schema_salad-8.7.20240905150001-cp39-cp39-musllinux_1_2_aarch64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.9 musllinux: musl 1.2+ ARM64

schema_salad-8.7.20240905150001-cp39-cp39-musllinux_1_1_x86_64.whl (1.6 MB 查看哈希值)

上传于 CPython 3.9 musllinux: musl 1.1+ x86-64

schema_salad-8.7.20240905150001-cp39-cp39-musllinux_1_1_aarch64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.9 musllinux: musl 1.1+ ARM64

schema_salad-8.7.20240905150001-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.9 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.28+ x86-64

schema_salad-8.7.20240905150001-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.manylinux_2_28_aarch64.whl (1.4 MB 查看哈希值)

上传于 CPython 3.9 manylinux: glibc 2.17+ ARM64 manylinux: glibc 2.28+ ARM64

schema_salad-8.7.20240905150001-cp39-cp39-macosx_11_0_arm64.whl (1.3 MB 查看哈希值)

上传于 CPython 3.9 macOS 11.0+ ARM64

schema_salad-8.7.20240905150001-cp39-cp39-macosx_10_9_x86_64.whl (1.4 MB 查看哈希值)

上传于 CPython 3.9 macOS 10.9+ x86-64

schema_salad-8.7.20240905150001-cp38-cp38-musllinux_1_2_x86_64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.8 musllinux: musl 1.2+ x86-64

schema_salad-8.7.20240905150001-cp38-cp38-musllinux_1_2_aarch64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.8 musllinux: musl 1.2+ ARM64

schema_salad-8.7.20240905150001-cp38-cp38-musllinux_1_1_x86_64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.8 musllinux: musl 1.1+ x86-64

schema_salad-8.7.20240905150001-cp38-cp38-musllinux_1_1_aarch64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.8 musllinux: musl 1.1+ ARM64

schema_salad-8.7.20240905150001-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl (1.5 MB 查看哈希值)

上传于 CPython 3.8 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.28+ x86-64

schema_salad-8.7.20240905150001-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.manylinux_2_28_aarch64.whl (1.4 MB 查看哈希值)

上传于 CPython 3.8 manylinux: glibc 2.17+ ARM64 manylinux: glibc 2.28+ ARM64

schema_salad-8.7.20240905150001-cp38-cp38-macosx_11_0_arm64.whl (1.3 MB 查看哈希值)

上传于 CPython 3.8 macOS 11.0+ ARM64

schema_salad-8.7.20240905150001-cp38-cp38-macosx_10_9_x86_64.whl (1.4 MB 查看哈希值)

上传于 CPython 3.8 macOS 10.9+ x86-64

由以下机构支持