Improve `frames` support in graph_objs.py. #656

theengineear · 2017-01-09T21:02:31Z

This does the following:

Allow object-or-string in frames array
Refuse frames in frame object if nested
Map frame entry data and layout objects to figure attribute information.
Tests this functionality

Fixes #604

theengineear · 2017-01-09T21:05:53Z

@Kully and I hacked in frames support when we were in a rush. This improves how frames is integrated into the Figure object. Since frames is basically considered an array of Figure objects.

Still working on this one, since I think saying that an entry in a Frames array is a Figure is misleading, imo...

theengineear · 2017-01-09T22:33:52Z

Can't add Frame since it conflicts with animation.frame and the name doesn't matter since we're not exposing it :). I chose frame_entry, which does not become a public class because there's no need to patch the object. Note how it ends up as dict( .. ) in the to_string() call.

theengineear · 2017-01-09T22:34:37Z

plotly/graph_objs/graph_objs.py

+
+    def _value_to_graph_object(self, index, value, _raise=True):
+        if isinstance(value, six.string_types):
+            return value


This is a patch to allow a string in the frames array.

theengineear · 2017-01-09T22:35:13Z

plotly/graph_objs/graph_objs.py

+            indent=' ' * indent * (level + 1))
+        for index, entry in enumerate(self):
+            if isinstance(entry, six.string_types):
+                string += repr(entry)


Another patch to allow a string in the frames array. This sorta sucks since it's not possible to super... but I'm not terribly concerned.

theengineear · 2017-01-09T22:36:16Z

plotly/graph_objs/graph_objs_tools.py

+        else:
+            # There are no lists objects which can contain list entries.
+            items_classes.add('dict')
+    items_classes = list(items_classes)


This allows us to print dict in a list's to_string() return if the item isn't a publicly-available class.

theengineear · 2017-01-09T22:47:01Z

plotly/graph_reference.py

+        'group': {'role': 'info'},
+        'layout': {'role': 'object'},
+        'name': {'role': 'info'}
+    }


@etpinard or @rreusser Is this information available anywhere? I don't really want to hard-code these. If it's not available, mind helping me to flesh out this list of valid attributes for a figure.frames[*] entry?

Unfortunately there's not a dedicated doc page since this doesn't currently live on the plot scheme. In lieu of that, the attributes are defined here. @etpinard is there some way I can add these to the plot schema? The way animation config and frame attributes live outside of the rest of plotly is not the best.

Awesome! That'll do for now!

Those are now part of the plot schema:

oh damn boom!

@etpinard , trying to grok datasrc, that one's a little confusing for me. How do you src an array of objects?

Also, traces are meant to be stored in a Grid? I.e., it's definitely not info, right? (just to confirm).

Oh datasrc shouldn't be in there. Same for tracessrc.

theengineear · 2017-01-11T01:36:48Z

@etpinard , OK, this would work well from the Python side of things for the frames object:

    "frames": {
        "items": {
            "frames_entry": {
                "baseframe": {
                    "description": "The name of the frame into which this frame's properties are merged before applying. This is used to unify properties and avoid needing to specify the same values for the same properties in multiple frames.",
                    "role": "info",
                    "valType": "string"
                },
                "data": {
                    "description": "A list of traces this frame modifies. The format is identical to the normal trace definition.",
                    "role": "object",
                    "valType": "any"
                },
                "group": {
                    "description": "An identifier that specifies the group to which the frame belongs, used by animate to select a subset of frames.",
                    "role": "info",
                    "valType": "string"
                },
                "layout": {
                    "role": "object",
                    "description": "Layout properties which this frame modifies. The format is identical to the normal layout definition.",
                    "valType": "any"
                },
                "name": {
                    "description": "A label by which to identify the frame",
                    "role": "info",
                    "valType": "string"
                },
                "traces": {
                    "description": "A list of trace indices that identify the respective traces in the data attribute",
                    "role": "info",
                    "valType": "info_array"
                },
                "role": "object"
            }
        },
        "role": "object"
    },

The name frames_entry is up for discussion but it would greatly help me if it's unique in the plot-schema, fwiw... i.e., not frame. This is because it's tricky to map data and layout attrs properly inside frames_entry objects.

Note that FrameEntry will not be a name that is exposed to users in the Python API, it's merely helpful for mapping attrs.

theengineear · 2017-01-11T01:42:56Z

OK, I "updated" the default schema with what I'd like to be in there. Obviously not ready to merge since this isn't a real reflection of the plot-schema, I just figured It'd be helpful.

theengineear · 2017-01-11T01:48:52Z

Oh right, we have a test on the schema anyhow so I can't merge it 😊

