jprdonnelly/pyscript
1
0
Fork 0
mirror of https://github.com/pyscript/pyscript.git synced 2026-02-14 10:01:09 -05:00
Code Issues Projects Releases Wiki Activity

Python Plugins (#961)

Browse Source 
* 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>
This commit is contained in:
Fabio Pliger
2022-11-28 12:39:31 -06:00
committed by GitHub
parent 446c131ccb
commit 3e408b7baa
35 changed files with 2378 additions and 1216 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
pyscriptjs/src/plugins/fetch.ts
View File

@@ -6,8 +6,8 @@ export function calculatePaths(fetch_cfg: FetchConfig[]) {
const fetchPaths: string[] = [];
const paths: string[] = [];
fetch_cfg.forEach(function (each_fetch_cfg: FetchConfig) {
const from = each_fetch_cfg.from || "";
const to_folder = each_fetch_cfg.to_folder || ".";
const from = each_fetch_cfg.from || '';
const to_folder = each_fetch_cfg.to_folder || '.';
const to_file = each_fetch_cfg.to_file;
const files = each_fetch_cfg.files;
if (files !== undefined)
@@ -19,16 +19,13 @@ export function calculatePaths(fetch_cfg: FetchConfig[]) {
`Cannot use 'to_file' and 'files' parameters together!`
);
}
for (const each_f of files)
{
for (const each_f of files) {
const each_fetch_path = joinPaths([from, each_f]);
fetchPaths.push(each_fetch_path);
const each_path = joinPaths([to_folder, each_f]);
paths.push(each_path);
}
}
else
{
} else {
fetchPaths.push(from);
const filename = to_file || from.split('/').pop();
if (filename === '') {

9
pyscriptjs/src/plugins/importmap.ts
View File

@@ -11,7 +11,6 @@ type ImportMapType = {
};
export class ImportmapPlugin extends Plugin {
async afterSetup(runtime: Runtime) {
// make importmap ES modules available from python using 'import'.
//
@@ -26,9 +25,8 @@ export class ImportmapPlugin extends Plugin {
const importmap: ImportMapType = (() => {
try {
return JSON.parse(node.textContent) as ImportMapType;
}
catch(error) {
showWarning("Failed to parse import map: " + error.message);
} catch (error) {
showWarning('Failed to parse import map: ' + error.message);
}
})();
@@ -47,10 +45,9 @@ export class ImportmapPlugin extends Plugin {
continue;
}
logger.info("Registering JS module", name);
logger.info('Registering JS module', name);
runtime.registerJsModule(name, exports);
}
}
}
}

23
pyscriptjs/src/plugins/pyterminal.ts
View File

@@ -19,10 +19,7 @@ export class PyTerminalPlugin extends Plugin {
configure(config: AppConfig) {
// validate the terminal config and handle default values
const t = config.terminal;
if (t !== undefined &&
t !== true &&
t !== false &&
t !== "auto") {
if (t !== undefined && t !== true && t !== false && t !== 'auto') {
const got = JSON.stringify(t);
throw new UserError(
ErrorCode.BAD_CONFIG,
@@ -31,7 +28,7 @@ export class PyTerminalPlugin extends Plugin {
);
}
if (t === undefined) {
config.terminal = "auto"; // default value
config.terminal = 'auto'; // default value
}
}
@@ -39,12 +36,11 @@ export class PyTerminalPlugin extends Plugin {
// if config.terminal is "yes" or "auto", let's add a <py-terminal> to
// the document, unless it's already present.
const t = config.terminal;
if (t === true || t === "auto") {
if (t === true || t === 'auto') {
if (document.querySelector('py-terminal') === null) {
logger.info("No <py-terminal> found, adding one");
logger.info('No <py-terminal> found, adding one');
const termElem = document.createElement('py-terminal');
if (t === "auto")
termElem.setAttribute("auto", "");
if (t === 'auto') termElem.setAttribute('auto', '');
document.body.appendChild(termElem);
}
}
@@ -74,9 +70,7 @@ export class PyTerminalPlugin extends Plugin {
}
}
function make_PyTerminal(app: PyScriptApp) {
/** The <py-terminal> custom element, which automatically register a stdio
* listener to capture and display stdout/stderr
*/
@@ -95,8 +89,7 @@ function make_PyTerminal(app: PyScriptApp) {
if (this.isAuto()) {
this.classList.add('py-terminal-hidden');
this.autoShowOnNextLine = true;
}
else {
} else {
this.autoShowOnNextLine = false;
}
@@ -105,12 +98,12 @@ function make_PyTerminal(app: PyScriptApp) {
}
isAuto() {
return this.hasAttribute("auto");
return this.hasAttribute('auto');
}
// implementation of the Stdio interface
stdout_writeline(msg: string) {
this.outElem.innerText += msg + "\n";
this.outElem.innerText += msg + '\n';
if (this.autoShowOnNextLine) {
this.classList.remove('py-terminal-hidden');
this.autoShowOnNextLine = false;

31
pyscriptjs/src/plugins/python/py_markdown.py Normal file
View File

@@ -0,0 +1,31 @@
from textwrap import dedent
from markdown import markdown
from pyscript import Plugin, console
console.warning(
"WARNING: This plugin is still in a very experimental phase and will likely change"
" and potentially break in the future releases. Use it with caution."
)
class MyPlugin(Plugin):
def configure(self, config):
console.log(f"configuration received: {config}")
def afterStartup(self, runtime):
console.log(f"runtime received: {runtime}")
plugin = MyPlugin("py-markdown")
@plugin.register_custom_element("py-md")
class PyMarkdown:
def __init__(self, element):
self.element = element
def connect(self):
self.element.innerHTML = markdown(
dedent(self.element.source), extensions=["fenced_code"]
)

2
pyscriptjs/src/plugins/splashscreen.ts
View File

@@ -27,7 +27,7 @@ export class SplashscreenPlugin extends Plugin {
// deprecation warning)
this.autoclose = true;
if ("autoclose_loader" in config) {
if ('autoclose_loader' in config) {
this.autoclose = config.autoclose_loader;
showWarning(AUTOCLOSE_LOADER_DEPRECATED);
}