run cruft update

Author: juliankuners

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/runtimeverification/python-project-template",
-  "commit": "601d5e2a0e8a98c87dcb1ae694d22d76d0114e01",
+  "commit": "7a095b4dd0a51916da0a728b8fdd9adf7e469a68",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -11,7 +11,8 @@
       "description": "K tooling for the Soroban platform",
       "author_name": "Runtime Verification, Inc.",
       "author_email": "contact@runtimeverification.com",
-      "_template": "https://github.com/runtimeverification/python-project-template"
+      "_template": "https://github.com/runtimeverification/python-project-template",
+      "_commit": "7a095b4dd0a51916da0a728b8fdd9adf7e469a68"
     }
   },
   "directory": null

Makefile

@@ -1,9 +1,13 @@
 UV     := uv
-UV_RUN := $(UV) run
+UV_RUN := $(UV) run --
 
 
 default: check test-unit
 
+.PHONY: build
+build:
+	$(UV) build
+
 all: check cov
 
 .PHONY: clean
@@ -14,26 +18,30 @@ clean:
 # Semantics
 
 kdist-build:
-	$(UV) run kdist -v build -j2 soroban-semantics.*
+	$(UV_RUN) kdist -v build -j2 soroban-semantics.*
 
 kdist-clean:
-	$(UV) run kdist clean
+	$(UV_RUN) kdist clean
 
 # Tests
 
 TEST_ARGS :=
 
 test: test-all
 
+.PHONY: test-all
 test-all:
 	$(UV_RUN) pytest src/tests --maxfail=1 --verbose --durations=0 --numprocesses=4 --dist=worksteal $(TEST_ARGS)
 
+.PHONY: test-unit
 test-unit:
 	$(UV_RUN) pytest src/tests/unit --maxfail=1 --verbose $(TEST_ARGS)
 
+.PHONY: test-integration
 test-integration:
 	$(UV_RUN) pytest src/tests/integration --maxfail=1 --verbose --durations=0 --numprocesses=4 --dist=worksteal $(TEST_ARGS)
 
+.PHONY: test-lemmas
 test-lemmas:
 	$(UV_RUN) pytest src/tests/lemmas --maxfail=1 --verbose --durations=0 --numprocesses=4 --dist=worksteal $(TEST_ARGS)
 
@@ -60,27 +68,35 @@ cov-integration: test-integration
 format: autoflake isort black
 check: check-flake8 check-mypy check-autoflake check-isort check-black
 
+.PHONY: check-flake8
 check-flake8:
 	$(UV_RUN) flake8 src
 
+.PHONY: check-mypy
 check-mypy:
 	$(UV_RUN) mypy src
 
+.PHONY: autoflake
 autoflake:
 	$(UV_RUN) autoflake --quiet --in-place src
 
+.PHONY: check-autoflake
 check-autoflake:
 	$(UV_RUN) autoflake --quiet --check src
 
+.PHONY: isort
 isort:
 	$(UV_RUN) isort src
 
+.PHONY: check-isort
 check-isort:
 	$(UV_RUN) isort --check src
 
+.PHONY: black
 black:
 	$(UV_RUN) black src
 
+.PHONY: check-black
 check-black:
 	$(UV_RUN) black --check src
 
@@ -89,5 +105,6 @@ check-black:
 
 SRC_FILES := $(shell find src -type f -name '*.py')
 
+.PHONY: pyupgrade
 pyupgrade:
 	$(UV_RUN) pyupgrade --py310-plus $(SRC_FILES)

README.md

@@ -3,7 +3,7 @@
 
 ## Installation
 
