Test that we can use development version of backend

.github/workflows/CI.yml

@@ -94,6 +94,27 @@ jobs:
           COVERALLS_PARALLEL: true
         run: coveralls --service=github
 
+  dev_install:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: ['ubuntu-latest']
+        python-version: ['3.11']
+        julia-version: ['1']
+        include:
+          - os: ubuntu-latest
+            python-version: '3.7'
+            julia-version: '1.6'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      - name: "Install PySR"
+        run: |
+            python -m pip install --upgrade pip
+            pip install .
+      - name: "Run development test"
+        run: PYSR_TEST_JULIA_VERSION=${{ matrix.julia-version }} PYSR_TEST_PYTHON_VERSION=${{ matrix.python-version }} python -m pysr test dev
+
   conda_test:
     runs-on: ${{ matrix.os }}
     defaults:

pysr/_cli/main.py

@@ -5,6 +5,7 @@ import click
 from ..test import (
     get_runtests_cli,
     runtests,
+    runtests_dev,
     runtests_jax,
     runtests_startup,
     runtests_torch,
@@ -44,7 +45,7 @@ def _install(julia_project, quiet, precompile):
     )
 
 
-TEST_OPTIONS = {"main", "jax", "torch", "cli", "startup"}
+TEST_OPTIONS = {"main", "jax", "torch", "cli", "dev", "startup"}
 
 
 @pysr.command("test")
@@ -52,7 +53,7 @@ TEST_OPTIONS = {"main", "jax", "torch", "cli", "startup"}
 def _tests(tests):
     """Run parts of the PySR test suite.
 
-    Choose from main, jax, torch, cli, and startup. You can give multiple tests, separated by commas.
+    Choose from main, jax, torch, cli, dev, and startup. You can give multiple tests, separated by commas.
     """
     for test in tests.split(","):
         if test == "main":
@@ -64,6 +65,8 @@ def _tests(tests):
         elif test == "cli":
             runtests_cli = get_runtests_cli()
             runtests_cli()
+        elif test == "dev":
+            runtests_dev()
         elif test == "startup":
             runtests_startup()
         else:

pysr/test/__init__.py

@@ -1,5 +1,6 @@
 from .test import runtests
 from .test_cli import get_runtests as get_runtests_cli
+from .test_dev import runtests as runtests_dev
 from .test_jax import runtests as runtests_jax
 from .test_startup import runtests as runtests_startup
 from .test_torch import runtests as runtests_torch
@@ -10,4 +11,5 @@ __all__ = [
     "runtests_torch",
     "get_runtests_cli",
     "runtests_startup",
+    "runtests_dev",
 ]

pysr/test/generate_dev_juliapkg.py

@@ -0,0 +1,17 @@
+# Example call:
+## python3 generate_dev_juliapkg.py /pysr/pysr/juliapkg.json /srjl
+import json
+import sys
+
+juliapkg_json = sys.argv[1]
+path_to_srjl = sys.argv[2]
+
+with open(juliapkg_json, "r") as f:
+    juliapkg = json.load(f)
+
+del juliapkg["packages"]["SymbolicRegression"]["version"]
+juliapkg["packages"]["SymbolicRegression"]["path"] = path_to_srjl
+juliapkg["packages"]["SymbolicRegression"]["dev"] = True
+
+with open(juliapkg_json, "w") as f:
+    json.dump(juliapkg, f, indent=4)

pysr/test/test_dev.py

