chiklisp-builder 0.1.0__tar.gz

chiklisp_builder-0.1.0/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 by Richard Kiss
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

chiklisp_builder-0.1.0/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.1
+Name: chiklisp_builder
+Version: 0.1.0
+Summary: Allow on-demand builds of chiklisp with recursive dependency checking.
+Author-email: Richard Kiss <him@richardkiss.com>
+License: Copyright 2023 by Richard Kiss
+        
+        Licensed under the Apache License, Version 2.0 (the "License");
+        you may not use this file except in compliance with the License.
+        You may obtain a copy of the License at
+        
+            http://www.apache.org/licenses/LICENSE-2.0
+        
+        Unless required by applicable law or agreed to in writing, software
+        distributed under the License is distributed on an "AS IS" BASIS,
+        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+        See the License for the specific language governing permissions and
+        limitations under the License.
+        
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Chiklisp Builder
+
+Use this wheel in conjunction with `runtime_builder` to manage building of chiklisp at build time or during development.
+
+# Use
+
+Add `chiklisp_builder` as a buildtime dependency and a development-time dependency. Don't add it as a runtime dependency, as the klvm `.hex` files should be built and included with the wheel. The source does not need to be.
+
+Add `chiklisp_loader` as a runtime dependency to get the `load_program` function, which will call the building function if present (as it should be at development time.)
+
+# FAQ
+
+Why isn't this included as part of `runtime_builder`?
+
+The `runtime_builder` wheel is intended to provide a general solution for non-python artifacts. Although Chiklisp build was the inspiration for `runtime_builder`, it's just one potential use. This wheel is the specific implementation of chiklisp builds for use with `runtime_builder`.

chiklisp_builder-0.1.0/README.md

@@ -0,0 +1,15 @@
+# Chiklisp Builder
+
+Use this wheel in conjunction with `runtime_builder` to manage building of chiklisp at build time or during development.
+
+# Use
+
+Add `chiklisp_builder` as a buildtime dependency and a development-time dependency. Don't add it as a runtime dependency, as the klvm `.hex` files should be built and included with the wheel. The source does not need to be.
+
+Add `chiklisp_loader` as a runtime dependency to get the `load_program` function, which will call the building function if present (as it should be at development time.)
+
+# FAQ
+
+Why isn't this included as part of `runtime_builder`?
+
+The `runtime_builder` wheel is intended to provide a general solution for non-python artifacts. Although Chiklisp build was the inspiration for `runtime_builder`, it's just one potential use. This wheel is the specific implementation of chiklisp builds for use with `runtime_builder`.

chiklisp_builder-0.1.0/chiklisp_builder.egg-info/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.1
+Name: chiklisp-builder
+Version: 0.1.0
+Summary: Allow on-demand builds of chiklisp with recursive dependency checking.
+Author-email: Richard Kiss <him@richardkiss.com>
+License: Copyright 2023 by Richard Kiss
+        
+        Licensed under the Apache License, Version 2.0 (the "License");
+        you may not use this file except in compliance with the License.
+        You may obtain a copy of the License at
+        
+            http://www.apache.org/licenses/LICENSE-2.0
+        
+        Unless required by applicable law or agreed to in writing, software
+        distributed under the License is distributed on an "AS IS" BASIS,
+        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+        See the License for the specific language governing permissions and
+        limitations under the License.
+        
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Chiklisp Builder
+
+Use this wheel in conjunction with `runtime_builder` to manage building of chiklisp at build time or during development.
+
+# Use
+
+Add `chiklisp_builder` as a buildtime dependency and a development-time dependency. Don't add it as a runtime dependency, as the klvm `.hex` files should be built and included with the wheel. The source does not need to be.
+
+Add `chiklisp_loader` as a runtime dependency to get the `load_program` function, which will call the building function if present (as it should be at development time.)
+
+# FAQ
+
+Why isn't this included as part of `runtime_builder`?
+
+The `runtime_builder` wheel is intended to provide a general solution for non-python artifacts. Although Chiklisp build was the inspiration for `runtime_builder`, it's just one potential use. This wheel is the specific implementation of chiklisp builds for use with `runtime_builder`.

chiklisp_builder-0.1.0/chiklisp_builder.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+chiklisp_builder.py
+pyproject.toml
+setup.py
+chiklisp_builder.egg-info/PKG-INFO
+chiklisp_builder.egg-info/SOURCES.txt
+chiklisp_builder.egg-info/dependency_links.txt
+chiklisp_builder.egg-info/requires.txt
+chiklisp_builder.egg-info/top_level.txt
+tests/a.clib
+tests/b.clib
+tests/mod.clsp
+tests/test_chiklisp_build.py

chiklisp_builder-0.1.0/chiklisp_builder.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

chiklisp_builder-0.1.0/chiklisp_builder.egg-info/requires.txt

@@ -0,0 +1,2 @@
+klvm_tools_rs
+runtime_builder>=0.1.0

chiklisp_builder-0.1.0/chiklisp_builder.egg-info/top_level.txt

