U
ꥡcE+ @ s d Z ddlZddlZddlZddlZddlZddlZddlmZ ddl m
Z
ddl m Z m
Z
ddlmZ ddlZddlmZ dejZd ejZd
ejZed Z G d d
d
ej ej Z dd Z ddddZ!dd Z"dd Z#G dd de
Z$dd Z%dd Z&d d Z'd d Z(d d! Z)dS )"a
Altair Plot Sphinx Extension
============================
This extension provides a means of inserting live-rendered Altair plots within
sphinx documentation. There are two directives defined: ``altair-setup`` and
``altair-plot``. ``altair-setup`` code is used to set-up various options
prior to running the plot code. For example::
.. altair-plot::
:output: none
from altair import *
import pandas as pd
data = pd.DataFrame({'a': list('CCCDDDEEE'),
'b': [2, 7, 4, 1, 2, 6, 8, 4, 7]})
.. altair-plot::
Chart(data).mark_point().encode(
x='a',
y='b'
)
In the case of the ``altair-plot`` code, the *last statement* of the code-block
should contain the chart object you wish to be rendered.
Options
-------
The directives have the following options::
.. altair-plot::
:namespace: # specify a plotting namespace that is persistent within the doc
:hide-code: # if set, then hide the code and only show the plot
:code-below: # if set, then code is below rather than above the figure
:output: [plot|repr|stdout|none]
:alt: text # Alternate text when plot cannot be rendered
:links: editor source export # specify one or more of these options
:chart-var-name: chart # name of variable in namespace containing output
Additionally, this extension introduces a global configuration
``altairplot_links``, set in your ``conf.py`` which is a dictionary
of links that will appear below plots, unless the ``:links:`` option
again overrides it. It should look something like this::
# conf.py
# ...
altairplot_links = {'editor': True, 'source': True, 'export': True}
# ...
If this configuration is not specified, all are set to True.
N)nodes) Directive)flag unchanged)_)
eval_blockz$https://cdn.jsdelivr.net/npm/vega@{}z)https://cdn.jsdelivr.net/npm/vega-lite@{}z*https://cdn.jsdelivr.net/npm/vega-embed@{}a
c @ s e Zd ZdS ) altair_plotN)__name__
__module__ __qualname__ r r ?/tmp/pip-unpacked-wheel-y9_o96ar/altair/sphinxext/altairplot.pyr g s r c C s t |dsd S |j|i d S )N_altair_namespaces)hasattrr pop)appenvdocnamer r r
purge_altair_namespacesk s
r T)Zeditorsourceexportc s\ dkrdS t tt }|rJtdt| fddtD S )NnoneFz Following links are invalid: {}c s i | ]}|| kqS r r ).0linklinksr r
| s z"validate_links..) striplowersplitsetDEFAULT_ALTAIRPLOT_LINKSkeys
ValueErrorformatlist)r Zdiffr r r
validate_linkst s r& c C s | } | dkr td| S )N)plotreprstdoutr z4:output: flag must be one of [plot|repr|stdout|none])r r r# )outputr r r
validate_output s r+ c @ s, e Zd ZdZeeeeeeedZdd Z dS )AltairPlotDirectiveT) hide-code
code-below namespacer* altr chart-var-namec C s | j jjj}|j}d| jk}d| jk}t|ds6i |_| jdd}|j |j
i |i }d | j }|rt
||}d|d< | jjd } tj| }
tj| } |d
} | d d }
d
|
| }d|
| }t
jdd|gd}t }||d< ||d< ||d< ||d< tj|
|j|d< | |d< | j|d< | jd|j j j |d< | jdd|d< | jdd |d< d| jkr| jd |d< |g}|r||g7 }|r||g7 }|s||g7 }|S ) Nr- r. r r/ default
pythonlanguager altair-plot.-z{}-altair-plot-{}z{}-altair-source-{} )ids target_iddiv_idcoderelpath
rst_source
rst_linenor r* r' r1 r0 ) statedocumentsettingsr r optionsr r get
setdefaultr joincontentr
literal_blockZ
state_machineospathdirnamebasenameZ new_serialnoreplacer$ targetr r> srcdirlinenoZbuilderconfigaltairplot_links)selfr r show_codeZ
code_belowZ namespace_idr/ r= Zsource_literalr? Zrst_dirZ rst_filenameZserialnoZrst_baser< r; Z target_nodeZ plot_noderesultr r r
run s^
zAltairPlotDirective.runN)
r r
r Z has_contentr r r+ r& Z option_specrW r r r r
r, s
r, c C s |d }z8t }t| t|d |}W 5 Q R X | }W nN tk
r } z0td |d |d |j
j t | t
jW 5 d }~X Y nX |d }|d k r||krtd ||| }|d }|d krt
jn:|d
kr|st
jn t
||} d | d < || g n |d krd|d kr.t
jn4d
t|dd }
t
|
|
} d | d < || g n|dkrt|tjrz | } W n. tjjjk
r td |d Y nX |d }
tj |d t | ddt |
d}| j | ntd |d |d t
jd S )Nr/ r= z/altair-plot: {}:{} Code Execution failed:{}: {}r? r@ r1 z,chart-var-name='{}' not present in namespacer* r r) r5 r( z r3 z
r' zInvalid chart: {0}r r< z vega-liteZcanvas)r< specmodeZrendereractionszfaltair-plot: {}:{} Malformed block. Last line of code block should define a valid altair Chart object.)!ioStringIO
contextlibredirect_stdoutr getvalue Exceptionwarningswarnr$ __class__r strr SkipNoder# rI extendr( rN
isinstancer0 Z
TopLevelMixinZto_dictutilsZschemapiZSchemaValidationError VGL_TEMPLATErenderjsondumpsbodyappend)rT noder/ fZchartr) eZ
chart_namer* Zoutput_literalrepZ repr_literalrX rZ htmlr r r
html_visit_altair_plot sz
rt c C s> d|j kr$| jtd|d n| jtd tjd S )Nr0 z
[ graph: %s ]z [ graph ])
attributesrm rn r r re rT ro r r r
generic_visit_altair_plot% s
rw c C s d S Nr rv r r r
depart_altair_plot. s ry c C s. | | jj | | jj | | jj d S rx )Z add_js_filerR altairplot_vega_js_urlaltairplot_vegalite_js_urlaltairplot_vegaembed_js_urlr r r r
builder_inited2 s r~ c C s | t _| jt _| jt _| dtd | dtd | dtd | dtd | dt
| d | j t
ttfttfttfttfttfd | d
t | d t d d
iS )NrS r rz rs r{ r| r6 zaltair-plot.css)rs ZlatexZtexinfotextZmanz
env-purge-doczbuilder-initedversionz0.1)setupr rR ZconfdirZadd_config_valuer! VEGA_JS_URL_DEFAULTVEGALITE_JS_URL_DEFAULTVEGAEMBED_JS_URL_DEFAULTZ
add_directiver, Z add_css_fileadd_noder rt ry rw connectr r~ r} r r r
r 8 s0
r )*__doc__r] r[ rJ rk ra Zjinja2Zdocutilsr Zdocutils.parsers.rstr Z docutils.parsers.rst.directivesr r Z
sphinx.localer Zaltairr0 Zaltair.utils.execevalr r$ Z VEGA_VERSIONr ZVEGALITE_VERSIONr ZVEGAEMBED_VERSIONr Templateri ZGeneralElementr r r! r& r+ r, rt rw ry r~ r r r r r
sB 6 LS