Spaces:
No application file
No application file
File size: 4,175 Bytes
ba8d952 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
import os
from typing import Dict
from ...utils.mimebundle import spec_to_mimebundle
from ..display import (
Displayable,
default_renderer_base,
json_renderer_base,
RendererRegistry,
HTMLRenderer,
DefaultRendererReturnType,
)
from .schema import SCHEMA_VERSION
from typing import Final
VEGALITE_VERSION: Final = SCHEMA_VERSION.lstrip("v")
VEGA_VERSION: Final = "5"
VEGAEMBED_VERSION: Final = "6"
# ==============================================================================
# VegaLite v5 renderer logic
# ==============================================================================
# The MIME type for Vega-Lite 5.x releases.
VEGALITE_MIME_TYPE: Final = "application/vnd.vegalite.v5+json"
# The MIME type for Vega 5.x releases.
VEGA_MIME_TYPE: Final = "application/vnd.vega.v5+json"
# The entry point group that can be used by other packages to declare other
# renderers that will be auto-detected. Explicit registration is also
# allowed by the PluginRegistery API.
ENTRY_POINT_GROUP: Final = "altair.vegalite.v5.renderer"
# The display message when rendering fails
DEFAULT_DISPLAY: Final = f"""\
<VegaLite {VEGALITE_VERSION.split('.')[0]} object>
If you see this message, it means the renderer has not been properly enabled
for the frontend that you are using. For more information, see
https://altair-viz.github.io/user_guide/display_frontends.html#troubleshooting
"""
renderers = RendererRegistry(entry_point_group=ENTRY_POINT_GROUP)
here = os.path.dirname(os.path.realpath(__file__))
def mimetype_renderer(spec: dict, **metadata) -> DefaultRendererReturnType:
return default_renderer_base(spec, VEGALITE_MIME_TYPE, DEFAULT_DISPLAY, **metadata)
def json_renderer(spec: dict, **metadata) -> DefaultRendererReturnType:
return json_renderer_base(spec, DEFAULT_DISPLAY, **metadata)
def png_renderer(spec: dict, **metadata) -> Dict[str, bytes]:
# To get proper return value type, would need to write complex
# overload signatures for spec_to_mimebundle based on `format`
return spec_to_mimebundle( # type: ignore[return-value]
spec,
format="png",
mode="vega-lite",
vega_version=VEGA_VERSION,
vegaembed_version=VEGAEMBED_VERSION,
vegalite_version=VEGALITE_VERSION,
**metadata,
)
def svg_renderer(spec: dict, **metadata) -> Dict[str, str]:
# To get proper return value type, would need to write complex
# overload signatures for spec_to_mimebundle based on `format`
return spec_to_mimebundle( # type: ignore[return-value]
spec,
format="svg",
mode="vega-lite",
vega_version=VEGA_VERSION,
vegaembed_version=VEGAEMBED_VERSION,
vegalite_version=VEGALITE_VERSION,
**metadata,
)
html_renderer = HTMLRenderer(
mode="vega-lite",
template="universal",
vega_version=VEGA_VERSION,
vegaembed_version=VEGAEMBED_VERSION,
vegalite_version=VEGALITE_VERSION,
)
renderers.register("default", html_renderer)
renderers.register("html", html_renderer)
renderers.register("colab", html_renderer)
renderers.register("kaggle", html_renderer)
renderers.register("zeppelin", html_renderer)
renderers.register("mimetype", mimetype_renderer)
renderers.register("jupyterlab", mimetype_renderer)
renderers.register("nteract", mimetype_renderer)
renderers.register("json", json_renderer)
renderers.register("png", png_renderer)
renderers.register("svg", svg_renderer)
renderers.enable("default")
class VegaLite(Displayable):
"""An IPython/Jupyter display class for rendering VegaLite 5."""
renderers = renderers
schema_path = (__name__, "schema/vega-lite-schema.json")
def vegalite(spec: dict, validate: bool = True) -> None:
"""Render and optionally validate a VegaLite 5 spec.
This will use the currently enabled renderer to render the spec.
Parameters
==========
spec: dict
A fully compliant VegaLite 5 spec, with the data portion fully processed.
validate: bool
Should the spec be validated against the VegaLite 5 schema?
"""
from IPython.display import display
display(VegaLite(spec, validate=validate))
|