@@ -0,0 +1 @@
+chiklisp_builder

chiklisp_builder-0.1.0/chiklisp_builder.py

@@ -0,0 +1,59 @@
+from pathlib import Path
+from typing import List
+
+import re
+
+import klvm_tools_rs
+
+CRE = re.compile(r"\((\s)*include(\s)+(.+)\)")
+
+
+def find_included_items(item: Path) -> List[Path]:
+    contents = item.read_text()
+    matches = CRE.findall(contents)
+    included = []
+    for match in matches:
+        s = match[-1]
+        if len(s) > 1 and s[0] == s[-1] and s[0] in "'\"":
+            included.append(s[1:-1])
+    return included
+
+
+def calculate_dependencies(source_path: Path, include_paths: List[Path]) -> List[Path]:
+    include_paths = [Path(_) for _ in include_paths]
+    dependencies = set()
+    to_check = [source_path]
+    while len(to_check):
+        item = to_check.pop()
+        if item in dependencies:
+            continue
+        dependencies.add(item)
+        included_items = find_included_items(item)
+        for include_item in included_items:
+            for include_path in include_paths:
+                p = include_path / include_item
+                if p.exists():
+                    to_check.append(p)
+    return dependencies
+
+
+class ChiklispBuild:
+    def __init__(self, include_paths: List[Path] = []):
+        self.include_paths = include_paths
+        self.include_paths_as_str = [str(_) for _ in include_paths]
+
+    def __call__(self, target_path: Path):
+        source_path = target_path.with_suffix(".clsp")
+
+        dependencies = calculate_dependencies(source_path, self.include_paths)
+        latest_date = max(_.stat().st_mtime for _ in dependencies)
+
+        if not target_path.exists() or target_path.stat().st_mtime < latest_date:
+            # we need to rebuild
+            if target_path.exists():
+                # `compile_klvm` doesn't always replace existing files as of 0.1.34
+                target_path.unlink()
+            source_path_str, target_path_str = str(source_path), str(target_path)
+            klvm_tools_rs.compile_klvm(
+                source_path_str, target_path_str, self.include_paths_as_str
+            )

chiklisp_builder-0.1.0/pyproject.toml

@@ -0,0 +1,12 @@
+[project]
+name = "chiklisp_builder"
+description = "Allow on-demand builds of chiklisp with recursive dependency checking."
+authors = [{name = "Richard Kiss", email = "him@richardkiss.com"}]
+license = {file = "LICENSE"}
+readme = "README.md"
+version = "0.1.0"
+dependencies = ["klvm_tools_rs", "runtime_builder>=0.1.0"]
+
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"

chiklisp_builder-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

chiklisp_builder-0.1.0/setup.py

@@ -0,0 +1,5 @@
+from setuptools import setup
+
+setup(
+    py_modules=["chiklisp_builder"],
+)

chiklisp_builder-0.1.0/tests/a.clib

@@ -0,0 +1,4 @@
+(
+    (include "b.clib")
+    (defconstant CONST_A 100)
+)

chiklisp_builder-0.1.0/tests/b.clib

@@ -0,0 +1,3 @@
+(
+    (defconstant CONST_B 200)
+)

chiklisp_builder-0.1.0/tests/mod.clsp

@@ -0,0 +1,4 @@
+(mod (X)
+    (include "a.clib")
+    (+ X (+ CONST_A CONST_B))
+)

chiklisp_builder-0.1.0/tests/test_chiklisp_build.py

@@ -0,0 +1,47 @@
+from pathlib import Path
+
+import shutil
+import tempfile
+
+from chiklisp_builder import ChiklispBuild
+
+
+def test_chiklisp_build():
+    here = Path(__file__).parent
+    with tempfile.TemporaryDirectory() as tmpdir:
+        tmpdir = Path(tmpdir)
+
+        # copy files to temporary directory
+        shutil.copytree(here, tmpdir, dirs_exist_ok=True)
+
+        # create builder
+        mod_file = tmpdir / "mod.clsp"
+        artifact_f = ChiklispBuild(include_paths=[tmpdir])
+        target_path = tmpdir / "mod.hex"
+
+        artifact_f(target_path)
+        output = target_path.read_text()
+        assert output == "ff10ff02ffff0182012c80\n"
+
+        # change `b.clib`
+        blib = tmpdir / "b.clib"
+        blib.write_text("((defconstant CONST_B 400))")
+
+        artifact_f(target_path)
+        output = target_path.read_text()
+        assert output == "ff10ff02ffff018201f480\n"
+
+        # change `b.clib` but rewrite target file so we trick `ChiklispBuild` into not rebuilding
+        blib.write_text("((defconstant CONST_B 500))")
+        target_path.write_text(output)
+
+        artifact_f(target_path)
+        output = target_path.read_text()
+        assert output == "ff10ff02ffff018201f480\n"
+
+        # touch `b.clib` and try again
+        blib.write_text("((defconstant CONST_B 500))")
+
+        artifact_f(target_path)
+        output = target_path.read_text()
+        assert output == "ff10ff02ffff0182025880\n"