# -*- coding: utf-8 -*-
#
# Copyright 2017-2022 - Swiss Data Science Center (SDSC)
# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
# Eidgenössische Technische Hochschule Zürich (ETHZ).
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Datasets JSON-LD schemes."""
from marshmallow import EXCLUDE
from renku.command.schema.agent import PersonSchema
from renku.command.schema.annotation import AnnotationSchema
from renku.command.schema.calamus import DateTimeList, JsonLDSchema, Nested, Uri, fields, oa, prov, renku, schema
from renku.command.schema.entity import CollectionSchema, EntitySchema
from renku.domain_model.dataset import Dataset, DatasetFile, DatasetTag, ImageObject, Language, RemoteEntity, Url
[docs]def dump_dataset_as_jsonld(dataset: Dataset) -> dict:
"""Return JSON-LD representation of a dataset.
Args:
dataset(Dataset): The dataset to convert.
Returns:
dict: JSON-LD data of dataset.
"""
return DatasetSchema(flattened=True).dump(dataset)
[docs]class UrlSchema(JsonLDSchema):
"""Url schema."""
id = fields.Id(load_default=None)
url = Uri(schema.url, load_default=None)
[docs]class LanguageSchema(JsonLDSchema):
"""Language schema."""
alternate_name = fields.String(schema.alternateName)
id = fields.Id(load_default=None)
name = fields.String(schema.name)
[docs]class ImageObjectSchema(JsonLDSchema):
"""ImageObject schema."""
content_url = fields.String(schema.contentUrl)
id = fields.Id(load_default=None)
position = fields.Integer(schema.position)
[docs]class RemoteEntitySchema(JsonLDSchema):
"""RemoteEntity schema."""
checksum = fields.String(renku.checksum)
id = fields.Id()
path = fields.String(prov.atLocation)
url = fields.String(schema.url)
[docs]class DatasetFileSchema(JsonLDSchema):
"""DatasetFile schema."""
based_on = Nested(schema.isBasedOn, RemoteEntitySchema, load_default=None)
date_added = DateTimeList(schema.dateCreated, format="iso", extra_formats=("%Y-%m-%d",))
date_removed = fields.DateTime(prov.invalidatedAtTime, load_default=None, format="iso")
entity = Nested(prov.entity, [EntitySchema, CollectionSchema])
id = fields.Id()
is_external = fields.Boolean(renku.external, load_default=False)
source = fields.String(renku.source, load_default=None)
[docs]class DatasetSchema(JsonLDSchema):
"""Dataset schema."""
annotations = Nested(oa.hasTarget, AnnotationSchema, reverse=True, many=True)
creators = Nested(schema.creator, PersonSchema, many=True)
date_created = fields.DateTime(schema.dateCreated, load_default=None, format="iso", extra_formats=("%Y-%m-%d",))
date_removed = fields.DateTime(prov.invalidatedAtTime, load_default=None, format="iso")
date_published = fields.DateTime(
schema.datePublished, load_default=None, format="%Y-%m-%d", extra_formats=("iso", "%Y-%m-%dT%H:%M:%S")
)
derived_from = Nested(prov.wasDerivedFrom, UrlSchema, load_default=None)
description = fields.String(schema.description, load_default=None)
dataset_files = Nested(schema.hasPart, DatasetFileSchema, many=True)
id = fields.Id(load_default=None)
identifier = fields.String(schema.identifier)
images = fields.Nested(schema.image, ImageObjectSchema, load_default=None, many=True)
in_language = Nested(schema.inLanguage, LanguageSchema, load_default=None)
keywords = fields.List(schema.keywords, fields.String(), load_default=None)
license = Uri(schema.license, load_default=None)
name = fields.String(renku.slug)
initial_identifier = fields.String(renku.originalIdentifier)
project_id = fields.IRI(renku.hasDataset, reverse=True)
same_as = Nested(schema.sameAs, UrlSchema, load_default=None)
title = fields.String(schema.name)
version = fields.String(schema.version, load_default=None)