cruft update

juliankuners · juliankuners · commit caa17bb0c58b · 2025-08-06T22:42:10.000+02:00
diff --git a/.cruft.json b/.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": "",
       "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
diff --git a/Makefile b/Makefile
@@ -1,5 +1,5 @@
 UV     := uv --directory kmir
-UV_RUN := $(UV) run
+UV_RUN := $(UV) run --
 
 PARALLEL := 4
 
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ Also included is the `kmir` tool, a python script that acts as a front-end to th
 
 ### KMIR Setup
 
-Pre-requisites: `python >= 3.10`, `pip >= 20.0.2`, `poetry >= 1.3.2`, `gcc >= 11.4.0`, `cargo == nightly-2024-11-29`, `k >= v7.1.205`. To install K, follow the steps available in [K's Quick Start instructions](https://github.com/runtimeverification/k?tab=readme-ov-file#quick-start). 
+Pre-requisites: `python >= 3.10`, [`uv`](https://docs.astral.sh/uv/), `pip >= 20.0.2`, `gcc >= 11.4.0`, `cargo == nightly-2024-11-29`, `k >= v7.1.205`. To install K, follow the steps available in [K's Quick Start instructions](https://github.com/runtimeverification/k?tab=readme-ov-file#quick-start). 
 
 ```bash
 make build
diff --git a/flake.nix b/flake.nix
@@ -1,50 +1,78 @@
 {
   description = "kmir - ";
   inputs = {
-    k-framework.url = "github:runtimeverification/k/v7.1.280";
-    nixpkgs.follows = "k-framework/nixpkgs";
-    flake-utils.follows = "k-framework/flake-utils";
+    nixpkgs.url = "nixpkgs/nixos-25.05";
     rv-nix-tools.follows = "k-framework/rv-nix-tools";
-    # poetry2nix.follows = "k-framework/poetry2nix"; # FIXME: To stop crash with `nix flake update`
+
+    flake-utils.url = "github:numtide/flake-utils";
+    k-framework.url = "github:runtimeverification/k/v7.1.280";
+
+    uv2nix.url = "github:pyproject-nix/uv2nix/680e2f8e637bc79b84268949d2f2b2f5e5f1d81c";
+    # stale nixpkgs is missing the alias `lib.match` -> `builtins.match`
+    # therefore point uv2nix to a patched nixpkgs, which introduces this alias
+    # this is a temporary solution until nixpkgs us up-to-date again
+    uv2nix.inputs.nixpkgs.url = "github:runtimeverification/nixpkgs/libmatch";
+    # inputs.nixpkgs.follows = "nixpkgs";
+    pyproject-build-systems.url = "github:pyproject-nix/build-system-pkgs/7dba6dbc73120e15b558754c26024f6c93015dd7";
+    pyproject-build-systems = {
+      inputs.nixpkgs.follows = "uv2nix/nixpkgs";
+      inputs.uv2nix.follows = "uv2nix";
+      inputs.pyproject-nix.follows = "uv2nix/pyproject-nix";
+    };
+    pyproject-nix.follows = "uv2nix/pyproject-nix";
   };
-  outputs = { self, nixpkgs, flake-utils, k-framework, ... }@inputs:
-    let
-      allOverlays = [
-        k-framework.overlays.pyk
-        (final: prev: let
-          poetry2nix =
-            inputs.poetry2nix.lib.mkPoetry2Nix { pkgs = prev; };
-          in {
-          kmir = poetry2nix.mkPoetryApplication {
-            python = prev.python310;
-            projectDir = ./kmir;
-            overrides = poetry2nix.overrides.withDefaults
-              (finalPython: prevPython: {
-                kframework = prev.pyk-python310;
-              });
-            groups = [];
-            # We remove `dev` from `checkGroups`, so that poetry2nix does not try to resolve dev dependencies.
-            checkGroups = [];
-           };
-        })
-      ];
-    in flake-utils.lib.eachSystem [
+  outputs = { self, nixpkgs, rv-nix-tools, flake-utils, k-framework, pyproject-nix, pyproject-build-systems, uv2nix }:
+  let
+    pythonVer = "310";
+  in flake-utils.lib.eachSystem [
       "x86_64-linux"
       "x86_64-darwin"
       "aarch64-linux"
       "aarch64-darwin"
     ] (system:
-      let
-        pkgs = import nixpkgs {
-          inherit system;
-          overlays = allOverlays;
+    let
+      # due to the nixpkgs that we use in this flake being outdated, uv is also heavily outdated
+      # we can instead use the binary release of uv provided by uv2nix for now
+      uvOverlay = final: prev: {
+        uv = uv2nix.packages.${final.system}.uv-bin;
+      };
+      mir-semanticsOverlay = final: prev: {
+        mir-semantics = final.callPackage ./nix/mir-semantics {
+          inherit pyproject-nix pyproject-build-systems uv2nix;
+          python = final."python${pythonVer}";
         };
-      in {
-        packages = rec {
-          inherit (pkgs) kmir;
-          default = kmir;
+      };
+      pkgs = import nixpkgs {
+        inherit system;
+        overlays = [
+          uvOverlay
+          mir-semanticsOverlay
+        ];
+      };
+      python = pkgs."python${pythonVer}";
+    in {
+      devShells.default = pkgs.mkShell {
+        name = "uv develop shell";
+        buildInputs = [
+          python
+          pkgs.uv
+        ];
+        env = {
+          # prevent uv from managing Python downloads and force use of specific 
+          UV_PYTHON_DOWNLOADS = "never";
+          UV_PYTHON = python.interpreter;
         };
-      }) // {
-        overlay = nixpkgs.lib.composeManyExtensions allOverlays;
+        shellHook = ''
+          unset PYTHONPATH
+        '';
+      };
+      packages = rec {
+        inherit (pkgs) mir-semantics;
+        default = mir-semantics;
+      };
+    }) // {
+      overlays.default = final: prev: {
+        inherit (self.packages.${final.system}) mir-semantics;
       };
+    };
 }
diff --git a/nix/README.md b/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/mir-semantics/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.
diff --git a/nix/mir-semantics/build-systems-overlay.nix b/nix/mir-semantics/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
diff --git a/nix/mir-semantics/default.nix b/nix/mir-semantics/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 "mir-semantics-env" workspace.deps.default;
+  package = pythonSet.mir-semantics;
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## Notes`
	`2`	`+#### git submodules`
	`3`	+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/mir-semantics/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.