@@ -0,0 +1,55 @@
+import os
+import subprocess
+import unittest
+from pathlib import Path
+
+
+class TestDev(unittest.TestCase):
+    def test_simple_change_to_backend(self):
+        """Test that we can use a development version of SymbolicRegression.jl"""
+        PYSR_TEST_JULIA_VERSION = os.environ.get("PYSR_TEST_JULIA_VERSION", "1.6")
+        PYSR_TEST_PYTHON_VERSION = os.environ.get("PYSR_TEST_PYTHON_VERSION", "3.9")
+        build_result = subprocess.run(
+            [
+                "docker",
+                "build",
+                "-t",
+                "pysr-dev",
+                "--build-arg",
+                f"JLVERSION={PYSR_TEST_JULIA_VERSION}",
+                "--build-arg",
+                f"PYVERSION={PYSR_TEST_PYTHON_VERSION}",
+                "-f",
+                "pysr/test/test_dev_pysr.dockerfile",
+                ".",
+            ],
+            env=os.environ,
+            cwd=Path(__file__).parent.parent.parent,
+            universal_newlines=True,
+        )
+        self.assertEqual(build_result.returncode, 0)
+        test_result = subprocess.run(
+            [
+                "docker",
+                "run",
+                "--rm",
+                "pysr-dev",
+                "python3",
+                "-c",
+                "from pysr import SymbolicRegression as SR; print(SR.__test_function())",
+            ],
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            env=os.environ,
+            cwd=Path(__file__).parent.parent.parent,
+        )
+        self.assertEqual(test_result.returncode, 0)
+        self.assertEqual(test_result.stdout.decode("utf-8").strip(), "2.3")
+
+
+def runtests():
+    suite = unittest.TestSuite()
+    loader = unittest.TestLoader()
+    suite.addTests(loader.loadTestsFromTestCase(TestDev))
+    runner = unittest.TextTestRunner()
+    return runner.run(suite)

pysr/test/test_dev_pysr.dockerfile

@@ -0,0 +1,57 @@
+# This dockerfile simulates a user installation that
+# tries to manually edit SymbolicRegression.jl and
+# use it from PySR.
+
+ARG JLVERSION=1.9.4
+ARG PYVERSION=3.11.6
+ARG BASE_IMAGE=bullseye
+
+FROM julia:${JLVERSION}-${BASE_IMAGE} AS jl
+FROM python:${PYVERSION}-${BASE_IMAGE}
+
+# Merge Julia image:
+COPY --from=jl /usr/local/julia /usr/local/julia
+ENV PATH="/usr/local/julia/bin:${PATH}"
+
+WORKDIR /pysr
+
+# Caches install (https://stackoverflow.com/questions/25305788/how-to-avoid-reinstalling-packages-when-building-docker-image-for-python-project)
+ADD ./requirements.txt /pysr/requirements.txt
+RUN pip3 install --no-cache-dir -r /pysr/requirements.txt
+
+# Install PySR:
+# We do a minimal copy so it doesn't need to rerun at every file change:
+ADD ./pyproject.toml /pysr/pyproject.toml
+ADD ./setup.py /pysr/setup.py
+
+RUN mkdir /pysr/pysr
+ADD ./pysr/*.py /pysr/pysr/
+ADD ./pysr/juliapkg.json /pysr/pysr/juliapkg.json
+
+RUN mkdir /pysr/pysr/_cli
+ADD ./pysr/_cli/*.py /pysr/pysr/_cli/
+
+RUN mkdir /pysr/pysr/test
+
+RUN pip3 install --no-cache-dir .
+
+# Now, we create a custom version of SymbolicRegression.jl
+# First, we get the version from juliapkg.json:
+RUN python3 -c 'import json; print(json.load(open("/pysr/pysr/juliapkg.json", "r"))["packages"]["SymbolicRegression"]["version"])' > /pysr/sr_version
+
+# Remove any = or ^ or ~ from the version:
+RUN cat /pysr/sr_version | sed 's/[\^=~]//g' > /pysr/sr_version_processed
+
+# Now, we check out the version of SymbolicRegression.jl that PySR is using:
+RUN git clone -b "v$(cat /pysr/sr_version_processed)" --single-branch https://github.com/MilesCranmer/SymbolicRegression.jl /srjl
+
+# Edit SymbolicRegression.jl to create a new function.
+# We want to put this function immediately after `module SymbolicRegression`:
+RUN sed -i 's/module SymbolicRegression/module SymbolicRegression\n__test_function() = 2.3/' /srjl/src/SymbolicRegression.jl
+
+# Edit PySR to use the custom version of SymbolicRegression.jl:
+ADD ./pysr/test/generate_dev_juliapkg.py /generate_dev_juliapkg.py
+RUN python3 /generate_dev_juliapkg.py /pysr/pysr/juliapkg.json /srjl
+
+# Precompile
+RUN python3 -c 'import pysr'