etpinard · 2017-01-11T15:31:31Z

@theengineear done (I think) in plotly/plotly.js#1292

This does the following: * Allow object-or-string in frames array * Refuse `frames` in frame object if nested * Generates a non-public `FramesEntry` graph obj * Tests this functionality

theengineear · 2017-01-11T19:29:59Z

plotly/graph_reference.py

+    graph_reference = utils.decode_unicode(_json.loads(s))
+
+    # TODO: Patch in frames info until it hits streambed. See #659
+    graph_reference['frames'] = {


Just patching in what I'm expecting to see here. This means that we don't need to wait for any changes to land on Plotly prod and can get this into 1.X now. I'll remove this once that changes.

theengineear · 2017-01-11T19:58:26Z

@Kully, this look OK to you? Mind giving it a review?

Kully · 2017-01-11T20:32:00Z

@Kully, this look OK to you? Mind giving it a review?

Yeah, will do today.

Kully · 2017-01-11T21:15:35Z

Yeah, will do today.

@theengineear 💃 Looks like a lot of work you had to do! 😅

theengineear · 2017-01-11T21:38:25Z

Yah, the fact that you can have data and layout inside the frame was tricky. We could have just fixed this in plot-schema, but that would have taken a whole lot more work I think.

theengineear · 2017-01-11T22:21:25Z

Cool, I'm able to play around and make frames and such using the python api lib still. Gonna update changelog and merge.

theengineear force-pushed the frames-support branch from 851b21a to 8a3124f Compare January 9, 2017 22:31

theengineear commented Jan 9, 2017

View reviewed changes

theengineear force-pushed the frames-support branch from 8a3124f to 2bb8a58 Compare January 9, 2017 22:43

theengineear commented Jan 9, 2017

View reviewed changes

theengineear force-pushed the frames-support branch from 2bb8a58 to a750909 Compare January 11, 2017 01:41

theengineear force-pushed the frames-support branch from a750909 to 61fc0e3 Compare January 11, 2017 01:44

etpinard mentioned this pull request Jan 11, 2017

Frames plotschema for plotly.py v2 plotly/plotly.js#1292

Merged

Improve frames support in graph_objs.py.

887d839

This does the following: * Allow object-or-string in frames array * Refuse `frames` in frame object if nested * Generates a non-public `FramesEntry` graph obj * Tests this functionality

theengineear force-pushed the frames-support branch from 61fc0e3 to 887d839 Compare January 11, 2017 19:28

theengineear commented Jan 11, 2017

View reviewed changes

Update some changes to default schema.

2c6a50f

Remove a useless test.

08b13ef

Update CHANGELOG.

0f4fb0e

theengineear merged commit fa89dcc into master Jan 11, 2017

theengineear deleted the frames-support branch January 11, 2017 22:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve `frames` support in graph_objs.py. #656

Improve `frames` support in graph_objs.py. #656

theengineear commented Jan 9, 2017 •

edited

theengineear commented Jan 9, 2017

theengineear commented Jan 9, 2017

theengineear Jan 9, 2017

theengineear Jan 9, 2017

theengineear Jan 9, 2017

theengineear Jan 9, 2017

rreusser Jan 9, 2017 •

edited

theengineear Jan 9, 2017

etpinard Jan 10, 2017

theengineear Jan 10, 2017

theengineear Jan 10, 2017

etpinard Jan 10, 2017

theengineear commented Jan 11, 2017

theengineear commented Jan 11, 2017

theengineear commented Jan 11, 2017

etpinard commented Jan 11, 2017

theengineear Jan 11, 2017

theengineear commented Jan 11, 2017

Kully commented Jan 11, 2017

Kully commented Jan 11, 2017

theengineear commented Jan 11, 2017

theengineear commented Jan 11, 2017

Improve frames support in graph_objs.py. #656

Improve frames support in graph_objs.py. #656

Conversation

theengineear commented Jan 9, 2017 • edited

theengineear commented Jan 9, 2017

theengineear commented Jan 9, 2017

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

rreusser Jan 9, 2017 • 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

theengineear commented Jan 11, 2017

theengineear commented Jan 11, 2017

theengineear commented Jan 11, 2017

etpinard commented Jan 11, 2017

Choose a reason for hiding this comment

theengineear commented Jan 11, 2017

Kully commented Jan 11, 2017

Kully commented Jan 11, 2017

theengineear commented Jan 11, 2017

theengineear commented Jan 11, 2017

Improve `frames` support in graph_objs.py. #656

Improve `frames` support in graph_objs.py. #656

theengineear commented Jan 9, 2017 •

edited

rreusser Jan 9, 2017 •

edited