Python Plugins (#961)

* add test and example files

* update config to include python plugins in build

* add markdown plugin

* remove full pyscript execution from pyodide

* move loading of pyscript.py from pyodide loagInterpreter to main setupVirtualEnv and add function to create python CE plugins

* add plugin class to pyscript.py

* add missing import

* fix plugin path

* add fetchPythonPlugins to PyScriptApp

* remove old comments

* fix test

* add support for python plugins beyond custom elements and add app to python namespace in main

* inject reference to PyScript app onto python plugins

* add example hook onto markdown plugin

* change plugin events logs

* remove unused PyPlugin

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix type import

* add docstring to fetchPythonPlugins

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* rename addPythonPlugin method

* address PR comment

* call python plugins on hooks after the interpreted is ready

* add test for event hooks and split the test in 2 separate plugins to isolte type of plugins tests

* change python plugins initialization and registration, to inject the app from app itself instead of on the plugins themselves

* handle case when plugin cannot load due to missing plugin attribute

* add test for fail scenario when a plugin module does not have a plugin attribute

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add deprecation warning for pyscript objects loaded in global namespace

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* remove all from global scope

* remove create_custom_element from global scope

* rename create_custom_element to define_custom_element

* rename attributes in define_custom_element and add docstrings

* better handle connect event output

* add warning to py_markdown plugin

* remove debugging logs

* improve tests

* remove debugging log

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* remove unused import

* add executable shebang

* add pyodide mock module

* fmt and lint

* Update to pyodide.ffi.create_proxy per pyodide v21 api change

* Mock pyodide as package instead of mdoule

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add __init__ to pyodide package

* Update pyscriptjs/src/plugin.ts

fix logger name

Co-authored-by: Antonio Cuni <anto.cuni@gmail.com>

* fix pyodide import but handling the diff in their API change

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* oops, conflict resolution blooper

* Fix failing integration tests

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Jeff Glass <glass.jeffrey@gmail.com>
Co-authored-by: Antonio Cuni <anto.cuni@gmail.com>
Co-authored-by: FabioRosado <fabiorosado@outlook.com>

pyscriptjs/tests/integration/test_01_basic.py

@@ -14,10 +14,8 @@ class TestBasic(PyScriptTest):
             </py-script>
             """
         )
-        assert self.console.log.lines == [
-            self.PY_COMPLETE,
-            "hello pyscript",
-        ]
+        assert self.console.log.lines[0] == self.PY_COMPLETE
+        assert self.console.log.lines[-1] == "hello pyscript"
 
     def test_python_exception(self):
         self.pyscript_run(
@@ -28,7 +26,8 @@ class TestBasic(PyScriptTest):
             </py-script>
         """
         )
-        assert self.console.log.lines == [self.PY_COMPLETE, "hello pyscript"]
+        assert self.console.log.lines[0] == self.PY_COMPLETE
+        assert "hello pyscript" in self.console.log.lines
         # check that we sent the traceback to the console
         tb_lines = self.console.error.lines[-1].splitlines()
         assert tb_lines[0] == "[pyexec] Python exception:"
@@ -57,8 +56,8 @@ class TestBasic(PyScriptTest):
             <py-script>js.console.log('four')</py-script>
         """
         )
-        assert self.console.log.lines == [
-            self.PY_COMPLETE,
+        assert self.console.log.lines[0] == self.PY_COMPLETE
+        assert self.console.log.lines[-4:] == [
             "one",
             "two",
             "three",
@@ -75,7 +74,9 @@ class TestBasic(PyScriptTest):
             <py-script>js.console.log("<div></div>")</py-script>
         """
         )
-        assert self.console.log.lines == [self.PY_COMPLETE, "true false", "<div></div>"]
+
+        assert self.console.log.lines[0] == self.PY_COMPLETE
+        assert self.console.log.lines[-2:] == ["true false", "<div></div>"]
 
     def test_packages(self):
         self.pyscript_run(
@@ -92,8 +93,9 @@ class TestBasic(PyScriptTest):
             </py-script>
             """
         )
-        assert self.console.log.lines == [
-            self.PY_COMPLETE,
+
+        assert self.console.log.lines[0] == self.PY_COMPLETE
+        assert self.console.log.lines[-3:] == [
             "Loading asciitree",  # printed by pyodide
             "Loaded asciitree",  # printed by pyodide
             "hello asciitree",  # printed by us
@@ -114,10 +116,9 @@ class TestBasic(PyScriptTest):
         )
         self.page.locator("button").click()
         self.page.locator("py-script")  # wait until <py-script> appears
-        assert self.console.log.lines == [
-            self.PY_COMPLETE,
-            "hello world",
-        ]
+
+        assert self.console.log.lines[0] == self.PY_COMPLETE
+        assert self.console.log.lines[-1] == "hello world"
 
     def test_py_script_src_attribute(self):
         self.writefile("foo.py", "print('hello from foo')")
@@ -126,10 +127,8 @@ class TestBasic(PyScriptTest):
             <py-script src="foo.py"></py-script>
             """
         )
-        assert self.console.log.lines == [
-            self.PY_COMPLETE,
-            "hello from foo",
-        ]
+        assert self.console.log.lines[0] == self.PY_COMPLETE
+        assert self.console.log.lines[-1] == "hello from foo"
 
     def test_py_script_src_not_found(self):
         self.pyscript_run(
@@ -137,9 +136,8 @@ class TestBasic(PyScriptTest):
             <py-script src="foo.py"></py-script>
             """
         )
-        assert self.console.log.lines == [
-            self.PY_COMPLETE,
-        ]
+        assert self.PY_COMPLETE in self.console.log.lines
+
         assert "Failed to load resource" in self.console.error.lines[0]
         with pytest.raises(JsErrors) as exc:
             self.check_js_errors()
@@ -192,3 +190,28 @@ class TestBasic(PyScriptTest):
             )
             is not None
         )
+
+    def test_python_modules_deprecated(self):
+        # GIVEN a py-script tag
+        self.pyscript_run(
+            """
+            <py-script>
+                print('hello pyscript')
+                raise Exception('this is an error')
+            </py-script>
+        """
+        )
+        # TODO: Adding a quick check that the deprecation warning is logged. Not spending
+        #       to much time to make it perfect since we'll remove this right after the
+        #       release. (Anyone wanting to improve it, please feel free to)
+        warning_msg = (
+            "[pyscript/main] DEPRECATION WARNING: 'micropip', 'Element', 'console', 'document' "
+            "and several other objects form the pyscript module (with the exception of 'display') "
+            "will be be removed from the Python global namespace in the following release. "
+            "To avoid errors in future releases use import from pyscript "
+            "instead. For instance: from pyscript import micropip, Element, "
+            "console, document"
+        )
+        # we EXPECTED to find a deprecation warning about what will be removed from the Python
+        # global namespace in the next releases
+        assert warning_msg in self.console.warning.lines