Source code for renku.domain_model.provenance.annotation

# Copyright 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 copy
from uuid import uuid4


class Annotation:
    """Represents a custom annotation for a research object."""

    def __init__(self, *, id: str, body=None, source=None):
        self.id = id
        self.body = body
        self.source = source

    def copy(self):
        """Return a copy of this annotation."""
        return copy.deepcopy(self)

    @staticmethod
    def generate_id():
        """Generate an id for an annotation."""
        return f"/annotations/{uuid4().hex}"