from dateutil.parser import parse
import six
from .array import ArrayField
from .base import DirtyableList
[docs]class Annotation(six.text_type):
""" A special type of string that we'll use for storing annotations.
This is, for all intents and purposes, really just a string, but
it does allow us to store additional information if we have it -- in
this application: the annotation's entry date.
"""
def __new__(self, description, entry=None):
return six.text_type.__new__(self, description)
def __init__(self, description, entry=None):
self._entry = entry
super(Annotation, self).__init__()
@property
def entry(self):
if self._entry:
return parse(self._entry)
return self._entry
[docs]class AnnotationArrayField(ArrayField):
""" A special case of the ArrayField handling idiosyncrasies of Annotations
Taskwarrior will currently return to you a dictionary of values --
the annotation's date and description -- for each annotation, but
given that we cannot create annotations with a date, let's instead
return something that behaves like a string (but from which you can
extract an entry date if one exists).
"""
[docs] def deserialize(self, value):
if not value:
value = DirtyableList([])
elements = []
for annotation in value:
if isinstance(annotation, dict):
elements.append(
Annotation(
annotation['description'],
annotation['entry'],
)
)
else:
elements.append(Annotation(annotation))
return super(AnnotationArrayField, self).deserialize(elements)
[docs] def serialize(self, value):
if not value:
value = []
return super(AnnotationArrayField, self).serialize(
[six.text_type(entry) for entry in value]
)