- `frames` are now integrated into GRAPH_REFERENCE and figure validation.

if class_name in ['Figure', 'Data', 'Frames']:

self.data = Data(_parent=self, _parent_key='data')

class Frames(PlotlyList):

"""

_name = 'frames'

def _value_to_graph_object(self, index, value, _raise=True):

if isinstance(value, six.string_types):

return value

return super(Frames, self)._value_to_graph_object(index, value,

_raise=_raise)

def to_string(self, level=0, indent=4, eol='\n',

pretty=True, max_chars=80):

"""Get formatted string by calling `to_string` on children items."""

if not len(self):

return "{name}()".format(name=self._get_class_name())

string = "{name}([{eol}{indent}".format(

name=self._get_class_name(),

eol=eol,

indent=' ' * indent * (level + 1))

for index, entry in enumerate(self):

if isinstance(entry, six.string_types):

string += repr(entry)

else:

string += entry.to_string(level=level+1,

indent=indent,

eol=eol,

pretty=pretty,

max_chars=max_chars)

if index < len(self) - 1:

string += ",{eol}{indent}".format(

eol=eol,

indent=' ' * indent * (level + 1))

string += (

"{eol}{indent}])").format(eol=eol, indent=' ' * indent * level)

return string

items_classes = set()

for item in items:

if item in graph_reference.OBJECT_NAME_TO_CLASS_NAME:

items_classes.add(graph_reference.string_to_class_name(item))

else:

# There are no lists objects which can contain list entries.

items_classes.add('dict')

items_classes = list(items_classes)

'Frames': {'object_name': 'frames', 'base_type': list},

graph_reference = utils.decode_unicode(_json.loads(s))

# TODO: Patch in frames info until it hits streambed. See #659

graph_reference['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"

},

"role": "object",

"traces": {

"description": "A list of trace indices that identify "

"the respective traces in the data "

"attribute",

"role": "info",

"valType": "info_array"

}

}

},

"role": "object"

}

return graph_reference

# Map frame 'data' and 'layout' to previously-defined figure attributes.

# Examples of parent_object_names changes:

# ['figure', 'frames'] --> ['figure', 'frames']

# ['figure', 'frames', FRAME_NAME] --> ['figure']

# ['figure', 'frames', FRAME_NAME, 'data'] --> ['figure', 'data']

# ['figure', 'frames', FRAME_NAME, 'layout'] --> ['figure', 'layout']

# ['figure', 'frames', FRAME_NAME, 'foo'] -->

# ['figure', 'frames', FRAME_NAME, 'foo']

# [FRAME_NAME, 'layout'] --> ['figure', 'layout']

if FRAME_NAME in parent_object_names:

len_parent_object_names = len(parent_object_names)

index = parent_object_names.index(FRAME_NAME)

if len_parent_object_names == index + 1:

if object_name in ('data', 'layout'):

parent_object_names = ['figure', object_name]

elif len_parent_object_names > index + 1:

if parent_object_names[index + 1] in ('data', 'layout'):

parent_object_names = (

['figure'] + list(parent_object_names)[index + 1:]

)

figure_attributes = {

'layout': {'role': 'object'},

'data': {'role': 'object', '_isLinkedToArray': True},

'frames': {'role': 'object', '_isLinkedToArray': True}

}

FRAME_NAME = list(GRAPH_REFERENCE['frames']['items'].keys())[0]

"description": "Sets the end contour level value. Must be more than `contours.start`",

"description": "Sets the step between each contour level. Must be positive.",

"min": 0,

"description": "Sets the starting contour level value. Must be less than `contours.end`",

"description": "Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is *true* or if `contours.size` is missing.",

"dflt": 15,

"min": 1,

"description": "Sets the end contour level value. Must be more than `contours.start`",

"description": "Sets the step between each contour level. Must be positive.",

"min": 0,

"description": "Sets the starting contour level value. Must be less than `contours.end`",

"description": "Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is *true* or if `contours.size` is missing.",

"dflt": 15,

"min": 1,

from __future__ import absolute_import

from unittest import TestCase

from plotly import exceptions

from plotly.graph_objs import Figure

class FigureTest(TestCase):

def test_instantiation(self):

native_figure = {

'data': [],

'layout': {},

'frames': []

}

Figure(native_figure)

Figure()

def test_access_top_level(self):

# Figure is special, we define top-level objects that always exist.

self.assertEqual(Figure().data, [])

self.assertEqual(Figure().layout, {})

self.assertEqual(Figure().frames, [])

def test_nested_frames(self):

with self.assertRaisesRegexp(exceptions.PlotlyDictKeyError, 'frames'):

Figure({'frames': [{'frames': []}]})

figure = Figure()

figure.frames = [{}]

with self.assertRaisesRegexp(exceptions.PlotlyDictKeyError, 'frames'):

figure.frames[0].frames = []