template ext files (#49)

fpliger · pre-commit-ci[bot] · web-flow · commit 1dfecebe7574 · 2023-01-11T11:09:53.000-08:00
* change name of configuration files * make sure generator can handle both toml and json config files * change the default config test to be toml as it's the new default * add more tests * remove trailing space * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * reuse check_project_manifest on tests that make sense * reuse check_project_manifest on tests that make sense * revert toml pretty version since new one is bugged * check whether html template is loading files externally instead of inline * add function to save app config file and add specific function to create project html file * change new project html template to use external files and not code inline * add default python main file to cli config * use config to filenames instead of variables * make sure config always have all keys * change path in template to point to local * add wrap template and fix wrap cmd issues * rename ambiguous template argument * change the way we check config dict because of non support python feature in 3.8 * reverd rev change on precommit hooks * add docstrings Co-authored-by: Fabio Pliger <fpliger@anaconda.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
diff --git a/src/pyscript/__init__.py b/src/pyscript/__init__.py
@@ -14,6 +14,7 @@
 DEFAULT_CONFIG = {
     # Name of config file for PyScript projects.
     "project_config_filename": "pyscript.toml",
+    "project_main_filename": "main.py",
 }
 
 
@@ -47,3 +48,9 @@
 app = typer.Typer(add_completion=False)
 with CONFIG_FILE.open() as config_file:
     config = json.load(config_file)
+
+# Make sure all configuration keys are there. If any is missing,
+# we pick from the default config
+for (k, v) in DEFAULT_CONFIG.items():
+    if k not in config:
+        config[k] = v
diff --git a/src/pyscript/_generator.py b/src/pyscript/_generator.py
@@ -9,20 +9,76 @@
 from pyscript import config
 
 _env = jinja2.Environment(loader=jinja2.PackageLoader("pyscript"))
+TEMPLATE_PYTHON_CODE = """# Replace the code below with your own
+print("Hello, world!")
+"""
 
 
-def string_to_html(input_str: str, title: str, output_path: Path) -> None:
+def create_project_html(
+    title: str, python_file_path: str, config_file_path: str, output_file_path: Path
+) -> None:
     """Write a Python script string to an HTML file template."""
     template = _env.get_template("basic.html")
+    with output_file_path.open("w") as fp:
+        fp.write(
+            template.render(
+                python_file_path=python_file_path,
+                config_file_path=config_file_path,
+                title=title,
+            )
+        )
+
+
+def save_config_file(config_file: Path, configuration: dict):
+    """Write an app configuration dict to `config_file`.
+
+    Params:
+
+     - config_file(Path): path configuration file. (I.e.: "pyscript.toml"). Supported
+                          formats: `toml` and `json`.
+     - configuration(dict): app configuration to be saved
+
+    Return:
+        (None)
+    """
+    with config_file.open("w", encoding="utf-8") as fp:
+        if str(config_file).endswith(".json"):
+            json.dump(configuration, fp)
+        else:
+            toml.dump(configuration, fp)
+
+
+def string_to_html(
+    code: str, title: str, output_path: Path, template_name: str = "basic.html"
+) -> None:
+    """Write a Python script string to an HTML file template.
+
+    Params:
+
+        - code(str): string containing the application code to be written to the
+                     PyScript app template
+        - title(str): application title, that will be placed as title of the html
+                      app template
+        - template_name(str): name of the template to be used
+
+    Output:
+        (None)
+    """
+    template = _env.get_template(template_name)
     with output_path.open("w") as fp:
-        fp.write(template.render(code=input_str, title=title))
+        fp.write(template.render(code=code, title=title))
 
 
-def file_to_html(input_path: Path, title: str, output_path: Optional[Path]) -> None:
+def file_to_html(
+    input_path: Path,
+    title: str,
+    output_path: Optional[Path],
+    template_name: str = "basic.html",
+) -> None:
     """Write a Python script string to an HTML file template."""
     output_path = output_path or input_path.with_suffix(".html")
     with input_path.open("r") as fp:
-        string_to_html(fp.read(), title, output_path)
+        string_to_html(fp.read(), title, output_path, template_name)
 
 
 def create_project(
@@ -57,4 +113,15 @@ def create_project(
             toml.dump(context, fp)
 
     index_file = app_dir / "index.html"
-    string_to_html('print("Hello, world!")', app_name, index_file)
+
+    # Save the new python file
+    python_filepath = app_dir / "main.py"
+    with python_filepath.open("w", encoding="utf-8") as fp:
+        fp.write(TEMPLATE_PYTHON_CODE)
+
+    create_project_html(
+        app_name,
+        config["project_main_filename"],
+        config["project_config_filename"],
+        index_file,
+    )
diff --git a/src/pyscript/plugins/wrap.py b/src/pyscript/plugins/wrap.py
@@ -52,9 +52,9 @@ def wrap(
         else:
             raise cli.Abort("Must provide an output file or use `--show` option")
     if input_file is not None:
-        file_to_html(input_file, title, output)
+        file_to_html(input_file, title, output, template_name="wrap.html")
     if command:
-        string_to_html(command, title, output)
+        string_to_html(command, title, output, template_name="wrap.html")
     if output:
         if show:
             console.print("Opening in web browser!")
diff --git a/src/pyscript/templates/basic.html b/src/pyscript/templates/basic.html
@@ -6,8 +6,7 @@
     <script defer src="https://pyscript.net/alpha/pyscript.js"></script>
 </head>
 <body>
-<py-script>
-{{ code }}
-</py-script>
+    <py-config src="./{{ config_file_path }}"></py-config>
+    <py-script src="./{{ python_file_path }}"></py-script>
 </body>
 </html>
diff --git a/src/pyscript/templates/wrap.html b/src/pyscript/templates/wrap.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>{{ title }}</title>
+    <link rel="stylesheet" href="https://pyscript.net/alpha/pyscript.css"/>
+    <script defer src="https://pyscript.net/alpha/pyscript.js"></script>
+</head>
+<body>
+<py-script>
+{{ code }}
+</py-script>
+</body>
+</html>
diff --git a/tests/test_generator.py b/tests/test_generator.py
@@ -28,6 +28,7 @@ def test_create_project(tmp_cwd: Path, is_not_none: Any) -> None:
     manifest_path = tmp_cwd / app_name / config["project_config_filename"]
 
     check_project_manifest(manifest_path, toml, app_name, is_not_none)
+    check_project_files(tmp_cwd / app_name)
 
 
 def test_create_project_twice_raises_error(tmp_cwd: Path) -> None:
@@ -131,3 +132,39 @@ def check_project_manifest(
         "author_email": author_email,
         "version": is_not_none,
     }
+
+
+def check_project_files(
+    app_folder: Path,
+    html_file: str = "index.html",
+    config_file: str = config["project_config_filename"],
+    python_file: str = "main.py",
+):
+    """
+    Perform the following checks:
+
+        * checks that app_folder/html_file exists
+        * checks that app_folder/config_file exists
+        * checks that app_folder/python_file exists
+        * checks that html_file actually loads both the python and the config files
+
+    Params:
+        * config_path(Path): path to the app folder
+        * html_file(str): name of the html file generated by the template
+                          (default: index.html)
+        * config_file(str): name of the config file generated by the template
+                          (default: config["project_config_filename"])
+        * python_file(str): name of the python file generated by the template
+                          (default: main.py)
+
+    """
+    # assert that the new project files exists
+    html_file_path = app_folder / html_file
+    assert html_file_path.exists(), f"{html_file} not found! :("
+    assert (app_folder / config_file).exists(), f"{config_file} not found! :("
+    assert (app_folder / python_file).exists(), f"{python_file} not found! :("
+
+    with html_file_path.open() as fp:
+        contents = fp.read()
+        assert f'<py-script src="./{python_file}">' in contents
+        assert f'<py-config src="./{config_file}">' in contents
