Source code for renku.models.provenance.agents
# -*- coding: utf-8 -*-
#
# Copyright 2018 - 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 provenance agents."""
import re
from renku.models import _jsonld as jsonld
[docs]@jsonld.s(
type=[
'prov:Person',
'foaf:Person',
],
context={
'foaf': 'http://xmlns.com/foaf/0.1/',
'prov': 'http://purl.org/dc/terms/',
},
frozen=True,
slots=True,
)
class Person:
"""Represent a person."""
name = jsonld.ib(context='rdfs:label')
email = jsonld.ib(context={
'@type': '@id',
'@id': 'foaf:mbox',
})
_id = jsonld.ib(context='@id', init=False, kw_only=True)
[docs] @_id.default
def default_id(self):
"""Configure calculated ID."""
return self.email
[docs] @email.validator
def check_email(self, attribute, value):
"""Check that the email is valid."""
if not (isinstance(value, str) and re.match(r"[^@]+@[^@]+", value)):
raise ValueError('Email address "{0}" is invalid.'.format(value))
[docs] @classmethod
def from_commit(cls, commit):
"""Create an instance from a Git commit."""
return cls(
name=commit.author.name,
email='mailto:{0}'.format(commit.author.email),
)
[docs]@jsonld.s(
type=[
'prov:SoftwareAgent',
'wfprov:WorkflowEngine',
],
context={
'prov': 'http://purl.org/dc/terms/',
'wfprov': 'http://purl.org/wf4ever/wfprov#',
},
frozen=True,
slots=True,
)
class SoftwareAgent:
"""Represent a person."""
label = jsonld.ib(context='rdfs:label', kw_only=True)
was_started_by = jsonld.ib(
context='prov:wasStartedBy',
default=None,
kw_only=True,
)
_id = jsonld.ib(context='@id', kw_only=True)
[docs] @classmethod
def from_commit(cls, commit):
"""Create an instance from a Git commit."""
author = Person.from_commit(commit)
if commit.author != commit.committer:
return cls(
label=commit.committer.name,
id='mailto:{0}'.format(commit.committer.email),
was_started_by=author,
)
return author