Dynamic todo template #456

paopow · 2018-06-28T06:19:07Z

Add an option to specify todos to remove or skip from a todo list template based on computed conditional properties.

…cklist template

marcua · 2018-06-28T13:52:34Z

orchestra/models/core/models.py

@@ -592,6 +592,9 @@ class TodoListTemplate (TodoListTemplateMixin, BaseModel):
            if it is generated by the system.
        todos (str)
            A JSON blob that describe the todos in the todo list template.
+        conditional_property_function (str)
+            A JSON blob containing the path to and name of a python method
+            that will return the preconditions to prune the created todos


nitpick: period at end of sentence

marcua · 2018-06-28T13:56:29Z

orchestra/todos/api.py

-    todo.save()
-    for template_todo_item in template_todo.get('items', []):
-        _add_template_todo(template_todo_item, todolist_template, todo, task)
+def _to_exclude(props, conditions=[]):


https://stackoverflow.com/questions/5712904/empty-dictionary-as-default-value-for-keyword-argument-in-python-function-dicti :)

you can do this:

def _to_exclude(props, conditions=None): for condition in conditions or []:

alternatively, you already pass in [] below, so just make conditions required ;)

marcua · 2018-06-28T13:57:09Z

orchestra/todos/api.py

+            get_cond_props = locate(path)
+            cond_props = get_cond_props(task.project)
+        except Exception:
+            logger.exception('Invalid condition function path.')


condition->contional

marcua · 2018-06-28T14:00:06Z

orchestra/models/core/models.py

@@ -592,6 +592,9 @@ class TodoListTemplate (TodoListTemplateMixin, BaseModel):
            if it is generated by the system.
        todos (str)
            A JSON blob that describe the todos in the todo list template.
+        conditional_property_function (str)


explain the structure---is it a list of conditions that get ORed together, with properties in each dictionary getting ANDed, or the other way?

marcua · 2018-06-28T14:00:28Z

orchestra/todos/api.py

-    todo.save()
-    for template_todo_item in template_todo.get('items', []):
-        _add_template_todo(template_todo_item, todolist_template, todo, task)
+def _to_exclude(props, conditions=[]):


docstring to rehash this question above:

explain the structure---is it a list of conditions that get ORed together, with properties in each dictionary getting ANDed, or the other way?

marcua · 2018-06-28T14:00:56Z

orchestra/todos/api.py

+            current_value = props.get(prop)
+            compared_to_value = predicate['value']
+            if predicate['operator'] == '=':
+                return current_value == compared_to_value


since these return immediately, they only ever check the first property of the first condition. you probably want to keep a boolean around that you keep flipping depending on properties/conditions

Another way to implement string operators -> https://stackoverflow.com/questions/44554614/eval-string-cmp-operator

This might be useful if we intend to extend the available operators in future.

marcua

A few things

adbharadwaj

A small suggestion regarding the string operators and a comment on skip propagation.

adbharadwaj · 2018-06-28T15:01:43Z

orchestra/todos/api.py

+            current_value = props.get(prop)
+            compared_to_value = predicate['value']
+            if predicate['operator'] == '=':
+                return current_value == compared_to_value


Another way to implement string operators -> https://stackoverflow.com/questions/44554614/eval-string-cmp-operator

This might be useful if we intend to extend the available operators in future.

adbharadwaj · 2018-06-28T15:09:07Z

orchestra/todos/api.py

+            description=template_todo['description'],
+            template=todolist_template,
+            parent_todo=parent_todo,
+            skipped_datetime=skipped_datetime


To propogate skipping from parents to descendents.

skipped_datetime = timezone.now() if parent_todo.skipped_datetime or to_skip else None

We may even want to skip evaluation of to_skip if parent_todo.skipped_datetime is not Null. That may save considerable computation time.

coveralls · 2018-06-29T14:42:28Z

Coverage increased (+0.04%) to 93.801% when pulling 4e2ccb1 on dynamic_todo_template into 5eadce1 on master.

marcua · 2018-06-29T15:54:30Z

orchestra/todos/api.py

+def _to_exclude(props, conditions):
+    """
+    The conditions is it a list of conditions that get ORed together,
+    with properties in each dictionary getting ANDed.


with predicates in each dictionary

marcua · 2018-06-29T15:55:12Z

orchestra/todos/api.py

    for condition in conditions:
+        all_props_true = True


are we fine with a zero-item list of properties evaluating to true? could do all_props_true = True and len(all_props_true) > 0

… long text

marcua · 2018-06-29T18:38:04Z

orchestra/todos/api.py

    """
    any_condition_true = False

    for condition in conditions:
