tests: Explicitly mark unicode strings used for testing

[etc/taskwarrior.git] / tasklib / task.py

diff --git a/tasklib/task.py b/tasklib/task.py
index e8e5dfda4a796f789c7696f36c70534cb1bbcebc..79899ba6b38cd349216f2e362e9bd90e9217e335 100644 (file)
--- a/tasklib/task.py
+++ b/tasklib/task.py
@@ -11,6 +11,7 @@ import subprocess
 import tzlocal
 
 DATE_FORMAT = '%Y%m%dT%H%M%SZ'
 import tzlocal
 
 DATE_FORMAT = '%Y%m%dT%H%M%SZ'

+DATE_FORMAT_CALC = '%Y-%m-%dT%H:%M:%S'

 REPR_OUTPUT_SIZE = 10
 PENDING = 'pending'
 COMPLETED = 'completed'
 REPR_OUTPUT_SIZE = 10
 PENDING = 'pending'
 COMPLETED = 'completed'


@@ -19,6 +20,9 @@ VERSION_2_1_0 = six.u('2.1.0')
 VERSION_2_2_0 = six.u('2.2.0')
 VERSION_2_3_0 = six.u('2.3.0')
 VERSION_2_4_0 = six.u('2.4.0')
 VERSION_2_2_0 = six.u('2.2.0')
 VERSION_2_3_0 = six.u('2.3.0')
 VERSION_2_4_0 = six.u('2.4.0')

+VERSION_2_4_1 = six.u('2.4.1')
+VERSION_2_4_2 = six.u('2.4.2')
+VERSION_2_4_3 = six.u('2.4.3')

 
 logger = logging.getLogger(__name__)
 local_zone = tzlocal.get_localzone()
 
 logger = logging.getLogger(__name__)
 local_zone = tzlocal.get_localzone()


@@ -86,6 +90,9 @@ class SerializingObject(object):
         to raise ValueError.
     """
 
         to raise ValueError.
     """
 

+    def __init__(self, warrior):
+        self.warrior = warrior
+

     def _deserialize(self, key, value):
         hydrate_func = getattr(self, 'deserialize_{0}'.format(key),
                                lambda x: x if x != '' else None)
     def _deserialize(self, key, value):
         hydrate_func = getattr(self, 'deserialize_{0}'.format(key),
                                lambda x: x if x != '' else None)


@@ -149,6 +156,24 @@ class SerializingObject(object):
     def normalize_modified(self, value):
         return self.datetime_normalizer(value)
 
     def normalize_modified(self, value):
         return self.datetime_normalizer(value)
 

+    def serialize_start(self, value):
+        return self.timestamp_serializer(value)
+
+    def deserialize_start(self, value):
+        return self.timestamp_deserializer(value)
+
+    def normalize_start(self, value):
+        return self.datetime_normalizer(value)
+
+    def serialize_end(self, value):
+        return self.timestamp_serializer(value)
+
+    def deserialize_end(self, value):
+        return self.timestamp_deserializer(value)
+
+    def normalize_end(self, value):
+        return self.datetime_normalizer(value)
+

     def serialize_due(self, value):
         return self.timestamp_serializer(value)
 
     def serialize_due(self, value):
         return self.timestamp_serializer(value)
 


@@ -230,13 +255,26 @@ class SerializingObject(object):
             # Convert to local midnight
             value_full = datetime.datetime.combine(value, datetime.time.min)
             localized = local_zone.localize(value_full)
             # Convert to local midnight
             value_full = datetime.datetime.combine(value, datetime.time.min)
             localized = local_zone.localize(value_full)

-        elif isinstance(value, datetime.datetime) and value.tzinfo is None:
-            # Convert to localized datetime object
-            localized = local_zone.localize(value)
+        elif isinstance(value, datetime.datetime):
+            if value.tzinfo is None:
+                # Convert to localized datetime object
+                localized = local_zone.localize(value)
+            else:
+                # If the value is already localized, there is no need to change
+                # time zone at this point. Also None is a valid value too.
+                localized = value
+        elif (isinstance(value, six.string_types)
+                and self.warrior.version >= VERSION_2_4_0):
+            # For strings, use 'task calc' to evaluate the string to datetime
+            # available since TW 2.4.0
+            args = value.split()
+            result = self.warrior.execute_command(['calc'] + args)
+            naive = datetime.datetime.strptime(result[0], DATE_FORMAT_CALC)
+            localized = local_zone.localize(naive)

         else:
         else:

