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 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451
|
# -*- coding: utf-8 -*-
'''
Task Coach - Your friendly task manager
Copyright (C) 2004-2016 Task Coach developers <developers@taskcoach.org>
Copyright (C) 2010 Svetoslav Trochev <sal_electronics@hotmail.com>
Task Coach is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Task Coach 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
'''
from taskcoachlib import patterns
from taskcoachlib.domain import date, categorizable, note, attachment, base
from taskcoachlib.domain.attribute.icon import getImageOpen
from wx.lib.pubsub import pub
from taskcoachlib.thirdparty._weakrefset import WeakSet
import status
import weakref
import wx
class Task(note.NoteOwner, attachment.AttachmentOwner,
categorizable.CategorizableCompositeObject):
maxDateTime = date.DateTime()
def __init__(self, subject='', description='',
dueDateTime=None, plannedStartDateTime=None,
actualStartDateTime=None, completionDateTime=None,
budget=None, priority=0, id=None, hourlyFee=0, # pylint: disable=W0622
fixedFee=0, reminder=None, reminderBeforeSnooze=None, categories=None,
efforts=None, shouldMarkCompletedWhenAllChildrenCompleted=None,
recurrence=None, percentageComplete=0, prerequisites=None,
dependencies=None, *args, **kwargs):
kwargs['id'] = id
kwargs['subject'] = subject
kwargs['description'] = description
kwargs['categories'] = categories
super(Task, self).__init__(*args, **kwargs)
self.__status = None # status cache
self.__dueSoonHours = self.settings.getint('behavior', 'duesoonhours') # pylint: disable=E1101
maxDateTime = self.maxDateTime
self.__dueDateTime = dueDateTime or maxDateTime
self.__plannedStartDateTime = plannedStartDateTime or maxDateTime
self.__actualStartDateTime = actualStartDateTime or maxDateTime
if completionDateTime is None and percentageComplete == 100:
completionDateTime = date.Now()
self.__completionDateTime = completionDateTime or maxDateTime
percentageComplete = 100 if self.__completionDateTime != maxDateTime else percentageComplete
self.__percentageComplete = percentageComplete
self.__budget = budget or date.TimeDelta()
self._efforts = efforts or []
self.__priority = priority
self.__hourlyFee = hourlyFee
self.__fixedFee = fixedFee
self.__reminder = reminder or maxDateTime
self.__reminderBeforeSnooze = reminderBeforeSnooze or self.__reminder
self.__recurrence = date.Recurrence() if recurrence is None else recurrence
self.__prerequisites = WeakSet(prerequisites or [])
self.__dependencies = WeakSet(dependencies or [])
self.__shouldMarkCompletedWhenAllChildrenCompleted = \
shouldMarkCompletedWhenAllChildrenCompleted
for effort in self._efforts:
effort.setTask(self)
pub.subscribe(self.__computeRecursiveForegroundColor, 'settings.fgcolor')
pub.subscribe(self.__computeRecursiveBackgroundColor, 'settings.bgcolor')
pub.subscribe(self.__computeRecursiveIcon, 'settings.icon')
pub.subscribe(self.__computeRecursiveSelectedIcon, 'settings.icon')
pub.subscribe(self.onDueSoonHoursChanged, 'settings.behavior.duesoonhours')
pub.subscribe(self.onMarkParentCompletedWhenAllChildrenCompletedChanged,
'settings.behavior.markparentcompletedwhenallchildrencompleted')
now = date.Now()
if now < self.__dueDateTime < maxDateTime:
date.Scheduler().schedule(self.onOverDue, self.__dueDateTime + date.ONE_SECOND)
if self.__dueSoonHours:
dueSoonDateTime = self.__dueDateTime + date.ONE_SECOND - date.TimeDelta(hours=self.__dueSoonHours)
if dueSoonDateTime > date.Now():
date.Scheduler().schedule(self.onDueSoon, dueSoonDateTime)
if now < self.__plannedStartDateTime < maxDateTime:
date.Scheduler().schedule(self.onTimeToStart, self.__plannedStartDateTime + date.ONE_SECOND)
@patterns.eventSource
def __setstate__(self, state, event=None):
super(Task, self).__setstate__(state, event=event)
self.setPlannedStartDateTime(state['plannedStartDateTime'])
self.setActualStartDateTime(state['actualStartDateTime'])
self.setDueDateTime(state['dueDateTime'])
self.setCompletionDateTime(state['completionDateTime'])
self.setPercentageComplete(state['percentageComplete'])
self.setRecurrence(state['recurrence'])
self.setReminder(state['reminder'])
self.setEfforts(state['efforts'])
self.setBudget(state['budget'])
self.setPriority(state['priority'])
self.setHourlyFee(state['hourlyFee'])
self.setFixedFee(state['fixedFee'])
self.setPrerequisites(state['prerequisites'])
self.setDependencies(state['dependencies'])
self.setShouldMarkCompletedWhenAllChildrenCompleted( \
state['shouldMarkCompletedWhenAllChildrenCompleted'])
def __getstate__(self):
state = super(Task, self).__getstate__()
state.update(dict(dueDateTime=self.__dueDateTime,
plannedStartDateTime=self.__plannedStartDateTime,
actualStartDateTime=self.__actualStartDateTime,
completionDateTime=self.__completionDateTime,
percentageComplete=self.__percentageComplete,
children=self.children(), parent=self.parent(),
efforts=self._efforts, budget=self.__budget,
priority=self.__priority,
hourlyFee=self.__hourlyFee, fixedFee=self.__fixedFee,
recurrence=self.__recurrence.copy(),
reminder=self.__reminder,
prerequisites=set(self.__prerequisites),
dependencies=set(self.__dependencies),
shouldMarkCompletedWhenAllChildrenCompleted=self.__shouldMarkCompletedWhenAllChildrenCompleted))
return state
def __getcopystate__(self):
state = super(Task, self).__getcopystate__()
state.update(dict(plannedStartDateTime=self.__plannedStartDateTime,
dueDateTime=self.__dueDateTime,
actualStartDateTime=self.__actualStartDateTime,
completionDateTime=self.__completionDateTime,
percentageComplete=self.__percentageComplete,
efforts=[effort.copy() for effort in self._efforts],
budget=self.__budget, priority=self.__priority,
hourlyFee=self.__hourlyFee, fixedFee=self.__fixedFee,
recurrence=self.__recurrence.copy(),
reminder=self.__reminder,
shouldMarkCompletedWhenAllChildrenCompleted=self.__shouldMarkCompletedWhenAllChildrenCompleted))
return state
@classmethod
def monitoredAttributes(class_):
return categorizable.CategorizableCompositeObject.monitoredAttributes() + \
['plannedStartDateTime', 'dueDateTime', 'completionDateTime',
'percentageComplete', 'recurrence', 'reminder', 'budget',
'priority', 'hourlyFee', 'fixedFee',
'shouldMarkCompletedWhenAllChildrenCompleted']
@patterns.eventSource
def addCategory(self, *categories, **kwargs):
if super(Task, self).addCategory(*categories, **kwargs):
self.recomputeAppearance(True, event=kwargs.pop('event'))
@patterns.eventSource
def removeCategory(self, *categories, **kwargs):
if super(Task, self).removeCategory(*categories, **kwargs):
self.recomputeAppearance(True, event=kwargs.pop('event'))
@patterns.eventSource
def setCategories(self, *categories, **kwargs):
if super(Task, self).setCategories(*categories, **kwargs):
self.recomputeAppearance(True, event=kwargs.pop('event'))
def allChildrenCompleted(self):
''' Return whether all children (non-recursively) are completed. '''
children = self.children()
return all(child.completed() for child in children) if children \
else False
@patterns.eventSource
def addChild(self, child, event=None):
if child in self.children():
return
wasTracking = self.isBeingTracked(recursive=True)
super(Task, self).addChild(child, event=event)
self.childChangeEvent(child, wasTracking, event)
if self.shouldBeMarkedCompleted():
self.setCompletionDateTime(child.completionDateTime())
elif self.completed() and not child.completed():
self.setCompletionDateTime(self.maxDateTime)
self.recomputeAppearance(recursive=False, event=event)
child.recomputeAppearance(recursive=True, event=event)
@patterns.eventSource
def removeChild(self, child, event=None):
if child not in self.children():
return
wasTracking = self.isBeingTracked(recursive=True)
super(Task, self).removeChild(child, event=event)
self.childChangeEvent(child, wasTracking, event)
if self.shouldBeMarkedCompleted():
# The removed child was the last uncompleted child
self.setCompletionDateTime(date.Now())
self.recomputeAppearance(recursive=False, event=event)
child.recomputeAppearance(recursive=True, event=event)
def childChangeEvent(self, child, wasTracking, event):
childHasTimeSpent = child.timeSpent(recursive=True)
childHasBudget = child.budget(recursive=True)
childHasBudgetLeft = child.budgetLeft(recursive=True)
childHasRevenue = child.revenue(recursive=True)
childPriority = child.priority(recursive=True)
# Determine what changes due to the child being added or removed:
if childHasTimeSpent:
self.sendTimeSpentChangedMessage()
if childHasRevenue:
self.sendRevenueChangedMessage()
if childHasBudget:
self.sendBudgetChangedMessage()
if childHasBudgetLeft or (childHasTimeSpent and \
(childHasBudget or self.budget())):
self.sendBudgetLeftChangedMessage()
if childPriority > self.priority():
self.sendPriorityChangedMessage()
isTracking = self.isBeingTracked(recursive=True)
if wasTracking and not isTracking:
self.sendTrackingChangedMessage(tracking=False)
elif not wasTracking and isTracking:
self.sendTrackingChangedMessage(tracking=True)
@patterns.eventSource
def setSubject(self, subject, event=None):
super(Task, self).setSubject(subject, event=event)
# The subject of a dependency of our prerequisites has changed, notify:
for prerequisite in self.prerequisites():
pub.sendMessage(prerequisite.dependenciesChangedEventType(),
newValue=prerequisite.dependencies(),
sender=prerequisite)
# The subject of a prerequisite of our dependencies has changed, notify:
for dependency in self.dependencies():
pub.sendMessage(dependency.prerequisitesChangedEventType(),
newValue=dependency.prerequisites(),
sender=dependency)
# Due date
def dueDateTime(self, recursive=False):
if recursive:
childrenDueDateTimes = [child.dueDateTime(recursive=True) for child in \
self.children() if not child.completed()]
return min(childrenDueDateTimes + [self.__dueDateTime])
else:
return self.__dueDateTime
def setDueDateTime(self, dueDateTime):
if dueDateTime == self.__dueDateTime:
return
self.__dueDateTime = dueDateTime
date.Scheduler().unschedule(self.onOverDue)
date.Scheduler().unschedule(self.onDueSoon)
if date.Now() <= dueDateTime < self.maxDateTime:
date.Scheduler().schedule(self.onOverDue,
dueDateTime + date.ONE_SECOND)
if self.__dueSoonHours > 0:
dueSoonDateTime = dueDateTime + date.ONE_SECOND - \
date.TimeDelta(hours=self.__dueSoonHours)
if dueSoonDateTime > date.Now():
date.Scheduler().schedule(self.onDueSoon, dueSoonDateTime)
self.markDirty()
self.recomputeAppearance()
pub.sendMessage(self.dueDateTimeChangedEventType(),
newValue=dueDateTime, sender=self)
for ancestor in self.ancestors():
pub.sendMessage(ancestor.dueDateTimeChangedEventType(),
newValue=dueDateTime, sender=ancestor)
@classmethod
def dueDateTimeChangedEventType(class_):
return 'pubsub.task.dueDateTime'
def onOverDue(self):
self.recomputeAppearance()
def onDueSoon(self):
self.recomputeAppearance()
@staticmethod
def dueDateTimeSortFunction(**kwargs):
recursive = kwargs.get('treeMode', False)
return lambda task: task.dueDateTime(recursive=recursive)
@classmethod
def dueDateTimeSortEventTypes(class_):
''' The event types that influence the due date time sort order. '''
return (class_.dueDateTimeChangedEventType(),)
# Planned start date
def plannedStartDateTime(self, recursive=False):
if recursive:
childrenPlannedStartDateTimes = [child.plannedStartDateTime(recursive=True) for child in \
self.children() if not child.completed()]
return min(childrenPlannedStartDateTimes + [self.__plannedStartDateTime])
else:
return self.__plannedStartDateTime
def setPlannedStartDateTime(self, plannedStartDateTime):
if plannedStartDateTime == self.__plannedStartDateTime:
return
self.__plannedStartDateTime = plannedStartDateTime
date.Scheduler().unschedule(self.onTimeToStart)
self.markDirty()
self.recomputeAppearance()
if plannedStartDateTime < self.maxDateTime:
date.Scheduler().schedule(self.onTimeToStart,
plannedStartDateTime + date.ONE_SECOND)
pub.sendMessage(self.plannedStartDateTimeChangedEventType(),
newValue=plannedStartDateTime, sender=self)
for ancestor in self.ancestors():
pub.sendMessage(ancestor.plannedStartDateTimeChangedEventType(),
newValue=plannedStartDateTime, sender=ancestor)
@classmethod
def plannedStartDateTimeChangedEventType(class_):
return 'pubsub.task.plannedStartDateTime'
def onTimeToStart(self):
self.recomputeAppearance()
@staticmethod
def plannedStartDateTimeSortFunction(**kwargs):
recursive = kwargs.get('treeMode', False)
return lambda task: task.plannedStartDateTime(recursive=recursive)
@classmethod
def plannedStartDateTimeSortEventTypes(class_):
''' The event types that influence the planned start date time sort
order. '''
return (class_.plannedStartDateTimeChangedEventType(),)
def timeLeft(self, recursive=False):
return self.dueDateTime(recursive) - date.Now()
@staticmethod
def timeLeftSortFunction(**kwargs):
recursive = kwargs.get('treeMode', False)
return lambda task: task.timeLeft(recursive=recursive)
@classmethod
def timeLeftSortEventTypes(class_):
''' The event types that influence the time left sort order. '''
return (class_.dueDateTimeChangedEventType(),)
# Actual start date
def actualStartDateTime(self, recursive=False):
if recursive:
childrenActualStartDateTimes = [child.actualStartDateTime(recursive=True) for child in \
self.children() if not child.completed()]
return min(childrenActualStartDateTimes + [self.__actualStartDateTime])
else:
return self.__actualStartDateTime
def setActualStartDateTime(self, actualStartDateTime, recursive=False):
if actualStartDateTime == self.__actualStartDateTime:
return
self.__actualStartDateTime = actualStartDateTime
if recursive:
for child in self.children(recursive=True):
child.setActualStartDateTime(actualStartDateTime)
self.markDirty()
self.recomputeAppearance()
pub.sendMessage(self.actualStartDateTimeChangedEventType(),
newValue=actualStartDateTime, sender=self)
for ancestor in self.ancestors():
pub.sendMessage(ancestor.actualStartDateTimeChangedEventType(),
newValue=actualStartDateTime, sender=ancestor)
@classmethod
def actualStartDateTimeChangedEventType(class_):
return 'pubsub.task.actualStartDateTime'
@staticmethod
def actualStartDateTimeSortFunction(**kwargs):
recursive = kwargs.get('treeMode', False)
return lambda task: task.actualStartDateTime(recursive=recursive)
@classmethod
def actualStartDateTimeSortEventTypes(class_):
''' The event types that influence the actual start date time sort order. '''
return (class_.actualStartDateTimeChangedEventType(),)
# Completion date
def completionDateTime(self, recursive=False):
if recursive:
childrenCompletionDateTimes = [child.completionDateTime(recursive=True) \
for child in self.children() if child.completed()]
return max(childrenCompletionDateTimes + [self.__completionDateTime])
else:
return self.__completionDateTime
def setCompletionDateTime(self, completionDateTime=None):
completionDateTime = completionDateTime or date.Now()
if completionDateTime == self.__completionDateTime:
return
if completionDateTime != self.maxDateTime and self.recurrence():
self.recur(completionDateTime)
else:
parent = self.parent()
if parent:
oldParentPriority = parent.priority(recursive=True)
self.__status = None
self.__completionDateTime = completionDateTime
if parent and parent.priority(recursive=True) != oldParentPriority:
parent.sendPriorityChangedMessage()
if completionDateTime != self.maxDateTime:
self.setReminder(None)
self.setPercentageComplete(100)
elif self.percentageComplete() == 100:
self.setPercentageComplete(0)
if parent:
if self.completed():
if parent.shouldBeMarkedCompleted():
parent.setCompletionDateTime(completionDateTime)
else:
if parent.completed():
parent.setCompletionDateTime(self.maxDateTime)
if self.completed():
for child in self.children():
if not child.completed():
child.setRecurrence()
child.setCompletionDateTime(completionDateTime)
if self.isBeingTracked():
self.stopTracking()
self.recomputeAppearance()
for dependency in self.dependencies():
dependency.recomputeAppearance(recursive=True)
pub.sendMessage(self.completionDateTimeChangedEventType(),
newValue=completionDateTime, sender=self)
for ancestor in self.ancestors():
pub.sendMessage(ancestor.completionDateTimeChangedEventType(),
newValue=completionDateTime, sender=ancestor)
@classmethod
def completionDateTimeChangedEventType(class_):
return 'pubsub.task.completionDateTime'
def shouldBeMarkedCompleted(self):
''' Return whether this task should be marked completed. It should be
marked completed when 1) it's not completed, 2) all of its children
are completed, 3) its setting says it should be completed when
all of its children are completed. '''
shouldMarkCompletedAccordingToSetting = \
self.settings.getboolean('behavior', # pylint: disable=E1101
'markparentcompletedwhenallchildrencompleted')
shouldMarkCompletedAccordingToTask = \
self.shouldMarkCompletedWhenAllChildrenCompleted()
return ((shouldMarkCompletedAccordingToTask == True) or \
((shouldMarkCompletedAccordingToTask == None) and \
shouldMarkCompletedAccordingToSetting)) and \
(not self.completed()) and self.allChildrenCompleted()
@staticmethod
def completionDateTimeSortFunction(**kwargs):
recursive = kwargs.get('treeMode', False)
return lambda task: task.completionDateTime(recursive=recursive)
@classmethod
def completionDateTimeSortEventTypes(class_):
''' The event types that influence the completion date time sort order. '''
return (class_.completionDateTimeChangedEventType(),)
def onMarkParentCompletedWhenAllChildrenCompletedChanged(self, value):
''' When the global setting changes, send a percentage completed
changed if necessary. '''
if self.shouldMarkCompletedWhenAllChildrenCompleted() is None and \
any([child.percentageComplete(True) for child in self.children()]):
pub.sendMessage(self.percentageCompleteChangedEventType(),
newValue=self.percentageComplete(), sender=self)
# Task state
def completed(self):
''' A task is completed if it has a completion date/time. '''
return self.status() == status.completed
def overdue(self):
''' A task is over due if its due date/time is in the past and it is
not completed. Note that an over due task is also either active
or inactive. '''
return self.status() == status.overdue
def inactive(self):
''' A task is inactive if it is not completed and either has no planned
start date/time or a planned start date/time in the future, and/or
its prerequisites are not completed. '''
return self.status() == status.inactive
def active(self):
''' A task is active if it has a planned start date/time in the past and
it is not completed. Note that over due and due soon tasks are also
considered to be active. So the statuses active, inactive and
completed are disjunct, but the statuses active, due soon and over
due are not. '''
return self.status() == status.active
def dueSoon(self):
''' A task is due soon if it is not completed and there is still time
left (i.e. it is not over due). '''
return self.status() == status.duesoon
def late(self):
''' A task is late if it is not active and its planned start date time
is in the past. '''
return self.status() == status.late
@classmethod
def possibleStatuses(class_):
return (status.inactive, status.late, status.active,
status.duesoon, status.overdue, status.completed)
def status(self):
if self.__status:
return self.__status
if self.completionDateTime() != self.maxDateTime:
self.__status = status.completed
else:
now = date.Now()
if self.dueDateTime() < now:
self.__status = status.overdue
elif 0 <= self.timeLeft().hours() < self.__dueSoonHours:
self.__status = status.duesoon
elif self.actualStartDateTime() <= now:
self.__status = status.active
# Don't call prerequisite.completed() because it will lead to infinite
# recursion in the case of circular dependencies:
elif any([prerequisite.completionDateTime() == self.maxDateTime \
for prerequisite in self.prerequisites(recursive=True,
upwards=True)]):
self.__status = status.inactive
elif self.plannedStartDateTime() < now:
self.__status = status.late
else:
self.__status = status.inactive
return self.__status
def onDueSoonHoursChanged(self, value):
date.Scheduler().unschedule(self.onDueSoon)
self.__dueSoonHours = value
dueDateTime = self.dueDateTime()
if dueDateTime < self.maxDateTime:
newDueSoonDateTime = dueDateTime + date.ONE_SECOND - date.TimeDelta(hours=self.__dueSoonHours)
date.Scheduler().schedule(self.onDueSoon, newDueSoonDateTime)
self.recomputeAppearance()
# effort related methods:
def efforts(self, recursive=False):
childEfforts = []
if recursive:
for child in self.children():
childEfforts.extend(child.efforts(recursive=True))
return self._efforts + childEfforts
def isBeingTracked(self, recursive=False):
return self.activeEfforts(recursive)
def activeEfforts(self, recursive=False):
return [effort for effort in self.efforts(recursive) \
if effort.isBeingTracked()]
def addEffort(self, effort):
if effort in self._efforts:
return
wasTracking = self.isBeingTracked()
oldValue = self._efforts[:]
self._efforts.append(effort)
if effort.getStart() < self.actualStartDateTime():
self.setActualStartDateTime(effort.getStart())
pub.sendMessage(self.effortsChangedEventType(), newValue=(self._efforts,
oldValue), sender=self)
if effort.isBeingTracked() and not wasTracking:
self.sendTrackingChangedMessage(tracking=True)
self.sendTimeSpentChangedMessage()
@classmethod
def effortsChangedEventType(class_):
return 'pubsub.task.efforts'
def sendTrackingChangedMessage(self, tracking):
self.recomputeAppearance()
pub.sendMessage(self.trackingChangedEventType(), newValue=tracking,
sender=self)
for ancestor in self.ancestors():
pub.sendMessage(ancestor.trackingChangedEventType(),
newValue=tracking, sender=ancestor)
def removeEffort(self, effort):
if effort not in self._efforts:
return
oldValue = self._efforts[:]
self._efforts.remove(effort)
pub.sendMessage(self.effortsChangedEventType(), newValue=(self._efforts,
oldValue), sender=self)
if effort.isBeingTracked() and not self.isBeingTracked():
self.sendTrackingChangedMessage(tracking=False)
self.sendTimeSpentChangedMessage()
def stopTracking(self):
for effort in self.activeEfforts():
effort.setStop()
def setEfforts(self, efforts):
if efforts == self._efforts:
return
oldValue = self._efforts[:]
self._efforts = efforts
pub.sendMessage(self.effortsChangedEventType(), newValue=(self._efforts,
oldValue), sender=self)
self.sendTimeSpentChangedMessage()
@classmethod
def trackingChangedEventType(class_):
return 'pubsub.task.track'
# Time spent
def timeSpent(self, recursive=False):
return sum((effort.duration() for effort in self.efforts(recursive)),
date.TimeDelta())
def sendTimeSpentChangedMessage(self):
pub.sendMessage(self.timeSpentChangedEventType(),
newValue=self.timeSpent(), sender=self)
for ancestor in self.ancestors():
pub.sendMessage(ancestor.timeSpentChangedEventType(),
newValue=ancestor.timeSpent(),
sender=ancestor)
if self.budget(recursive=True):
self.sendBudgetLeftChangedMessage()
if self.hourlyFee() > 0:
self.sendRevenueChangedMessage()
@classmethod
def timeSpentChangedEventType(class_):
return 'pubsub.task.timeSpent'
@staticmethod
def timeSpentSortFunction(**kwargs):
recursive = kwargs.get('treeMode', False)
return lambda task: task.timeSpent(recursive=recursive)
@classmethod
def timeSpentSortEventTypes(class_):
''' The event types that influence the time spent sort order. '''
return (class_.timeSpentChangedEventType(),)
# Budget
def budget(self, recursive=False):
result = self.__budget
if recursive:
for task in self.children():
result += task.budget(recursive)
return result
def setBudget(self, budget):
if budget == self.__budget:
return
self.__budget = budget
self.sendBudgetChangedMessage()
self.sendBudgetLeftChangedMessage()
def sendBudgetChangedMessage(self):
pub.sendMessage(self.budgetChangedEventType(), newValue=self.budget(),
sender=self)
for ancestor in self.ancestors():
pub.sendMessage(ancestor.budgetChangedEventType(),
newValue=ancestor.budget(recursive=True),
sender=ancestor)
@classmethod
def budgetChangedEventType(class_):
return 'pubsub.task.budget'
@staticmethod
def budgetSortFunction(**kwargs):
recursive = kwargs.get('treeMode', False)
return lambda task: task.budget(recursive=recursive)
@classmethod
def budgetSortEventTypes(class_):
''' The event types that influence the budget sort order. '''
return (class_.budgetChangedEventType(),)
# Budget left
def budgetLeft(self, recursive=False):
budget = self.budget(recursive)
return budget - self.timeSpent(recursive) if budget else budget
def sendBudgetLeftChangedMessage(self):
pub.sendMessage(self.budgetLeftChangedEventType(),
newValue=self.budgetLeft(), sender=self)
for ancestor in self.ancestors():
pub.sendMessage(ancestor.budgetLeftChangedEventType(),
newValue=ancestor.budgetLeft(recursive=True),
sender=ancestor)
@classmethod
def budgetLeftChangedEventType(class_):
return 'pubsub.task.budgetLeft'
@staticmethod
def budgetLeftSortFunction(**kwargs):
recursive = kwargs.get('treeMode', False)
return lambda task: task.budgetLeft(recursive=recursive)
@classmethod
def budgetLeftSortEventTypes(class_):
''' The event types that influence the budget left sort order. '''
return (class_.budgetLeftChangedEventType(),)
# Foreground color
def setForegroundColor(self, *args, **kwargs):
super(Task, self).setForegroundColor(*args, **kwargs)
self.__computeRecursiveForegroundColor()
def foregroundColor(self, recursive=False):
if not recursive:
return super(Task, self).foregroundColor(recursive)
try:
return self.__recursiveForegroundColor
except AttributeError:
return self.__computeRecursiveForegroundColor()
def __computeRecursiveForegroundColor(self, value=None): # pylint: disable=W0613
ownColor = super(Task, self).foregroundColor(False)
if ownColor:
recursiveColor = ownColor
else:
categoryColor = self._categoryForegroundColor()
if categoryColor:
recursiveColor = categoryColor
else:
recursiveColor = self.statusFgColor()
self.__recursiveForegroundColor = recursiveColor # pylint: disable=W0201
return recursiveColor
def statusFgColor(self):
''' Return the current color of task, based on its status (completed,
overdue, duesoon, inactive, or active). '''
return self.fgColorForStatus(self.status())
@classmethod
def fgColorForStatus(class_, taskStatus):
return wx.Colour(*eval(class_.settings.get('fgcolor', '%stasks' % taskStatus))) # pylint: disable=E1101
def appearanceChangedEvent(self, event):
self.__computeRecursiveForegroundColor()
self.__computeRecursiveBackgroundColor()
self.__computeRecursiveIcon()
self.__computeRecursiveSelectedIcon()
super(Task, self).appearanceChangedEvent(event)
for eachEffort in self.efforts():
eachEffort.appearanceChangedEvent(event)
# Background color
def setBackgroundColor(self, *args, **kwargs):
super(Task, self).setBackgroundColor(*args, **kwargs)
self.__computeRecursiveBackgroundColor()
def backgroundColor(self, recursive=False):
if not recursive:
return super(Task, self).backgroundColor(recursive)
try:
return self.__recursiveBackgroundColor
except AttributeError:
return self.__computeRecursiveBackgroundColor()
def __computeRecursiveBackgroundColor(self, *args, **kwargs): # pylint: disable=W0613
ownColor = super(Task, self).backgroundColor(recursive=False)
if ownColor:
recursiveColor = ownColor
else:
categoryColor = self._categoryBackgroundColor()
if categoryColor:
recursiveColor = categoryColor
else:
statusColor = self.statusBgColor()
if statusColor:
recursiveColor = statusColor
elif self.parent():
recursiveColor = self.parent().backgroundColor(recursive=True)
else:
recursiveColor = None
self.__recursiveBackgroundColor = recursiveColor # pylint: disable=W0201
return recursiveColor
def statusBgColor(self):
''' Return the current color of task, based on its status (completed,
overdue, duesoon, inactive, or active). '''
color = self.bgColorForStatus(self.status())
return None if color == wx.WHITE else color
@classmethod
def bgColorForStatus(class_, taskStatus):
return wx.Colour(*eval(class_.settings.get('bgcolor', '%stasks' % taskStatus))) # pylint: disable=E1101
# Font
def font(self, recursive=False):
ownFont = super(Task, self).font(recursive=False)
if ownFont or not recursive:
return ownFont
else:
categoryFont = self._categoryFont()
if categoryFont:
return categoryFont
else:
return self.statusFont()
def statusFont(self):
''' Return the current font of task, based on its status (completed,
overdue, duesoon, inactive, or active). '''
return self.fontForStatus(self.status())
@classmethod
def fontForStatus(class_, taskStatus):
nativeInfoString = class_.settings.get('font', '%stasks' % taskStatus) # pylint: disable=E1101
return wx.FontFromNativeInfoString(nativeInfoString) if nativeInfoString else None
# Icon
def icon(self, recursive=False):
if recursive and self.isBeingTracked():
return 'clock_icon'
myIcon = super(Task, self).icon()
if recursive and not myIcon:
try:
myIcon = self.__recursiveIcon
except AttributeError:
myIcon = self.__computeRecursiveIcon()
return self.pluralOrSingularIcon(myIcon, native=super(Task, self).icon() == '')
def __computeRecursiveIcon(self, *args, **kwargs): # pylint: disable=W0613
# pylint: disable=W0201
self.__recursiveIcon = self.categoryIcon() or self.statusIcon()
return self.__recursiveIcon
def selectedIcon(self, recursive=False):
if recursive and self.isBeingTracked():
return 'clock_icon'
myIcon = super(Task, self).selectedIcon()
if recursive and not myIcon:
try:
myIcon = self.__recursiveSelectedIcon
except AttributeError:
myIcon = self.__computeRecursiveSelectedIcon()
return self.pluralOrSingularIcon(myIcon, native=super(Task, self).selectedIcon == '')
def __computeRecursiveSelectedIcon(self, *args, **kwargs): # pylint: disable=W0613
# pylint: disable=W0201
self.__recursiveSelectedIcon = self.categorySelectedIcon() or self.statusIcon(selected=True)
return self.__recursiveSelectedIcon
def statusIcon(self, selected=False):
''' Return the current icon of the task, based on its status. '''
return self.iconForStatus(self.status(), selected)
def iconForStatus(self, taskStatus, selected=False):
iconName = self.settings.get('icon', '%stasks' % taskStatus) # pylint: disable=E1101
iconName = self.pluralOrSingularIcon(iconName)
if selected and iconName.startswith('folder'):
iconName = getImageOpen(iconName)
return iconName
@patterns.eventSource
def recomputeAppearance(self, recursive=False, event=None):
self.__status = None
# Need to prepare for AttributeError because the cached recursive values
# are not set in __init__ for performance reasons
try:
previousForegroundColor = self.__recursiveForegroundColor
previousBackgroundColor = self.__recursiveBackgroundColor
previousRecursiveIcon = self.__recursiveIcon
previousRecursiveSelectedIcon = self.__recursiveSelectedIcon
except AttributeError:
previousForegroundColor = None
previousBackgroundColor = None
previousRecursiveIcon = None
previousRecursiveSelectedIcon = None
self.__computeRecursiveForegroundColor()
self.__computeRecursiveBackgroundColor()
self.__computeRecursiveIcon()
self.__computeRecursiveSelectedIcon()
if self.__recursiveForegroundColor != previousForegroundColor or \
self.__recursiveBackgroundColor != previousBackgroundColor or \
self.__recursiveIcon != previousRecursiveIcon or \
self.__recursiveSelectedIcon != previousRecursiveSelectedIcon:
event.addSource(self, type=self.appearanceChangedEventType())
if recursive:
for child in self.children():
child.recomputeAppearance(recursive=True, event=event)
# percentage Complete
def percentageComplete(self, recursive=False):
if recursive:
if self.shouldMarkCompletedWhenAllChildrenCompleted() is None:
# pylint: disable=E1101
ignore_me = self.settings.getboolean('behavior',
'markparentcompletedwhenallchildrencompleted')
else:
ignore_me = self.shouldMarkCompletedWhenAllChildrenCompleted()
percentages = []
if self.__percentageComplete > 0 or not ignore_me:
percentages.append(self.__percentageComplete)
percentages.extend([child.percentageComplete(recursive) for child in self.children()])
return sum(percentages) / len(percentages) if percentages else 0
else:
return self.__percentageComplete
def setPercentageComplete(self, percentage):
if percentage == self.__percentageComplete:
return
oldPercentage = self.__percentageComplete
self.__percentageComplete = percentage
if percentage == 100 and oldPercentage != 100 and self.completionDateTime() == self.maxDateTime:
self.setCompletionDateTime(date.Now())
elif oldPercentage == 100 and percentage != 100 and self.completionDateTime() != self.maxDateTime:
self.setCompletionDateTime(self.maxDateTime)
if 0 < percentage < 100 and self.actualStartDateTime() == date.DateTime():
self.setActualStartDateTime(date.Now())
pub.sendMessage(self.percentageCompleteChangedEventType(),
newValue=percentage, sender=self)
for ancestor in self.ancestors():
pub.sendMessage(ancestor.percentageCompleteChangedEventType(),
newValue=ancestor.percentageComplete(recursive=True),
sender=ancestor)
@staticmethod
def percentageCompleteSortFunction(**kwargs):
recursive = kwargs.get('treeMode', False)
return lambda task: task.percentageComplete(recursive=recursive)
@classmethod
def percentageCompleteSortEventTypes(class_):
''' The event types that influence the percentage complete sort order. '''
return (class_.percentageCompleteChangedEventType(),)
@classmethod
def percentageCompleteChangedEventType(class_):
return 'pubsub.task.percentageComplete'
# priority
def priority(self, recursive=False):
if recursive:
childPriorities = [child.priority(recursive=True) \
for child in self.children() \
if not child.completed()]
return max(childPriorities + [self.__priority])
else:
return self.__priority
def setPriority(self, priority):
if priority == self.__priority:
return
self.__priority = priority
self.sendPriorityChangedMessage()
def sendPriorityChangedMessage(self):
pub.sendMessage(self.priorityChangedEventType(),
newValue=self.priority(), sender=self)
for ancestor in self.ancestors():
pub.sendMessage(ancestor.priorityChangedEventType(),
newValue=ancestor.priority(),
sender=ancestor)
@classmethod
def priorityChangedEventType(class_):
return 'pubsub.task.priority'
@staticmethod
def prioritySortFunction(**kwargs):
recursive = kwargs.get('treeMode', False)
return lambda task: task.priority(recursive=recursive)
@classmethod
def prioritySortEventTypes(class_):
''' The event types that influence the priority sort order. '''
return (class_.priorityChangedEventType(),)
# Hourly fee
def hourlyFee(self, recursive=False): # pylint: disable=W0613
return self.__hourlyFee
def setHourlyFee(self, hourlyFee):
if hourlyFee == self.__hourlyFee:
return
self.__hourlyFee = hourlyFee
pub.sendMessage(self.hourlyFeeChangedEventType(), newValue=hourlyFee,
sender=self)
if self.timeSpent() > date.TimeDelta():
self.sendRevenueChangedMessage()
for effort in self.efforts():
effort.sendRevenueChangedMessage()
@classmethod
def hourlyFeeChangedEventType(class_):
return 'pubsub.task.hourlyFee'
@staticmethod # pylint: disable=W0613
def hourlyFeeSortFunction(**kwargs):
return lambda task: task.hourlyFee()
@classmethod
def hourlyFeeSortEventTypes(class_):
''' The event types that influence the hourly fee sort order. '''
return (class_.hourlyFeeChangedEventType(),)
# Fixed fee
def fixedFee(self, recursive=False):
childFixedFees = sum(child.fixedFee(recursive) for child in
self.children()) if recursive else 0
return self.__fixedFee + childFixedFees
def setFixedFee(self, fixedFee):
if fixedFee == self.__fixedFee:
return
self.__fixedFee = fixedFee
pub.sendMessage(self.fixedFeeChangedEventType(), newValue=fixedFee,
sender=self)
for ancestor in self.ancestors():
pub.sendMessage(ancestor.fixedFeeChangedEventType(),
newValue=ancestor.fixedFee(recursive=True),
sender=ancestor)
self.sendRevenueChangedMessage()
@classmethod
def fixedFeeChangedEventType(class_):
return 'pubsub.task.fixedFee'
@staticmethod
def fixedFeeSortFunction(**kwargs):
recursive = kwargs.get('treeMode', False)
return lambda task: task.fixedFee(recursive=recursive)
@classmethod
def fixedFeeSortEventTypes(class_):
''' The event types that influence the fixed fee sort order. '''
return (class_.fixedFeeChangedEventType(),)
# Revenue
def revenue(self, recursive=False):
childRevenues = sum(child.revenue(recursive) for child in
self.children()) if recursive else 0
return self.timeSpent().hours() * self.hourlyFee() + self.fixedFee() + \
childRevenues
def sendRevenueChangedMessage(self):
pub.sendMessage(self.revenueChangedEventType(),
newValue=self.revenue(), sender=self)
for ancestor in self.ancestors():
pub.sendMessage(ancestor.revenueChangedEventType(),
newValue=ancestor.revenue(recursive=True),
sender=ancestor)
@classmethod
def revenueChangedEventType(class_):
return 'pubsub.task.revenue'
@staticmethod
def revenueSortFunction(**kwargs):
recursive = kwargs.get('treeMode', False)
return lambda task: task.revenue(recursive=recursive)
@classmethod
def revenueSortEventTypes(class_):
''' The event types that influence the revenue sort order. '''
return (class_.revenueChangedEventType(),)
# reminder
def reminder(self, recursive=False, includeSnooze=True): # pylint: disable=W0613
if recursive:
reminders = [child.reminder(recursive=True) for child in \
self.children()] + [self.__reminder]
reminders = [reminder for reminder in reminders if reminder]
return min(reminders) if reminders else None
else:
return self.__reminder if includeSnooze else self.__reminderBeforeSnooze
def setReminder(self, reminderDateTime=None):
if reminderDateTime == self.maxDateTime:
reminderDateTime = None
if reminderDateTime == self.__reminder:
return
self.__reminder = reminderDateTime
self.__reminderBeforeSnooze = reminderDateTime
pub.sendMessage(self.reminderChangedEventType(),
newValue=reminderDateTime, sender=self)
for ancestor in self.ancestors():
pub.sendMessage(ancestor.reminderChangedEventType(),
newValue=reminderDateTime, sender=ancestor)
def snoozeReminder(self, timeDelta, now=date.Now):
if timeDelta:
self.__reminder = now() + timeDelta
pub.sendMessage(self.reminderChangedEventType(),
newValue=self.__reminder, sender=self)
else:
if self.recurrence():
self.__reminder = None
pub.sendMessage(self.reminderChangedEventType(),
newValue=self.__reminder, sender=self)
else:
self.setReminder()
@classmethod
def reminderChangedEventType(class_):
return 'pubsub.task.reminder'
@staticmethod
def reminderSortFunction(**kwargs):
recursive = kwargs.get('treeMode', False)
maxDateTime = date.DateTime()
return lambda task: task.reminder(recursive=recursive) or maxDateTime
@classmethod
def reminderSortEventTypes(class_):
''' The event types that influence the reminder sort order. '''
return (class_.reminderChangedEventType(),)
# Recurrence
def recurrence(self, recursive=False, upwards=False):
if not self.__recurrence and recursive and upwards and self.parent():
return self.parent().recurrence(recursive, upwards)
elif recursive and not upwards:
recurrences = [child.recurrence() for child in self.children(recursive)]
recurrences.append(self.__recurrence)
recurrences = [r for r in recurrences if r]
return min(recurrences) if recurrences else self.__recurrence
else:
return self.__recurrence
def setRecurrence(self, recurrence=None):
recurrence = recurrence or date.Recurrence()
if recurrence == self.__recurrence:
return
self.__recurrence = recurrence
pub.sendMessage(self.recurrenceChangedEventType(), newValue=recurrence,
sender=self)
@classmethod
def recurrenceChangedEventType(class_):
return 'pubsub.task.recurrence'
@patterns.eventSource
def recur(self, completionDateTime=None, event=None):
completionDateTime = completionDateTime or date.Now()
self.setCompletionDateTime(self.maxDateTime)
recur = self.recurrence(recursive=True, upwards=True)
currentDueDateTime = self.dueDateTime()
if currentDueDateTime != date.DateTime():
basisForRecurrence = completionDateTime if recur.recurBasedOnCompletion else currentDueDateTime
nextDueDateTime = recur(basisForRecurrence, next=False)
nextDueDateTime = nextDueDateTime.replace(hour=currentDueDateTime.hour,
minute=currentDueDateTime.minute,
second=currentDueDateTime.second,
microsecond=currentDueDateTime.microsecond)
self.setDueDateTime(nextDueDateTime)
currentPlannedStartDateTime = self.plannedStartDateTime()
if currentPlannedStartDateTime != date.DateTime():
if date.DateTime() not in (currentPlannedStartDateTime, currentDueDateTime):
taskDuration = currentDueDateTime - currentPlannedStartDateTime
nextPlannedStartDateTime = nextDueDateTime - taskDuration
else:
basisForRecurrence = completionDateTime if recur.recurBasedOnCompletion else currentPlannedStartDateTime
nextPlannedStartDateTime = recur(basisForRecurrence, next=False)
nextPlannedStartDateTime = nextPlannedStartDateTime.replace(hour=currentPlannedStartDateTime.hour,
minute=currentPlannedStartDateTime.minute,
second=currentPlannedStartDateTime.second,
microsecond=currentPlannedStartDateTime.microsecond)
self.setPlannedStartDateTime(nextPlannedStartDateTime)
self.setActualStartDateTime(date.DateTime())
self.setPercentageComplete(0)
if self.reminder(includeSnooze=False):
nextReminder = recur(self.reminder(includeSnooze=False), next=False)
self.setReminder(nextReminder)
for child in self.children():
if not child.recurrence():
child.recur(completionDateTime, event=event)
self.recurrence()(next=True)
@staticmethod
def recurrenceSortFunction(**kwargs):
recursive = kwargs.get('treeMode', False)
return lambda task: task.recurrence(recursive=recursive)
@classmethod
def recurrenceSortEventTypes(class_):
''' The event types that influence the recurrence sort order. '''
return (class_.recurrenceChangedEventType(),)
# Prerequisites
def prerequisites(self, recursive=False, upwards=False):
prerequisites = set(self.__prerequisites)
if recursive and upwards and self.parent() is not None:
prerequisites |= self.parent().prerequisites(recursive=True, upwards=True)
elif recursive and not upwards:
for child in self.children(recursive=True):
prerequisites |= child.prerequisites()
return prerequisites
def setPrerequisites(self, prerequisites):
prerequisites = set(prerequisites)
if prerequisites == self.prerequisites():
return
self.__prerequisites = WeakSet(prerequisites)
self.setActualStartDateTime(self.maxDateTime, recursive=True)
self.recomputeAppearance(recursive=True)
pub.sendMessage(self.prerequisitesChangedEventType(),
newValue=self.prerequisites(), sender=self)
def addPrerequisites(self, prerequisites):
prerequisites = set(prerequisites)
if prerequisites <= self.prerequisites():
return
self.__prerequisites = WeakSet(prerequisites | self.prerequisites())
self.setActualStartDateTime(self.maxDateTime, recursive=True)
self.recomputeAppearance(recursive=True)
pub.sendMessage(self.prerequisitesChangedEventType(),
newValue=self.prerequisites(), sender=self)
def removePrerequisites(self, prerequisites):
prerequisites = set(prerequisites)
if self.prerequisites().isdisjoint(prerequisites):
return
self.__prerequisites = WeakSet(self.prerequisites() - prerequisites)
self.recomputeAppearance(recursive=True)
pub.sendMessage(self.prerequisitesChangedEventType(),
newValue=self.prerequisites(), sender=self)
def addTaskAsDependencyOf(self, prerequisites):
for prerequisite in prerequisites:
prerequisite.addDependencies([self])
def removeTaskAsDependencyOf(self, prerequisites):
for prerequisite in prerequisites:
prerequisite.removeDependencies([self])
@classmethod
def prerequisitesChangedEventType(class_):
return 'pubsub.task.prerequisites'
@staticmethod
def prerequisitesSortFunction(**kwargs):
''' Return a sort key for sorting by prerequisites. Since a task can
have multiple prerequisites we first sort the prerequisites by their
subjects. If the sorter is in tree mode, we also take the
prerequisites of the children of the task into account, after the
prerequisites of the task itself. If the sorter is in list
mode we also take the prerequisites of the parent (recursively) into
account, again after the prerequisites of the categorizable itself.'''
def sortKeyFunction(task):
def sortedSubjects(items):
return sorted([item.subject(recursive=True) for item in items])
prerequisites = task.prerequisites()
sortedPrerequisiteSubjects = sortedSubjects(prerequisites)
isListMode = not kwargs.get('treeMode', False)
childPrerequisites = task.prerequisites(recursive=True, upwards=isListMode) - prerequisites
sortedPrerequisiteSubjects.extend(sortedSubjects(childPrerequisites))
return sortedPrerequisiteSubjects
return sortKeyFunction
@classmethod
def prerequisitesSortEventTypes(class_):
''' The event types that influence the prerequisites sort order. '''
return (class_.prerequisitesChangedEventType(),)
# Dependencies
def dependencies(self, recursive=False, upwards=False):
dependencies = set(self.__dependencies)
if recursive and upwards and self.parent() is not None:
dependencies |= self.parent().dependencies(recursive=True, upwards=True)
elif recursive and not upwards:
for child in self.children(recursive=True):
dependencies |= child.dependencies()
return dependencies
def setDependencies(self, dependencies):
dependencies = set(dependencies)
if dependencies == self.dependencies():
return
self.__dependencies = WeakSet(dependencies)
pub.sendMessage(self.dependenciesChangedEventType(),
newValue=self.dependencies(), sender=self)
def addDependencies(self, dependencies):
dependencies = set(dependencies)
if dependencies <= self.dependencies():
return
self.__dependencies = WeakSet(self.dependencies() | dependencies)
pub.sendMessage(self.dependenciesChangedEventType(),
newValue=self.dependencies(), sender=self)
def removeDependencies(self, dependencies):
dependencies = set(dependencies)
if self.dependencies().isdisjoint(dependencies):
return
self.__dependencies = WeakSet(self.dependencies() - dependencies)
pub.sendMessage(self.dependenciesChangedEventType(),
newValue=self.dependencies(), sender=self)
def addTaskAsPrerequisiteOf(self, dependencies):
for dependency in dependencies:
dependency.addPrerequisites([self])
def removeTaskAsPrerequisiteOf(self, dependencies):
for dependency in dependencies:
dependency.removePrerequisites([self])
@classmethod
def dependenciesChangedEventType(class_):
return 'pubsub.task.dependencies'
@staticmethod
def dependenciesSortFunction(**kwargs):
''' Return a sort key for sorting by dependencies. Since a task can
have multiple dependencies we first sort the dependencies by their
subjects. If the sorter is in tree mode, we also take the
dependencies of the children of the task into account, after the
dependencies of the task itself. If the sorter is in list
mode we also take the dependencies of the parent (recursively) into
account, again after the dependencies of the categorizable itself.'''
def sortKeyFunction(task):
def sortedSubjects(items):
return sorted([item.subject(recursive=True) for item in items])
dependencies = task.dependencies()
sortedDependencySubjects = sortedSubjects(dependencies)
isListMode = not kwargs.get('treeMode', False)
childDependencies = task.dependencies(recursive=True, upwards=isListMode) - dependencies
sortedDependencySubjects.extend(sortedSubjects(childDependencies))
return sortedDependencySubjects
return sortKeyFunction
@classmethod
def dependenciesSortEventTypes(class_):
''' The event types that influence the dependencies sort order. '''
return (class_.dependenciesChangedEventType(),)
# behavior
def setShouldMarkCompletedWhenAllChildrenCompleted(self, newValue):
if newValue == self.__shouldMarkCompletedWhenAllChildrenCompleted:
return
self.__shouldMarkCompletedWhenAllChildrenCompleted = newValue
pub.sendMessage(self.shouldMarkCompletedWhenAllChildrenCompletedChangedEventType(),
newValue=newValue, sender=self)
pub.sendMessage(self.percentageCompleteChangedEventType(),
newValue=self.percentageComplete(), sender=self)
@classmethod
def shouldMarkCompletedWhenAllChildrenCompletedChangedEventType(class_):
return 'pubsub.task.shouldMarkCompletedWhenAllChildrenCompleted'
def shouldMarkCompletedWhenAllChildrenCompleted(self):
return self.__shouldMarkCompletedWhenAllChildrenCompleted
@classmethod
def suggestedPlannedStartDateTime(cls, now=date.Now):
return cls.suggestedDateTime('defaultplannedstartdatetime', now)
@classmethod
def suggestedActualStartDateTime(cls, now=date.Now):
return cls.suggestedDateTime('defaultactualstartdatetime', now)
@classmethod
def suggestedDueDateTime(cls, now=date.Now):
return cls.suggestedDateTime('defaultduedatetime', now)
@classmethod
def suggestedCompletionDateTime(cls, now=date.Now):
return cls.suggestedDateTime('defaultcompletiondatetime', now)
@classmethod
def suggestedReminderDateTime(cls, now=date.Now):
return cls.suggestedDateTime('defaultreminderdatetime', now)
@classmethod
def suggestedDateTime(cls, defaultDateTimeSetting, now=date.Now):
# pylint: disable=E1101,W0142
defaultDateTime = cls.settings.get('view', defaultDateTimeSetting)
dummy_prefix, defaultDate, defaultTime = defaultDateTime.split('_')
dateTime = now()
currentTime = dict(hour=dateTime.hour, minute=dateTime.minute,
second=dateTime.second, microsecond=dateTime.microsecond)
if defaultDate == 'tomorrow':
dateTime += date.ONE_DAY
elif defaultDate == 'dayaftertomorrow':
dateTime += (date.ONE_DAY + date.ONE_DAY)
elif defaultDate == 'nextfriday':
dateTime = (dateTime + date.ONE_DAY).endOfWorkWeek().replace(**currentTime)
elif defaultDate == 'nextmonday':
dateTime = (dateTime + date.ONE_WEEK).startOfWorkWeek().replace(**currentTime)
if defaultTime == 'startofday':
return dateTime.startOfDay()
elif defaultTime == 'startofworkingday':
startHour = cls.settings.getint('view', 'efforthourstart')
return dateTime.replace(hour=startHour, minute=0,
second=0, microsecond=0)
elif defaultTime == 'currenttime':
return dateTime
elif defaultTime == 'endofworkingday':
endHour = cls.settings.getint('view', 'efforthourend')
if endHour >= 24:
endHour, minute, second = 23, 59, 59
else:
minute, second = 0, 0
return dateTime.replace(hour=endHour, minute=minute,
second=second, microsecond=0)
elif defaultTime == 'endofday':
return dateTime.endOfDay()
@classmethod
def modificationEventTypes(class_):
eventTypes = super(Task, class_).modificationEventTypes()
return eventTypes + [class_.plannedStartDateTimeChangedEventType(),
class_.dueDateTimeChangedEventType(),
class_.actualStartDateTimeChangedEventType(),
class_.completionDateTimeChangedEventType(),
class_.effortsChangedEventType(),
class_.budgetChangedEventType(),
class_.percentageCompleteChangedEventType(),
class_.priorityChangedEventType(),
class_.hourlyFeeChangedEventType(),
class_.fixedFeeChangedEventType(),
class_.reminderChangedEventType(),
class_.recurrenceChangedEventType(),
class_.prerequisitesChangedEventType(),
class_.dependenciesChangedEventType(),
class_.shouldMarkCompletedWhenAllChildrenCompletedChangedEventType()]
|