jprdonnelly/pyscript
1
0
Fork 0
mirror of https://github.com/pyscript/pyscript.git synced 2026-03-25 14:01:47 -04:00
Code Issues Projects Releases Wiki Activity

examples inspector plugin (#1040)

Browse Source 
* replace unnecessary elements from hello_world example and replace with py-tutor tag

* add py_tutor plugin

* port altair example

* add code for more granular tutor mode

* add support for including modules source in pytutor

* remove js dependencies in hello_world

* put antigravity on a diet ;)

* use py-tutor on antigravity example

* use py-tutor on d3 example

* use py-tutor on bokeh example

* use py-tutor on bokeh_interactive example

* fix issue when module_paths is undefined

* remove prism js dependency leftovers

* ooops, really remove prism js dependency leftovers

* port follium example to pytutor

* port pymarkdown and matplotlib example to pytutor

* port message_passing and numpy_convas_fractals examples to pytutor

* port the panel complex  examples to pytutor

* port the panel complex  examples to pytutor

* port last examples to py-tutor

* remove prism

* remore most debugging logs and replace log with info

* add new d3.py file

* add comments to connect method

* clean pyscript class from logs

* revert class pySrc attribute

* add check_tutor_generated_code to test code inspector plugin in examples

* add doctsting to PyTutor connect

* add check for tutor code inspection on all examples

* Update pyscriptjs/src/plugins/python/py_tutor.py

fix template indentation

Co-authored-by: Fábio Rosado <fabioglrosado@gmail.com>

* Update examples/todo-pylist.html

fix typo (stray = )

Co-authored-by: Fábio Rosado <fabioglrosado@gmail.com>

* fix pymarkdown example

Co-authored-by: Fabio Pliger <fpliger@anaconda.com>
Co-authored-by: Fábio Rosado <fabioglrosado@gmail.com>
This commit is contained in:
Fabio Pliger
2022-12-20 07:48:07 -08:00
committed by GitHub
parent d4120d2af3
commit c0f36aa047
24 changed files with 1055 additions and 2515 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
pyscriptjs/tests/integration/support.py
View File

@@ -303,6 +303,72 @@ class PyScriptTest:
text = "\n".join(loc.all_inner_texts())
raise AssertionError(f"Found {n} alert banners:\n" + text)
def check_tutor_generated_code(self, modules_to_check=None):
"""
Ensure that the source code viewer injected by the PyTutor plugin
is presend. Raise AssertionError if not found.
Args:
modules_to_check(str): iterable with names of the python modules
that have been included in the tutor config
and needs to be checked (if they are included
in the displayed source code)
Returns:
None
"""
# Given: a page that has a <py-tutor> tag
assert self.page.locator("py-tutor").count()
# EXPECT that"
#
# the page has the "view-code-button"
view_code_button = self.page.locator("#view-code-button")
vcb_count = view_code_button.count()
if vcb_count != 1:
raise AssertionError(
f"Found {vcb_count} code view button. Should have been 1!"
)
# the page has the code-section element
code_section = self.page.locator("#code-section")
code_section_count = code_section.count()
code_msg = (
f"One (and only one) code section should exist. Found: {code_section_count}"
)
assert code_section_count == 1, code_msg
pyconfig_tag = self.page.locator("py-config")
code_section_inner_html = code_section.inner_html()
# the code_section has the index.html section
assert "<p>index.html</p>" in code_section_inner_html
# the section has the tags highlighting the HTML code
assert (
'<pre class="prism-code language-html" tabindex="0">'
' <code class="language-html">' in code_section_inner_html
)
# if modules were included, these are also presented in the code section
if modules_to_check:
for module in modules_to_check:
assert f"{module}" in code_section_inner_html
# the section also includes the config
assert "&lt;</span>py-config</span>" in code_section_inner_html
# the contents of the py-config tag are included in the code section
assert pyconfig_tag.inner_html() in code_section_inner_html
# the code section to be invisible by default (by having the hidden class)
assert "code-section-hidden" in code_section.get_attribute("class")
# once the view_code_button is pressed, the code section becomes visible
view_code_button.click()
assert "code-section-visible" in code_section.get_attribute("class")
# ============== Helpers and utility functions ==============

20
pyscriptjs/tests/integration/test_zz_examples.py
View File