-            # If the value is already localized, there is no need to change
-            # time zone at this point. Also None is a valid value too.
-            localized = value
+            raise ValueError("Provided value could not be converted to "
+                             "datetime, its type is not supported: {}"
+                             .format(type(value)))

 
         return localized
 
 
         return localized
 


@@ -344,6 +382,7 @@ class TaskAnnotation(TaskResource):
     def __init__(self, task, data={}):
         self.task = task
         self._load_data(data)
     def __init__(self, task, data={}):
         self.task = task
         self._load_data(data)

+        super(TaskAnnotation, self).__init__(task.warrior)

 
     def remove(self):
         self.task.remove_annotation(self)
 
     def remove(self):
         self.task.remove_annotation(self)


@@ -424,7 +463,7 @@ class Task(TaskResource):
         return task
 
     def __init__(self, warrior, **kwargs):
         return task
 
     def __init__(self, warrior, **kwargs):

-        self.warrior = warrior
+        super(Task, self).__init__(warrior)

 
         # Check that user is not able to set read-only value in __init__
         for key in kwargs.keys():
 
         # Check that user is not able to set read-only value in __init__
         for key in kwargs.keys():


@@ -479,6 +518,10 @@ class Task(TaskResource):
     def pending(self):
         return self['status'] == six.text_type('pending')
 
     def pending(self):
         return self['status'] == six.text_type('pending')
 

+    @property
+    def active(self):
+        return self['start'] is not None
+

     @property
     def saved(self):
         return self['uuid'] is not None or self['id'] is not None
     @property
     def saved(self):
         return self['uuid'] is not None or self['id'] is not None


@@ -532,8 +575,24 @@ class Task(TaskResource):
         self.warrior.execute_command([self['uuid'], 'delete'])
 
         # Refresh the status again, so that we have updated info stored
         self.warrior.execute_command([self['uuid'], 'delete'])
 
         # Refresh the status again, so that we have updated info stored

+        self.refresh(only_fields=['status', 'start', 'end'])
+
+    def start(self):
+        if not self.saved:
+            raise Task.NotSaved("Task needs to be saved before it can be started")
+
+        # Refresh, and raise exception if task is already completed/deleted

         self.refresh(only_fields=['status'])
 
         self.refresh(only_fields=['status'])
 

+        if self.completed:
+            raise Task.CompletedTask("Cannot start a completed task")
+        elif self.deleted:
+            raise Task.DeletedTask("Deleted task cannot be started")
+
+        self.warrior.execute_command([self['uuid'], 'start'])
+
+        # Refresh the status again, so that we have updated info stored
+        self.refresh(only_fields=['status', 'start'])

 
     def done(self):
         if not self.saved:
 
     def done(self):
         if not self.saved:


@@ -550,7 +609,7 @@ class Task(TaskResource):
         self.warrior.execute_command([self['uuid'], 'done'])
 
         # Refresh the status again, so that we have updated info stored
         self.warrior.execute_command([self['uuid'], 'done'])
 
         # Refresh the status again, so that we have updated info stored

-        self.refresh(only_fields=['status'])
+        self.refresh(only_fields=['status', 'start', 'end'])

 
     def save(self):
         if self.saved and not self.modified:
 
     def save(self):
         if self.saved and not self.modified:


@@ -654,8 +713,9 @@ class TaskFilter(SerializingObject):
     A set of parameters to filter the task list with.
     """
 
     A set of parameters to filter the task list with.
     """
 

-    def __init__(self, filter_params=[]):
+    def __init__(self, warrior, filter_params=[]):

         self.filter_params = filter_params
         self.filter_params = filter_params

+        super(TaskFilter, self).__init__(warrior)

 
     def add_filter(self, filter_str):
         self.filter_params.append(filter_str)
 
     def add_filter(self, filter_str):
         self.filter_params.append(filter_str)


@@ -668,7 +728,7 @@ class TaskFilter(SerializingObject):
         attribute_key = key.split('.')[0]
 
         # Since this is user input, we need to normalize before we serialize
         attribute_key = key.split('.')[0]
 
         # Since this is user input, we need to normalize before we serialize

-        value = self._normalize(key, value)
+        value = self._normalize(attribute_key, value)

         value = self._serialize(attribute_key, value)
 
         # If we are filtering by uuid:, do not use uuid keyword
         value = self._serialize(attribute_key, value)
 
         # If we are filtering by uuid:, do not use uuid keyword


