999897df12
* Minor cleanups: move all Element classes to bottom of module. * Commenting. * Commenting. * Commenting. * Group dunder methods. * Don't cache the element's parent. * Remove style type check until we decide whether or not to add for classes too. * Add ability to register/unregister element classes. * Implement __iter__ for container elements. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Minor renaming to make it clear when we have an Element instance vs an actual DOM element. * remove duplication: added Element.get_tag_name * Commenting. * Allow Element.append to 1) use *args, 2) accept iterables * Remove iterable check - inteferes with js proxies. * Don't use *args, so it quacks more like a list ;) * Element.append take 2 :) * Remove unused code. * Move to web.py with a page object! * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Added 'page.title' too :) * Add __getitem__ as a shortcut for page.find * Add Element.__getitem__ to be consistent * Make __getitem__ consistent for Page, Element and ElementCollection. * Docstringing. * Docstringing. * Docstringing/commenting. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix select.add (revert InnerHTML->html) * Commenting. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Hand-edit some of the AI :) * Rename ElementCollection.children -> ElementCollection.elements * Remove unnecessary guard. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
@pyscript/core
We have moved and renamed previous core module as polyscript, which is the base module used in here to build up PyScript Next, now hosted in this folder.
Documentation
Please read core documentation to know more about this project.
Development
Clone this repository then run npm install within its folder.
Use npm run build to create all artifacts and dist files.
Use npm run server to test locally, via the http://localhost:8080/test/ url, smoke tests or to test manually anything you'd like to check.
Artifacts
There are two main artifacts in this project:
- stdlib and its content, where
src/stdlib/pyscript.jsexposes as object literal all the Python content within the folder (recursively) - plugins and its content, where
src/plugins.jsexposes all available dynamic imports, able to instrument the bundler to create files a part within the dist/ folder, so that by default core remains as small as possible
Accordingly, whenever a file contains this warning at its first line, please do not change such file directly before submitting a merge request, as that file will be overwritten at the next npm run build command, either here or in CI:
// ⚠️ This file is an artifact: DO NOT MODIFY
Running tests
Before running the tests, we need to create a tests environment first. To do so run the following command from the root folder of the project:
make setup
This will create a tests environment [in the root of the project, named ./env]and install all the dependencies needed to run the tests.
After the command has completed and the tests environment has been created, you can run the integration tests with the following command:
make test-integration
pyscript python package
The pyscript package available in Python lives in the folder src/stdlib/pyscript/.
All Python files will be embedded automatically whenever npm run build happens and reflected into the src/stdlib/pyscript.js file.
It is core responsibility to ensure those files will be available through the Filesystem in either the main thread, or any worker.
JS plugins
While community or third party plugins don't need to be part of this repository and can be added just importing @pyscript/core as module, there are a few plugins that we would like to make available by default and these are considered core plugins.
To add a core plugin to this project you can define your plugin entry-point and name in the src/plugins folder (see the error.js example) and create, if necessary, a folder with the same name where extra files or dependencies can be added.
The build command will bring plugins by name as artifact so that the bundler can create ad-hoc files within the dist/ folder.