Skip to content

Added plotly_intercept_code configuration option #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added plotly_intercept_code configuration option #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion sphinx_plotly_directive/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,12 @@

plotly_template
Provide a customized template for preparing restructured text.

plotly_intercept_code
A function accepting one argument (the current code block being
processed), returning a modified code. This can be used to extract the
figure object from custom data classes in order for them to be
intercepted and rendered by this extension.
"""

import copy
Expand Down Expand Up @@ -300,6 +306,7 @@ def setup(app):
app.add_config_value("plotly_iframe_width", "100%", True)
app.add_config_value("plotly_iframe_height", "500px", True)
app.add_config_value("plotly_template", None, True)
app.add_config_value("plotly_intercept_code", None, True)

app.add_config_value("plotly_include_directive_source", None, False)

Expand Down Expand Up @@ -533,6 +540,13 @@ def run_code(code, code_path, ns=None, function_name=None, fig_vars=None):
ns["__name__"] = "__main__"

variable_name = "fig"
intercept_code = setup.config.plotly_intercept_code
if intercept_code is None:
intercept_code = lambda x: x
elif not callable(intercept_code):
raise TypeError("`plotly_intercept_code` must be a function "
"accepting one argument (the current code block being "
"processed), returning a modified code.")

if ends_with_show(code):
exec(strip_last_line(code), ns)
Expand All @@ -545,7 +559,8 @@ def run_code(code, code_path, ns=None, function_name=None, fig_vars=None):
exec(code, ns)
figs = [ns[fig_var] for fig_var in fig_vars]
else:
exec(assign_last_line_into_variable(code, variable_name), ns)
exec(assign_last_line_into_variable(
intercept_code(code), variable_name), ns)
figs = [ns[variable_name]]

except (Exception, SystemExit) as err:
Expand Down