@@ -690,7 +750,7 @@ class TaskFilter(SerializingObject):
         return [f for f in self.filter_params if f]
 
     def clone(self):
         return [f for f in self.filter_params if f]
 
     def clone(self):

-        c = self.__class__()
+        c = self.__class__(self.warrior)

         c.filter_params = list(self.filter_params)
         return c
 
         c.filter_params = list(self.filter_params)
         return c
 


@@ -703,7 +763,7 @@ class TaskQuerySet(object):
     def __init__(self, warrior=None, filter_obj=None):
         self.warrior = warrior
         self._result_cache = None
     def __init__(self, warrior=None, filter_obj=None):
         self.warrior = warrior
         self._result_cache = None

-        self.filter_obj = filter_obj or TaskFilter()
+        self.filter_obj = filter_obj or TaskFilter(warrior)

 
     def __deepcopy__(self, memo):
         """
 
     def __deepcopy__(self, memo):
         """


@@ -806,21 +866,35 @@ class TaskQuerySet(object):
 
 
 class TaskWarrior(object):
 
 
 class TaskWarrior(object):

-    def __init__(self, data_location='~/.task', create=True):
-        data_location = os.path.expanduser(data_location)
-        if create and not os.path.exists(data_location):
-            os.makedirs(data_location)
+    def __init__(self, data_location=None, create=True, taskrc_location='~/.taskrc'):
+        self.taskrc_location = os.path.expanduser(taskrc_location)
+
+        # If taskrc does not exist, pass / to use defaults and avoid creating
+        # dummy .taskrc file by TaskWarrior
+        if not os.path.exists(self.taskrc_location):
+            self.taskrc_location = '/'
+
+        self.version = self._get_version()

         self.config = {
         self.config = {

-            'data.location': os.path.expanduser(data_location),

             'confirmation': 'no',
             'dependency.confirmation': 'no',  # See TW-1483 or taskrc man page
             'recurrence.confirmation': 'no',  # Necessary for modifying R tasks
             'confirmation': 'no',
             'dependency.confirmation': 'no',  # See TW-1483 or taskrc man page
             'recurrence.confirmation': 'no',  # Necessary for modifying R tasks

+            # 2.4.3 onwards supports 0 as infite bulk, otherwise set just
+            # arbitrary big number which is likely to be large enough
+            'bulk': 0 if self.version >= VERSION_2_4_3 else 100000,

         }
         }

+
+        # Set data.location override if passed via kwarg
+        if data_location is not None:
+            data_location = os.path.expanduser(data_location)
+            if create and not os.path.exists(data_location):
+                os.makedirs(data_location)
+            self.config['data.location'] = data_location
+

         self.tasks = TaskQuerySet(self)
         self.tasks = TaskQuerySet(self)

-        self.version = self._get_version()

 
     def _get_command_args(self, args, config_override={}):
 
     def _get_command_args(self, args, config_override={}):

-        command_args = ['task', 'rc:/']
+        command_args = ['task', 'rc:{0}'.format(self.taskrc_location)]

         config = self.config.copy()
         config.update(config_override)
         for item in config.items():
         config = self.config.copy()
         config.update(config_override)
         for item in config.items():


@@ -849,14 +923,15 @@ class TaskWarrior(object):
             else:
                 error_msg = stdout.strip()
             raise TaskWarriorException(error_msg)
             else:
                 error_msg = stdout.strip()
             raise TaskWarriorException(error_msg)

-        return stdout.strip().split('\n')
+        return stdout.rstrip().split('\n')

 
     def enforce_recurrence(self):
         # Run arbitrary report command which will trigger generation
         # of recurrent tasks.
 
     def enforce_recurrence(self):
         # Run arbitrary report command which will trigger generation
         # of recurrent tasks.

-        # TODO: Make a version dependant enforcement once
-        #       TW-1531 is handled
-        self.execute_command(['next'], allow_failure=False)
+
+        # Only necessary for TW up to 2.4.1, fixed in 2.4.2.
+        if self.version < VERSION_2_4_2:
+            self.execute_command(['next'], allow_failure=False)

 
     def filter_tasks(self, filter_obj):
         self.enforce_recurrence()
 
     def filter_tasks(self, filter_obj):
         self.enforce_recurrence()