Workflow macro could use name/label attribute in place of action names

[Ryan J Ollos]

It could be nice to use the action name/label (#11828) attribute in place of the action name when rendering the workflow graph. The tags/trac-1.0.2/contrib/workflow/opensource-workflow.ini​ demonstrates that the action names are often not visually appealing and don't represent what the user sees:

The following patch should work well on the trunk after #11828:

trac/ticket/default_workflow.py

@@ -533 +533 @@
             [state for action in actions.itervalues()
                    for state in action['oldstates']] +
             [action['newstate'] for action in actions.itervalues()]))
+        action_labels = [attrs['label']
+                         for name, attrs in actions.items()]
         action_names = actions.keys()
         edges = []
         for name, action in actions.items():
@@ -545 +547 @@
         args = args or {}
         width = args.get('width', 800)
         height = args.get('height', 600)
-        graph = {'nodes': states, 'actions': action_names, 'edges': edges,
+        graph = {'nodes': states, 'actions': action_labels, 'edges': edges,
                  'width': width, 'height': height}
         graph_id = '%012x' % id(graph)
         req = formatter.req

On 1.0-stable the patch differs slightly:

trac/ticket/default_workflow.py

@@ -496 +496 @@
             [state for action in actions.itervalues()
                    for state in action['oldstates']] +
             [action['newstate'] for action in actions.itervalues()]))
+        action_labels = [attrs.get('name', name)
+                         for name, attrs in actions.items()]
         action_names = actions.keys()
         edges = []
         for name, action in actions.items():
@@ -508 +510 @@
         args = args or {}
         width = args.get('width', 800)
         height = args.get('height', 600)
-        graph = {'nodes': states, 'actions': action_names, 'edges': edges,
+        graph = {'nodes': states, 'actions': action_labels, 'edges': edges,
                  'width': width, 'height': height}
         graph_id = '%012x' % id(graph)
         req = formatter.req

[Ryan J Ollos]

Committed to 1.0-stable in [13507]. Merged to trunk in [13508:13509].

[Jun Omae]

I have a question about the changes. Do actions.keys(), actions.values() and actions.items() always iterate its entries in the same order?

[Ryan J Ollos]

I would be surprised if all three methods do not always iterate in the order that the dictionary items are stored in memory, but I do not have a reference to prove that is the case.

Even prior to the changes the code has assumed that keys and items are iterating the entries in the same order: tags/trac-1.0.2/trac/ticket/default_workflow.py@:481,483,485#L465​.

[Peter Suter]

From ​Python docs:

If items(), keys(), values(), iteritems(), iterkeys(), and itervalues() are called with no intervening modifications to the dictionary, the lists will directly correspond.

Is this not sufficient?

[Jun Omae]

From ​Python docs:

If items(), keys(), values(), iteritems(), iterkeys(), and itervalues() are called with no intervening modifications to the dictionary, the lists will directly correspond.

Is this not sufficient?

Thanks for the information. I understand the changes have no issues. Sorry for the noise.