forked from Clemson-DPA/dpa-pipe
-
Notifications
You must be signed in to change notification settings - Fork 0
/
__init__.py
285 lines (223 loc) · 9.41 KB
/
__init__.py
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
"""Classes and functions related to DPA pipeline products."""
# -----------------------------------------------------------------------------
# Imports:
# -----------------------------------------------------------------------------
from dateutil import parser as date_parser
import re
from dpa.location import Location
from dpa.ptask import PTask
from dpa.ptask.area import PTaskArea
from dpa.ptask.spec import PTaskSpec
from dpa.restful import RestfulObject, RestfulObjectError
from dpa.restful.mixins import CreateMixin, GetMixin, ListMixin, UpdateMixin
from dpa.user import User
# -----------------------------------------------------------------------------
# Public Classes:
# -----------------------------------------------------------------------------
class Product(CreateMixin, GetMixin, ListMixin, UpdateMixin, RestfulObject):
"""Product API.
.category
.created
.creator
.description
.id
.name
.official_version_number
.ptask
.spec
"""
# -------------------------------------------------------------------------
# Class attributes:
# -------------------------------------------------------------------------
data_type = 'products'
# -------------------------------------------------------------------------
# Class Methods
# -------------------------------------------------------------------------
@classmethod
def category_names(cls):
if not hasattr(cls, '_category_names'):
from dpa.product.category import ProductCategory
cls._category_names = [c.name for c in ProductCategory.list()]
return cls._category_names
# -------------------------------------------------------------------------
@classmethod
def create(cls, ptask, name, category, description=None, creator=None):
# XXX validation
data = {
"ptask": ptask,
"name": name,
"category": category,
"description": description,
"creator": creator,
}
return super(Product, cls).create(data)
# -------------------------------------------------------------------------
@classmethod
def get(cls, spec, relative_to=None):
# convenience that allows calling code to not have to type check
# input that allows either spec or ptask
if isinstance(spec, Product):
return spec
# XXX PTaskSpec >> ContextSpec
# XXX PTaskArea >> ContextArea
# XXX PTaskEnv >> ContextEnv
if not isinstance(spec, PTaskSpec):
spec = PTaskSpec.get(spec, relative_to=relative_to)
return super(Product, cls).get(spec)
# -------------------------------------------------------------------------
# Special methods:
# -------------------------------------------------------------------------
def __eq__(self, other):
return self.spec == other.spec
# -------------------------------------------------------------------------
def __ne__(self, other):
return self.spec != other.spec
# -------------------------------------------------------------------------
def __repr__(self):
""":returns: Unique string represntation of the product."""
return self.__class__.__name__ + "('" + self.spec + "')"
# -------------------------------------------------------------------------
# Public methods:
# -------------------------------------------------------------------------
def update(self, description=None):
data = {
"description": description,
}
return super(Product, self).update(self.spec, data)
# -------------------------------------------------------------------------
def set_official(self, product_version):
return super(Product, self).update(self.spec,
{"official_version_number": product_version.number})
# -------------------------------------------------------------------------
def clear_official(self):
return super(Product, self).update(
self.spec, {"official_version_number": 0})
# -------------------------------------------------------------------------
def latest_published(self, deprecated=False):
"""Returns the latest published version of the product.
If deprecated is True, allow for the latest version to be deprecated.
If False, returns the latest non-deprecated version. Default is False.
"""
from dpa.product.version import ProductVersion
versions = ProductVersion.list(
product=self.spec,
published=True,
)
if not deprecated:
versions = [v for v in versions if not v.deprecated]
if len(versions) == 0:
return None
elif len(versions) == 1:
return versions[0]
else:
# sort by version number, return the last one
versions.sort(key=lambda v:v.number)
return versions[-1]
# -------------------------------------------------------------------------
def version(self, version_number):
from dpa.product.version import ProductVersion
try:
versions = ProductVersion.list(
product=self.spec,
number=int(version_number),
)
except:
return None
else:
if len(versions) != 1:
return None
else:
return versions[0]
# -------------------------------------------------------------------------
# Properties
# -------------------------------------------------------------------------
@property
def area(self):
""":returns: PTaskArea for this product."""
if not hasattr(self, '_area'):
self._area = PTaskArea(self.spec)
return self._area
# -------------------------------------------------------------------------
@property
def created(self):
""":returns: a datetime object for the creation of this product."""
return date_parser.parse(self._data.get('created'))
# -------------------------------------------------------------------------
@property
def creator(self):
""":returns: a User object for the creator of this product."""
return User.get(self.creator_username)
# -------------------------------------------------------------------------
@property
def creator_username(self):
""":returns: username str for the creator of this product."""
return self._data.get("creator")
# -------------------------------------------------------------------------
@property
def dependent_ptasks(self):
""":returns: list of ptasks with subs to a version of this product."""
from dpa.product.subscription import ProductSubscription
ptasks = []
# XXX db heavy. see about reducing number of queries here
subs = ProductSubscription.list(search=self.spec)
for sub in subs:
ptasks.append(sub.ptask_version.ptask)
return ptasks
# -------------------------------------------------------------------------
@property
def name_spec(self):
return PTaskSpec.SEPARATOR.join([self.name, self.category])
# -------------------------------------------------------------------------
@property
def official_version(self):
num = self.official_version_number
if num < 1:
return None
else:
return self.version(num)
# -------------------------------------------------------------------------
@property
def official_version_number_padded(self):
return str(self._data.get("official_version_number")).zfill(4)
# -------------------------------------------------------------------------
@property
def ptask(self):
return PTask.get(self.ptask_spec)
# -------------------------------------------------------------------------
@property
def ptask_spec(self):
return self._data.get('ptask')
# -------------------------------------------------------------------------
@property
def spec(self):
""":returns: PTaskSpec object representing this product's spec."""
return PTaskSpec.get(self._data.get('spec'))
# -------------------------------------------------------------------------
@property
def version_specs(self):
return self._data.get('versions')
# -------------------------------------------------------------------------
@property
def versions(self):
from dpa.product.version import ProductVersion
return ProductVersion.list(product=self.spec)
# -----------------------------------------------------------------------------
class ProductError(RestfulObjectError):
pass
Product.exception_class = ProductError
# -----------------------------------------------------------------------------
def validate_product_name(name):
# starts with a letter
if not re.match("^[a-zA-Z]", name):
raise ProductError("Product name must begin with a letter.")
# only contains letter, underscore, digits
if not re.match("^\w+$", name):
raise ProductError(
"Product name can only contain alpha numeric characters."
)
# must be at least 3 characters long
if len(name) < 3:
raise ProductError(
"Product name must be at least 3 characters long."
)
return name