1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
# -*- coding: utf-8 -*-
"""The artifact definition."""
from __future__ import unicode_literals
from artifacts import errors
from artifacts import registry
class ArtifactDefinition(object):
"""Artifact definition interface.
Attributes:
conditions (list[str]): conditions.
description (str): description.
name (str): name that uniquely identifiers the artifact definition.
labels (list[str]): labels.
provides (list[str]): hints to what information the artifact definition
provides.
sources (list[str]): sources.
supported_os (list[str]): supported operating systems.
urls (list[str]): URLs with more information about the artifact definition.
"""
def __init__(self, name, description=None):
"""Initializes an artifact definition.
Args:
name (str): name that uniquely identifiers the artifact definition.
description (Optional[str]): description of the artifact definition.
"""
super(ArtifactDefinition, self).__init__()
self.conditions = []
self.description = description
self.name = name
self.labels = []
self.provides = []
self.sources = []
self.supported_os = []
self.urls = []
def AppendSource(self, type_indicator, attributes):
"""Appends a source.
If you want to implement your own source type you should create a subclass
in source_type.py and change the AppendSource method to handle the new
subclass. This function raises FormatError if an unsupported source type
indicator is encountered.
Args:
type_indicator (str): source type indicator.
attributes (dict[str, object]): source attributes.
Returns:
SourceType: a source type.
Raises:
FormatError: if the type indicator is not set or unsupported,
or if required attributes are missing.
"""
if not type_indicator:
raise errors.FormatError('Missing type indicator.')
try:
source_object = registry.ArtifactDefinitionsRegistry.CreateSourceType(
type_indicator, attributes)
except (AttributeError, TypeError) as exception:
raise errors.FormatError((
'Unable to create source type: {0:s} for artifact definition: {1:s} '
'with error: {2!s}').format(type_indicator, self.name, exception))
self.sources.append(source_object)
return source_object
def AsDict(self):
"""Represents an artifact as a dictionary.
Returns:
dict[str, object]: artifact attributes.
"""
sources = []
for source in self.sources:
source_definition = {
'type': source.type_indicator,
'attributes': source.AsDict()
}
if source.supported_os:
source_definition['supported_os'] = source.supported_os
if source.conditions:
source_definition['conditions'] = source.conditions
if source.returned_types:
source_definition['returned_types'] = source.returned_types
sources.append(source_definition)
artifact_definition = {
'name': self.name,
'doc': self.description,
'sources': sources,
}
if self.labels:
artifact_definition['labels'] = self.labels
if self.supported_os:
artifact_definition['supported_os'] = self.supported_os
if self.provides:
artifact_definition['provides'] = self.provides
if self.conditions:
artifact_definition['conditions'] = self.conditions
if self.urls:
artifact_definition['urls'] = self.urls
return artifact_definition
|
