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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
#
# Copyright (C) 2019 Codethink Limited
# Copyright (C) 2019 Bloomberg Finance LP
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.
#
# Authors:
# Tom Pollard <tom.pollard@codethink.co.uk>
# Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
"""
Artifact
=========
Implementation of the Artifact class which aims to 'abstract' direct
artifact composite interaction away from Element class
"""
from .types import _KeyStrength
# An Artifact class to abtract artifact operations
# from the Element class
#
# Args:
# element (Element): The Element object
# context (Context): The BuildStream context
#
class Artifact():
def __init__(self, element, context):
self._element = element
self._context = context
self._artifacts = context.artifactcache
# get_files():
#
# Get a virtual directory for the artifact files content
#
# Args:
# key (str): The key for the artifact to extract,
# or None for the default key
#
# Returns:
# (Directory): The virtual directory object
# (str): The chosen key
#
def get_files(self, key=None):
subdir = "files"
return self._get_subdirectory(subdir, key)
# get_buildtree():
#
# Get a virtual directory for the artifact buildtree content
#
# Args:
# key (str): The key for the artifact to extract,
# or None for the default key
#
# Returns:
# (Directory): The virtual directory object
# (str): The chosen key
#
def get_buildtree(self, key=None):
subdir = "buildtree"
return self._get_subdirectory(subdir, key)
# get_extract_key():
#
# Get the key used to extract the artifact
#
# Returns:
# (str): The key
#
def get_extract_key(self):
element = self._element
context = self._context
# Use weak cache key, if context allows use of weak cache keys
key_strength = _KeyStrength.STRONG
key = element._get_cache_key(strength=key_strength)
if not context.get_strict() and not key:
key = element._get_cache_key(strength=_KeyStrength.WEAK)
return key
# _get_directory():
#
# Get a virtual directory for the artifact contents
#
# Args:
# key (str): The key for the artifact to extract,
# or None for the default key
#
# Returns:
# (Directory): The virtual directory object
# (str): The chosen key
#
def _get_directory(self, key=None):
element = self._element
if key is None:
key = self.get_extract_key()
return (self._artifacts.get_artifact_directory(element, key), key)
# _get_subdirectory():
#
# Get a virtual directory for the artifact subdir contents
#
# Args:
# subdir (str): The specific artifact subdir
# key (str): The key for the artifact to extract,
# or None for the default key
#
# Returns:
# (Directory): The virtual subdirectory object
# (str): The chosen key
#
def _get_subdirectory(self, subdir, key=None):
artifact_vdir, key = self._get_directory(key)
sub_vdir = artifact_vdir.descend(subdir)
return (sub_vdir, key)
|
