Source code for renku.core.models.cwl.annotation
# -*- coding: utf-8 -*-
#
# Copyright 2018-2020- 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.
"""Represent an annotation for a workflow."""
import attr
from marshmallow import EXCLUDE
from renku.core.models.calamus import JsonLDSchema, dcterms, fields, oa
[docs]@attr.s(cmp=False,)
class Annotation:
"""Represents a custom annotation for a research object."""
_id = attr.ib(kw_only=True)
body = attr.ib(default=None, kw_only=True)
source = attr.ib(default=None, kw_only=True)
[docs] @classmethod
def from_jsonld(cls, data):
"""Create an instance from JSON-LD data."""
if isinstance(data, cls):
return data
if not isinstance(data, dict):
raise ValueError(data)
return AnnotationSchema().load(data)
[docs] def as_jsonld(self):
"""Create JSON-LD."""
return AnnotationSchema().dump(self)
[docs]class AnnotationSchema(JsonLDSchema):
"""Annotation schema."""
_id = fields.Id(init_name="id")
body = fields.Raw(oa.hasBody)
source = fields.Raw(dcterms.creator)