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 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
|
"""
Defines base Redmine resource class and it's infrastructure.
"""
from __future__ import unicode_literals
from datetime import date, datetime
from .. import managers, utilities, exceptions
registry = {}
class Registrar(type):
"""
A resource that implements this metaclass, i.e. all resources that inherit from BaseResource,
will be added to a resource registry to be managed by it's ResourceManager. Resource classes
which name starts with Base are considered base classes and not added to the registry.
"""
def __new__(mcs, name, bases, attrs):
cls = super(Registrar, mcs).__new__(mcs, name, bases, attrs)
if name.startswith('Base'): # base classes shouldn't be added to the registry
return cls
if name not in registry: # a name maybe already added to registry by other classes
registry[name] = {}
for attr in ('_attach_includes', '_attach_relations'):
class_attr_name = attr[7:]
registry_attr_name = attr[1:]
if registry_attr_name in registry[name]:
mcs.update_cls_attr(cls, class_attr_name, registry[name][registry_attr_name].keys())
mcs.update_cls_attr(cls, '_resource_set_map', registry[name][registry_attr_name])
if not isinstance(getattr(cls, attr), dict):
continue
for resource_name, value in getattr(cls, attr).items():
if resource_name not in registry:
registry[resource_name] = {}
if registry_attr_name not in registry[resource_name]:
registry[resource_name][registry_attr_name] = {}
registry[resource_name][registry_attr_name][value] = name
if 'class' in registry[resource_name]:
mcs.update_cls_attr(registry[resource_name]['class'], class_attr_name, [value])
mcs.update_cls_attr(registry[resource_name]['class'], '_resource_set_map', {value: name})
return registry[name].setdefault('class', cls)
@staticmethod
def update_cls_attr(cls, name, value):
"""
Updates class attribute's value by first copying the current value and then updating it with
new value. We need that to be sure that each resource class has its own copy of the value.
:param any cls: (required). Resource class.
:param string name: (required). Attribute name.
:param any value: (optional). Attribute value.
"""
attr = getattr(cls, name, None)
if isinstance(attr, list):
value = list(attr) + list(value)
elif isinstance(attr, dict):
value = dict(attr, **value)
else:
return
setattr(cls, name, value)
@utilities.fix_unicode
class BaseResource(utilities.with_metaclass(Registrar)):
"""
Implementation of Redmine resource.
"""
internal_id_key = 'id'
redmine_version = None
requirements = []
container_all = None
container_one = None
container_filter = None
container_create = None
container_update = None
query_all_export = None
query_one_export = None
query_all = None
query_one = None
query_filter = None
query_create = None
query_update = None
query_delete = None
search_hints = None
http_method_create = 'post'
http_method_update = 'put'
http_method_delete = 'delete'
manager_class = managers.ResourceManager
_repr = [['id', 'name']]
_includes = []
_relations = []
_relations_name = None
_unconvertible = ['name', 'description']
_members = ['manager']
_create_readonly = ['id', 'created_on', 'updated_on', 'author', 'user', 'project', 'issue']
_update_readonly = _create_readonly[:]
_attach_includes = None
_attach_relations = None
_resource_map = {} # Resources that should become a Resource object
_resource_set_map = {} # Resources that should become a ResourceSet object
_single_attr_id_map = {} # Resource attributes that should set another resource id to its value
_multiple_attr_id_map = {} # Resource attributes should set another resource ids to their value
__length_hint__ = None # fixes Python 2.6 list() call on resource object
def __init__(self, manager, attributes):
"""
:param managers.ResourceManager manager: (required). Manager object.
:param dict attributes: (required). Resource attributes.
"""
relations_includes = self._relations + self._includes
self.manager = manager
self._create_readonly += relations_includes
self._update_readonly += relations_includes
self._decoded_attrs = dict(dict.fromkeys(relations_includes), **attributes)
self._encoded_attrs = {}
self._changes = {}
if self._relations_name is None:
self._relations_name = self.__class__.__name__.lower()
def __getitem__(self, item):
"""
Provides a dictionary-like access to Resource attributes.
"""
return getattr(self, item)
def __setitem__(self, item, value):
"""
Provides a dictionary-like setter for Resource attributes.
"""
return setattr(self, item, value)
def __getattr__(self, attr):
"""
Returns the requested attribute and makes a conversion if needed.
"""
if attr.startswith('_'):
raise AttributeError
# If this isn't the first time attribute access we can return it from cache
encoded = self._encoded_attrs.get(attr)
if encoded is not None:
return encoded
# Else this is the first time access and we need to encode the attribute
decoded = self._decoded_attrs.get(attr)
if decoded is not None:
attr, encoded = self.encode(attr, decoded, self.manager)
elif attr in self._relations:
filters = {'{0}_id'.format(self._relations_name): self.internal_id}
encoded = self.manager.new_manager(self._resource_set_map[attr]).filter(**filters)
elif attr in self._includes:
attr, encoded = self.encode(attr, self.refresh(itself=False, include=attr).raw()[attr] or [], self.manager)
# In case of successful encoding we put it to a cache and return
if encoded is not None:
self._encoded_attrs[attr] = encoded
return encoded
# Else we return the defaults if this is a new item or throw an exception
if self.is_new():
return 0 if attr in ('id', 'version') else ''
raise_attr_exception = self.manager.redmine.raise_attr_exception
if isinstance(raise_attr_exception, bool) and raise_attr_exception:
raise exceptions.ResourceAttrError
elif isinstance(raise_attr_exception, (list, tuple)) and self.__class__.__name__ in raise_attr_exception:
raise exceptions.ResourceAttrError
return None
def __setattr__(self, attr, value):
"""
Sets the requested attribute.
"""
if attr in self._members or attr.startswith('_'):
return super(BaseResource, self).__setattr__(attr, value)
elif attr in self._create_readonly and self.is_new():
raise exceptions.ReadonlyAttrError
elif attr in self._update_readonly and not self.is_new():
raise exceptions.ReadonlyAttrError
elif attr == 'custom_fields':
try:
new = dict((field['id'], self.bulk_decode(field, self.manager)) for field in value)
except (TypeError, KeyError):
raise exceptions.CustomFieldValueError
for i, field in enumerate(self._decoded_attrs.setdefault('custom_fields', [])):
if field['id'] in new:
self._decoded_attrs['custom_fields'][i] = new.pop(field['id'])
self._decoded_attrs['custom_fields'].extend(list(new.values()))
self._changes[attr] = self._decoded_attrs['custom_fields']
else:
decoded_attr, decoded_value = self.decode(attr, value, self.manager)
self._changes[decoded_attr] = decoded_value
self._decoded_attrs[attr] = decoded_value
if attr in self._single_attr_id_map:
self._decoded_attrs[self._single_attr_id_map[attr]] = {'id': decoded_value}
elif attr in self._multiple_attr_id_map:
self._decoded_attrs[self._multiple_attr_id_map[attr]] = [{'id': attr_id} for attr_id in decoded_value]
# When we set an attribute we put it's decoded value only to a _decoded_attrs
# dict because it may never be accessed again, that is why we don't waste time
# on the encode process but only clean the cache, and in case if it will be
# accessed, the encoding process will be run automatically by __getattr__
self._encoded_attrs.pop(attr, None)
@classmethod
def decode(cls, attr, value, manager):
"""
Decodes a single attr, value pair from Python representation to the needed Redmine representation.
:param string attr: (required). Attribute name.
:param any value: (required). Attribute value.
:param managers.ResourceManager manager: (required). Manager object.
"""
type_ = type(value)
if type_ is date:
return attr, value.strftime(manager.redmine.date_format)
elif type_ is datetime:
return attr, value.strftime(manager.redmine.datetime_format)
if attr == 'uploads':
for index, attachment in enumerate(value):
if 'token' not in attachment:
value[index]['token'] = manager.redmine.upload(attachment.pop('path', ''))['token']
return attr, value
elif attr == 'include' and isinstance(value, (list, tuple)):
return attr, ','.join(value)
return attr, value
@classmethod
def encode(cls, attr, value, manager):
"""
Encodes a single attr, value pair retrieved from Redmine to the needed Python representation.
:param string attr: (required). Attribute name.
:param any value: (required). Attribute value.
:param managers.ResourceManager manager: (required). Manager object.
"""
if attr in cls._unconvertible:
return attr, value
elif attr in cls._resource_map:
return attr, manager.new_manager(cls._resource_map[attr]).to_resource(value)
elif attr in cls._resource_set_map:
return attr, manager.new_manager(cls._resource_set_map[attr]).to_resource_set(value)
elif attr == 'parent':
return attr, manager.new_manager(cls.__name__).to_resource(value)
try:
try:
return attr, datetime.strptime(value, manager.redmine.datetime_format)
except (TypeError, ValueError):
return attr, datetime.strptime(value, manager.redmine.date_format).date()
except (TypeError, ValueError):
return attr, value
@classmethod
def bulk_decode(cls, attrs, manager):
"""
Decodes resource data from Python representation to the needed Redmine representation.
:param dict attrs: (required). Attributes in the form of key, value pairs.
:param managers.ResourceManager manager: (required). Manager object.
"""
return dict(cls.decode(attr, attrs[attr], manager) for attr in attrs)
@classmethod
def bulk_encode(cls, attrs, manager):
"""
Encodes resource data retrieved from Redmine to the needed Python representation.
:param dict attrs: (required). Attributes in the form of key, value pairs.
:param managers.ResourceManager manager: (required). Manager object.
"""
return dict(cls.encode(attr, attrs[attr], manager) for attr in attrs)
def raw(self):
"""
Returns resource data as it was received from Redmine.
"""
return self._decoded_attrs
def refresh(self, itself=True, **params):
"""
Reloads resource data from Redmine.
:param bool itself: (optional). Whether to refresh itself or return a new resource.
:param dict params: (optional). Parameters used for resource retrieval.
"""
resource = self.manager.get(self.internal_id, **params)
if itself:
self._encoded_attrs = {}
self._decoded_attrs = resource.raw()
else:
return resource
def pre_create(self):
"""
Tasks that should be done before creating the Resource.
"""
pass
def post_create(self):
"""
Tasks that should be done after creating the Resource.
"""
pass
def pre_update(self):
"""
Tasks that should be done before updating the Resource.
"""
pass
def post_update(self):
"""
Tasks that should be done after updating the Resource.
"""
pass
def pre_delete(self):
"""
Tasks that should be done before deleting the Resource.
"""
pass
def post_delete(self):
"""
Tasks that should be done after deleting the Resource.
"""
pass
def save(self, **attrs):
"""
Creates or updates a Resource.
:param dict attrs: (optional). Attrs to be set for a resource before create/update operation.
"""
for attr in attrs:
setattr(self, attr, attrs[attr])
if not self.is_new():
self.pre_update()
self.manager.update(self.internal_id, **self._changes)
self._decoded_attrs['updated_on'] = datetime.utcnow().strftime(self.manager.redmine.datetime_format)
self.post_update()
else:
self.pre_create()
self._decoded_attrs = self.manager.create(**self._changes).raw()
self.post_create()
self._changes = {}
return self
def delete(self, **params):
"""
Deletes Resource from Redmine.
:param dict params: (optional). Parameters used for resource deletion.
"""
self.pre_delete()
response = self.manager.delete(self.internal_id, **params)
self.post_delete()
return response
def export(self, fmt, savepath=None, filename=None):
"""
Exports Resource to requested format if Resource supports that.
:param string fmt: (required). Format to use for export, e.g. atom, csv, txt, pdf, html etc.
:param string savepath: (optional). Path where to save the file.
:param string filename: (optional). Name that will be used for the file.
"""
url = self.export_url(fmt)
if url is None:
raise exceptions.ExportNotSupported
try:
return self.manager.redmine.download(url, savepath, filename)
except exceptions.UnknownError as e:
if e.status_code == 406:
raise exceptions.ExportFormatNotSupportedError
raise e
def export_url(self, fmt):
"""
Returns export URL for the Resource according to format.
:param string fmt: (required). Export format, e.g. atom, csv, txt, pdf, html etc.
"""
if self.query_one_export is not None:
return self.manager.redmine.url + self.query_one_export.format(self.internal_id, format=fmt)
return None
@property
def url(self):
"""
Returns full URL to the Resource for humans if there is one.
"""
if self.query_one is not None:
return self.manager.redmine.url + self.query_one.format(self.internal_id)[:-5]
return None
@property
def internal_id(self):
"""
Returns identifier of the Resource for usage in internals of the library.
"""
return getattr(self, self.internal_id_key)
def is_new(self):
"""
Checks if Resource was just created and not yet saved to Redmine or it is an existing Resource.
"""
return False if 'id' in self._decoded_attrs or 'created_on' in self._decoded_attrs else True
def __dir__(self):
"""
Allows dir() to be called on a Resource object and shows Resource attributes.
"""
return list(self._decoded_attrs.keys())
def __iter__(self):
"""
Provides a way to iterate through Resource attributes and its values.
"""
return iter(self._decoded_attrs.items())
def __int__(self):
"""
Integer representation of a Resource object.
"""
return self.id
def _representation(self, target):
"""
Prepares values which should be used in either __str__ or __repr__ methods.
:param string target: (required). Target of representation.
"""
_str_, _repr_ = [], []
for attrs in self._repr:
for attr in reversed(attrs):
value = getattr(self, attr, None)
if value is None:
break
_repr_.insert(0, value)
if attr != 'id':
_str_.insert(0, value)
if len(_repr_) > 0:
break
if self.is_new() and len(_repr_) > 2:
_str_ = _str_[:-1]
_repr_ = _repr_[:-1]
return _str_ or [str(_repr_[0])] if target == 'str' else _repr_
def __str__(self):
"""
Informal representation of a Resource object.
"""
return ' '.join(self._representation('str'))
def __repr__(self):
"""
Official representation of a Resource object.
"""
values = self._representation('repr')
view = '<redminelib.resources.{0.__class__.__name__}'.format(self)
if isinstance(values[0], int):
view += ' #{0}'.format(values.pop(0))
if len(values) > 0:
view += ' "{0}"'.format(' '.join(values))
return view + '>'
|