@@ -61,6 +61,7 @@ class TestExamples(PyScriptTest):
pattern = "\\d+/\\d+/\\d+, \\d+:\\d+:\\d+" # e.g. 08/09/2022 15:57:32
assert re.search(pattern, content)
self.assert_no_banners()
self.check_tutor_generated_code()
def test_simple_clock(self):
self.goto("examples/simple_clock.html")
@@ -79,6 +80,7 @@ class TestExamples(PyScriptTest):
else:
assert False, "Espresso time not found :("
self.assert_no_banners()
self.check_tutor_generated_code()
def test_altair(self):
self.goto("examples/altair.html")
@@ -97,6 +99,7 @@ class TestExamples(PyScriptTest):
assert save_as_png_link.is_visible()
assert see_source_link.is_visible()
self.assert_no_banners()
self.check_tutor_generated_code()
def test_antigravity(self):
self.goto("examples/antigravity.html")
@@ -120,6 +123,7 @@ class TestExamples(PyScriptTest):
re.match(ycoord_pattern, char.get_attribute("transform")).group("ycoord")
)
assert later_y_coord < starting_y_coord
self.check_tutor_generated_code(modules_to_check=["antigravity.py"])
def test_bokeh(self):
# XXX improve this test
@@ -128,6 +132,7 @@ class TestExamples(PyScriptTest):
assert self.page.title() == "Bokeh Example"
wait_for_render(self.page, "*", '<div.*class=\\"bk\\".*>')
self.assert_no_banners()
self.check_tutor_generated_code()
def test_bokeh_interactive(self):
# XXX improve this test
@@ -136,6 +141,7 @@ class TestExamples(PyScriptTest):
assert self.page.title() == "Bokeh Example"
wait_for_render(self.page, "*", '<div.*?class=\\"bk\\".*?>')
self.assert_no_banners()
self.check_tutor_generated_code()
@pytest.mark.skip("flaky, see issue 759")
def test_d3(self):
@@ -152,6 +158,7 @@ class TestExamples(PyScriptTest):
# means that the chart rendered successfully and with the right text
assert "🍊21\n🍇13\n🍏8\n🍌5\n🍐3\n🍋2\n🍎1\n🍉1" in pyscript_chart.inner_text()
self.assert_no_banners()
self.check_tutor_generated_code(modules_to_check=["d3.py"])
def test_folium(self):
self.goto("examples/folium.html")
@@ -175,6 +182,7 @@ class TestExamples(PyScriptTest):
assert "−" in zoom_out.inner_text()
zoom_out.click()
self.assert_no_banners()
self.check_tutor_generated_code()
def test_markdown_plugin(self):
# Given the example page with:
@@ -186,6 +194,7 @@ class TestExamples(PyScriptTest):
assert self.page.title() == "PyMarkdown"
# ASSERT markdown is rendered to the corresponding HTML tag
wait_for_render(self.page, "*", "<h1>Hello world!</h1>")
self.check_tutor_generated_code()
def test_matplotlib(self):
self.goto("examples/matplotlib.html")
@@ -213,6 +222,7 @@ class TestExamples(PyScriptTest):
deviation = np.mean(np.abs(img_data - ref_data))
assert deviation == 0.0
self.assert_no_banners()
self.check_tutor_generated_code()
def test_numpy_canvas_fractals(self):
self.goto("examples/numpy_canvas_fractals.html")
@@ -260,6 +270,7 @@ class TestExamples(PyScriptTest):
# Confirm that changing the input values, triggered a new computation
assert self.console.log.lines[-1] == "Computing Newton set ..."
self.assert_no_banners()
self.check_tutor_generated_code()
def test_panel(self):
self.goto("examples/panel.html")
@@ -278,6 +289,7 @@ class TestExamples(PyScriptTest):
# Let's confirm that slider title changed
assert slider_title.inner_text() == "Amplitude: 5"
self.assert_no_banners()
self.check_tutor_generated_code()
def test_panel_deckgl(self):
# XXX improve this test
@@ -286,6 +298,7 @@ class TestExamples(PyScriptTest):
assert self.page.title() == "PyScript/Panel DeckGL Demo"
wait_for_render(self.page, "*", "<div.*?class=['\"]bk-root['\"].*?>")
self.assert_no_banners()
self.check_tutor_generated_code()
def test_panel_kmeans(self):
# XXX improve this test
@@ -294,6 +307,7 @@ class TestExamples(PyScriptTest):
assert self.page.title() == "Pyscript/Panel KMeans Demo"
wait_for_render(self.page, "*", "<div.*?class=['\"]bk-root['\"].*?>")
self.assert_no_banners()
self.check_tutor_generated_code()
def test_panel_stream(self):
# XXX improve this test
@@ -302,6 +316,7 @@ class TestExamples(PyScriptTest):
assert self.page.title() == "PyScript/Panel Streaming Demo"
wait_for_render(self.page, "*", "<div.*?class=['\"]bk-root['\"].*?>")
self.assert_no_banners()
self.check_tutor_generated_code()
def test_repl(self):
self.goto("examples/repl.html")
@@ -322,6 +337,7 @@ class TestExamples(PyScriptTest):
assert self.page.wait_for_selector("#my-repl-2-2", state="attached")
assert self.page.locator("#my-repl-2-2").text_content() == "4"
self.assert_no_banners()
self.check_tutor_generated_code(modules_to_check=["antigravity.py"])
def test_repl2(self):
self.goto("examples/repl2.html")
@@ -338,6 +354,7 @@ class TestExamples(PyScriptTest):
pattern = "\\d+/\\d+/\\d+, \\d+:\\d+:\\d+" # e.g. 08/09/2022 15:57:32
assert re.search(pattern, content)
self.assert_no_banners()
self.check_tutor_generated_code(modules_to_check=["antigravity.py"])
def test_todo(self):
self.goto("examples/todo.html")
@@ -366,6 +383,7 @@ class TestExamples(PyScriptTest):
in first_task.inner_html()
)
self.assert_no_banners()
self.check_tutor_generated_code(modules_to_check=["./utils.py", "./todo.py"])
def test_todo_pylist(self):
# XXX improve this test
@@ -374,6 +392,7 @@ class TestExamples(PyScriptTest):
assert self.page.title() == "Todo App"
wait_for_render(self.page, "*", "<input.*?id=['\"]new-task-content['\"].*?>")
self.assert_no_banners()
self.check_tutor_generated_code(modules_to_check=["utils.py", "pylist.py"])
@pytest.mark.xfail(reason="To be moved to collective and updated, see issue #686")
def test_toga_freedom(self):
@@ -392,6 +411,7 @@ class TestExamples(PyScriptTest):
result = self.page.locator("#toga_c_input")
assert "40.555" in result.input_value()
self.assert_no_banners()
self.check_tutor_generated_code()
def test_webgl_raycaster_index(self):
# XXX improve this test