-Prerequsites: `python >= 3.10`, `pip >= 20.0.2`, `poetry >= 1.3.2`.
+Prerequsites: `python >= 3.10`, [`uv`](https://docs.astral.sh/uv/).
 
 ```bash
 make build
@@ -19,5 +19,5 @@ Use `make` to run common tasks (see the [Makefile](Makefile) for a complete list
 * `make check`: Check code style
 * `make format`: Format code
 * `make test-unit`: Run unit tests
+* `make test-integration`: Run integration tests
 
-For interactive use, spawn a shell with `poetry shell` (after `poetry install`), then run an interpreter.

nix/README.md

@@ -0,0 +1,3 @@
+## Notes
+#### git submodules
+If you use git submodules that are not required for building the project with `nix`, then you should add these directories to the `gitignoreSourcePure` list in `nix/komet/default.nix`, see the respective left-over `TODO` in the nix file. Otherwise, the nix build that is uploaded to the nix binary cache by CI might not match the version that is requested by `kup`, in case this project is offered as a package by `kup`. This is due to weird behaviour in regards to git submodules by `git` and `nix`, where a submodule directory might exist and be empty or instead not exist, which impacts the resulting nix hash, which is of impartance when offering/downloading cached nix derivations. See [runtimeverification/k/pull/4804](https://github.com/runtimeverification/k/pull/4804) for more information.

nix/komet/build-systems-overlay.nix

@@ -0,0 +1,22 @@
+final: prev:
+let
+  inherit (final) resolveBuildSystem;
+  inherit (builtins) mapAttrs;
+
+  # Build system dependencies specified in the shape expected by resolveBuildSystem
+  # The empty lists below are lists of optional dependencies.
+  #
+  # A package `foo` with specification written as:
+  # `setuptools-scm[toml]` in pyproject.toml would be written as
+  # `foo.setuptools-scm = [ "toml" ]` in Nix
+  buildSystemOverrides = {
+    # add dependencies here, e.g.:
+    # pyperclip.setuptools = [ ];
+  };
+in
+mapAttrs (
+  name: spec:
+  prev.${name}.overrideAttrs (old: {
+    nativeBuildInputs = old.nativeBuildInputs ++ resolveBuildSystem spec;
+  })
+) buildSystemOverrides

nix/komet/default.nix

@@ -0,0 +1,55 @@
+{
+  lib,
+  callPackage,
+  nix-gitignore,
+
+  pyproject-nix,
+  pyproject-build-systems,
+  uv2nix,
+
+  python
+}:
+let
+  pyproject-util = callPackage pyproject-nix.build.util {};
+  pyproject-packages = callPackage pyproject-nix.build.packages {
+    inherit python;
+  };
+
+  # load a uv workspace from a workspace root
+  workspace = uv2nix.lib.workspace.loadWorkspace {
+    workspaceRoot = lib.cleanSource (nix-gitignore.gitignoreSourcePure [
+        ../../.gitignore
+        ".github/"
+        "result*"
+        # do not include submodule directories that might be initilized empty or non-existent due to nix/git
+        # otherwise cachix build might not match the version that is requested by `kup`
+        # TODO: for new projects, add your submodule directories that are not required for nix builds here!
+        # e.g., `"/docs/external-computation"` with `external-computation` being a git submodule directory
+        # "/docs/external-computation"
+      ] ../..
+    );
+  };
+
+  # create overlay
+  lockFileOverlay = workspace.mkPyprojectOverlay {
+    # prefer "wheel" over "sdist" due to maintance overhead
+    # there is no bundled set of overlays for "sdist" in uv2nix, in contrast to poetry2nix
+    sourcePreference = "wheel";
+  };
+
+  buildSystemsOverlay = import ./build-systems-overlay.nix;
+
+  # construct package set
+  pythonSet = pyproject-packages.overrideScope (lib.composeManyExtensions [
+    # make build tools available by default as these are not necessarily specified in python lock files
+    pyproject-build-systems.overlays.default
+    # include all packages from the python lock file
+    lockFileOverlay
+    # add build system overrides to certain python packages
+    buildSystemsOverlay
+  ]);
+in pyproject-util.mkApplication {
+  # default dependancy group enables no optional dependencies and no dependency-groups
+  venv = pythonSet.mkVirtualEnv "komet-env" workspace.deps.default;
+  package = pythonSet.komet;
+}