-        all_props_true = True
+        all_props_true = len(condition) > 0


len(conditions) :P

This is for detecting {} (a condition). if len(conditions) == 0, this line wouldn't get executed.

marcua · 2018-06-29T18:39:51Z

orchestra/todos/api.py

-        template=todolist_template
-    )
-    root_todo.save()
+    with transaction.atomic():


you could wrap the entire function in @transaction.atomic and then you don't have to indent everything :)

marcua · 2018-06-29T18:41:14Z

orchestra/json_schemas/todos.py

+        value (number, bool, sring, or None):
+            The value to compare with of the predicate.
+    """
+    operator = jsl.StringField(required=True, pattern='[!=><]=|[><]')


[!=><]=|[><] looks like a serious Kirby battle

marcua

[!=><]=|[><]

This reverts commit bc7c00c.

ksiangliulue@gmail.com added 4 commits June 27, 2018 14:21

Add a mechanism to filter out some todos when adding todos from a che…

6cebca3

…cklist template

Minor syntax fixes

b879947

Pass the project to the conditional properties function

5db1ca3

Add a migration file

6a99cac

paopow requested review from marcua and adbharadwaj June 28, 2018 06:19

marcua reviewed Jun 28, 2018

View reviewed changes

marcua requested changes Jun 28, 2018

View reviewed changes

adbharadwaj reviewed Jun 28, 2018

View reviewed changes

ksiangliulue@gmail.com added 2 commits June 28, 2018 19:14

Update text

3975d95

Propagate skipped_datetime to children of skipped parants

75c453b

ksiangliulue@gmail.com added 5 commits June 29, 2018 10:44

Use the operator module for comparison

a186ac9

Expand the regex operator description

1ac96f1

Implement detecting or and and logics

903599d

Add doc comment

45fd81c

Lint

b43b53d

marcua reviewed Jun 29, 2018

View reviewed changes

ksiangliulue@gmail.com added 5 commits June 29, 2018 13:20

Update documentation

d717189

Check for an empty condition

520e6f3

Change the field type of the description field of Todo to accommodate…

90974a6

… long text

Make adding todos from a template atomic

f876b68

Add a migration

67cbbdd

marcua reviewed Jun 29, 2018

View reviewed changes

Use the atomic decorator

4e2ccb1

marcua approved these changes Jun 29, 2018

View reviewed changes

paopow merged commit bc7c00c into master Jun 29, 2018

paopow deleted the dynamic_todo_template branch June 29, 2018 19:00

paopow restored the dynamic_todo_template branch June 29, 2018 19:27

paopow added a commit that referenced this pull request Jun 29, 2018

Revert "Dynamic todo template (#456)"

cd807a0

This reverts commit bc7c00c.

paopow mentioned this pull request Jun 29, 2018

Revert "Dynamic todo template" #457

Merged

paopow added a commit that referenced this pull request Jun 29, 2018

Revert "Dynamic todo template (#456)" (#457)

3ce65b3

This reverts commit bc7c00c.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dynamic todo template #456

Dynamic todo template #456

paopow commented Jun 28, 2018

marcua Jun 28, 2018

marcua Jun 28, 2018 •

edited

marcua Jun 28, 2018

marcua Jun 28, 2018

marcua Jun 28, 2018

marcua Jun 28, 2018

marcua Jun 28, 2018

adbharadwaj Jun 28, 2018

marcua left a comment

adbharadwaj left a comment

adbharadwaj Jun 28, 2018

adbharadwaj Jun 28, 2018

coveralls commented Jun 29, 2018 •

edited

marcua Jun 29, 2018

marcua Jun 29, 2018

marcua Jun 29, 2018

paopow Jun 29, 2018 •

edited

marcua Jun 29, 2018 •

edited

marcua Jun 29, 2018

marcua left a comment

Dynamic todo template #456

Dynamic todo template #456

Conversation

paopow commented Jun 28, 2018

Choose a reason for hiding this comment

marcua Jun 28, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcua left a comment

Choose a reason for hiding this comment

adbharadwaj left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Jun 29, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paopow Jun 29, 2018 • edited

Choose a reason for hiding this comment

marcua Jun 29, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcua left a comment

Choose a reason for hiding this comment

marcua Jun 28, 2018 •

edited

coveralls commented Jun 29, 2018 •

edited

paopow Jun 29, 2018 •

edited

marcua Jun 29, 2018 •

edited