from typing import Optional
import json
from validator_collection import validators, checkers
from highcharts_core import errors
from highcharts_core.options.series.base import SeriesBase
from highcharts_core.options.series.arcdiagram import ArcDiagramSeries
from highcharts_core.options.series.area import AreaSeries
from highcharts_core.options.series.area import AreaRangeSeries
from highcharts_core.options.series.area import AreaSplineSeries
from highcharts_core.options.series.area import AreaSplineRangeSeries
from highcharts_core.options.series.area import LineSeries
from highcharts_core.options.series.area import StreamGraphSeries
from highcharts_core.options.series.bar import BarSeries
from highcharts_core.options.series.bar import ColumnSeries
from highcharts_core.options.series.bar import ColumnPyramidSeries
from highcharts_core.options.series.bar import ColumnRangeSeries
from highcharts_core.options.series.bar import CylinderSeries
from highcharts_core.options.series.bar import VariwideSeries
from highcharts_core.options.series.bar import WaterfallSeries
from highcharts_core.options.series.bar import WindBarbSeries
from highcharts_core.options.series.bar import XRangeSeries
from highcharts_core.options.series.bellcurve import BellCurveSeries
from highcharts_core.options.series.boxplot import BoxPlotSeries
from highcharts_core.options.series.boxplot import ErrorBarSeries
from highcharts_core.options.series.bubble import BubbleSeries
from highcharts_core.options.series.bullet import BulletSeries
from highcharts_core.options.series.dependencywheel import DependencyWheelSeries
from highcharts_core.options.series.dumbbell import DumbbellSeries
from highcharts_core.options.series.dumbbell import LollipopSeries
from highcharts_core.options.series.funnel import FunnelSeries
from highcharts_core.options.series.funnel import Funnel3DSeries
from highcharts_core.options.series.gauge import GaugeSeries
from highcharts_core.options.series.gauge import SolidGaugeSeries
from highcharts_core.options.series.heatmap import HeatmapSeries
from highcharts_core.options.series.heatmap import TilemapSeries
from highcharts_core.options.series.histogram import HistogramSeries
from highcharts_core.options.series.item import ItemSeries
from highcharts_core.options.series.networkgraph import NetworkGraphSeries
from highcharts_core.options.series.organization import OrganizationSeries
from highcharts_core.options.series.packedbubble import PackedBubbleSeries
from highcharts_core.options.series.pareto import ParetoSeries
from highcharts_core.options.series.pie import PieSeries
from highcharts_core.options.series.pie import VariablePieSeries
from highcharts_core.options.series.polygon import PolygonSeries
from highcharts_core.options.series.pyramid import PyramidSeries
from highcharts_core.options.series.pyramid import Pyramid3DSeries
from highcharts_core.options.series.sankey import SankeySeries
from highcharts_core.options.series.scatter import ScatterSeries
from highcharts_core.options.series.scatter import Scatter3DSeries
from highcharts_core.options.series.spline import SplineSeries
from highcharts_core.options.series.sunburst import SunburstSeries
from highcharts_core.options.series.timeline import TimelineSeries
from highcharts_core.options.series.treemap import TreemapSeries
from highcharts_core.options.series.vector import VectorSeries
from highcharts_core.options.series.venn import VennSeries
from highcharts_core.options.series.wordcloud import WordcloudSeries
SERIES_CLASSES = {
'arcdiagram': ArcDiagramSeries,
'area': AreaSeries,
'arearange': AreaRangeSeries,
'areaspline': AreaSplineSeries,
'areasplinerange': AreaSplineRangeSeries,
'line': LineSeries,
'streamgraph': StreamGraphSeries,
'bar': BarSeries,
'column': ColumnSeries,
'columnpyramid': ColumnPyramidSeries,
'columnrange': ColumnRangeSeries,
'cylinder': CylinderSeries,
'variwide': VariwideSeries,
'waterfall': WaterfallSeries,
'windbarb': WindBarbSeries,
'xrange': XRangeSeries,
'bellcurve': BellCurveSeries,
'boxplot': BoxPlotSeries,
'errorbar': ErrorBarSeries,
'bubble': BubbleSeries,
'bullet': BulletSeries,
'dependencywheel': DependencyWheelSeries,
'dumbbell': DumbbellSeries,
'lollipop': LollipopSeries,
'funnel': FunnelSeries,
'funnel3d': Funnel3DSeries,
'gauge': GaugeSeries,
'solidgauge': SolidGaugeSeries,
'heatmap': HeatmapSeries,
'tilemap': TilemapSeries,
'histogram': HistogramSeries,
'item': ItemSeries,
'networkgraph': NetworkGraphSeries,
'organization': OrganizationSeries,
'packedbubble': PackedBubbleSeries,
'pareto': ParetoSeries,
'pie': PieSeries,
'variablepie': VariablePieSeries,
'polygon': PolygonSeries,
'pyramid': PyramidSeries,
'pyramid3d': Pyramid3DSeries,
'sankey': SankeySeries,
'scatter': ScatterSeries,
'scatter3d': Scatter3DSeries,
'spline': SplineSeries,
'sunburst': SunburstSeries,
'timeline': TimelineSeries,
'treemap': TreemapSeries,
'vector': VectorSeries,
'venn': VennSeries,
'wordcloud': WordcloudSeries,
}
[docs]def create_series_obj(value, default_type = None) -> Optional[SeriesBase]:
"""Create an instance descended from :class:`SeriesBase`.
:param value: The input that should be de-serialized to a :class:`SeriesBase`
instance. Expected to be either a :class:`SeriesBase` instance, a
:class:`dict <python:dict>`, or a JSON :class:`str <python:str>`
:param default_type: The default series type to apply if not specified in
``value``. Defaults to :obj:`None <python:None>`
:type default_type: :class:`str <python:str>` or :obj:`None <python:None>`
:returns: A :class:`SeriesBase` (descendant) instance
:rtype: :class:`SeriesBase` or :obj:`None <python:None>`
"""
if not value:
return None
if isinstance(value, SeriesBase):
return value
if isinstance(value, dict):
type_ = value.get('type', default_type)
if not type_:
raise errors.HighchartsValueError('To instantiate a Series, the "type" must '
'be provided. No "type" key was found.')
cls = SERIES_CLASSES.get(type_, default_type)
if not cls:
raise errors.HighchartsValueError(f'create_series_obj expects a value with '
f'a recognized "type". However, received a '
f'"type" value that was not recognized: '
f'{type_}')
instance = cls.from_dict(value)
elif isinstance(value, str):
try:
preliminary = SeriesBase.from_js_literal(value)
type_ = preliminary.type
except errors.HighchartsParseError:
preliminary_as_dict = json.loads(value)
type_ = preliminary_as_dict.get('type', default_type)
if not type_:
raise errors.HighchartsValueError('To instantiate a Series, the "type" must '
'be provided. No "type" key was found.')
cls = SERIES_CLASSES.get(type_, default_type)
if not cls:
raise errors.HighchartsValueError(f'create_series_obj expects a value with '
f'a recognized "type". However, received a '
f'"type" value that was not recognized: '
f'{type_}')
try:
instance = cls.from_js_literal(value)
except errors.HighchartsParseError:
instance = cls.from_json(value)
else:
raise errors.HighchartsValueError(f'create_series_obj expects a value whose '
f'type is a SeriesBase or coercable to it, '
f'but received: {value.__class__.__name__}')
return instance