Merge branch 'master' into fix-updating-best-sol

Author: Joao-Dionisio

.coveragerc

@@ -5,3 +5,4 @@ omit =
     tests
     __init__.py
     scip.pyx
+patch = subprocess

.github/workflows/build_wheels.yml

@@ -44,7 +44,7 @@ jobs:
         uses: pypa/[email protected]
         env:
           CIBW_ARCHS: ${{ matrix.arch }}
-          CIBW_TEST_REQUIRES: pytest
+          CIBW_TEST_GROUPS: test
           CIBW_TEST_COMMAND: "pytest {project}/tests"
           CIBW_MANYLINUX_*_IMAGE: manylinux_2_28
 

.github/workflows/coverage.yml

@@ -36,17 +36,27 @@ jobs:
       - name: Prepare python environment
         run: |
           python -m pip install --upgrade pip
-          python -m pip install networkx cython pytest-cov numpy
+          if python -m pip help install | grep -q -- '--group'; then
+            python -m pip install --group coverage
+          else
+            python -m pip install networkx cython pytest-cov numpy
+          fi
 
       - name: Install PySCIPOpt
         run: |
-          export CFLAGS="-O0 -ggdb" # disable compiler optimizations for faster builds
-          python -m pip install .
+          export CFLAGS="-O0 -ggdb -Wall -Wextra -Werror" # Debug mode. More warnings. Warnings as errors.
+          python -m pip install . -v 2>&1 | tee build.log
+          grep -i "warning" build.log || true
 
       - name: Run pyscipopt tests
         run: |
           sudo apt-get install tzdata locales -y && sudo locale-gen pt_PT && sudo update-locale # add pt_PT locale that is used in tests
-          coverage run -m pytest
+          if python -m pip help install | grep -q -- '--group'; then
+            coverage run -m pytest -nauto
+            coverage combine
+          else
+            coverage run -m pytest
+          fi
           coverage report -m
           coverage xml
       

.github/workflows/integration-test.yml

@@ -34,14 +34,22 @@ jobs:
       - name: Prepare python environment
         run: |
           python -m pip install --upgrade pip
-          python -m pip install networkx pytest-cov numpy
+          if python -m pip help install | grep -q -- '--group'; then
+            python -m pip install --group test-full
+          else
+            python -m pip install networkx pytest-cov numpy
+          fi
 
       - name: Install PySCIPOpt
         run: python -m pip install .
 
       - name: Run pyscipopt tests
         run: |
-          py.test
+          if python -m pip help install | grep -q -- '--group'; then
+            py.test -nauto
+          else
+            py.test
+          fi
 
   Windows-test:
     env:
@@ -69,8 +77,13 @@ jobs:
       - name: Prepare python environment
         shell: powershell
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install networkx pytest-cov numpy
+          $pipHelp = python -m pip help install
+          if ($pipHelp -match '--group') {
+            python -m pip install --group test-full
+          }
+          else {
+            python -m pip install wheel cython networkx pytest-cov
+          }
 
       - name: Install PySCIPOpt
         shell: powershell
@@ -81,7 +94,12 @@ jobs:
       - name: Run pyscipopt tests
         shell: powershell
         run: |
-          py.test
+          $pipHelp = python -m pip help install
+          if ($pipHelp -match '--group') {
+            py.test -nauto
+          } else {
+            py.test
+          }
 
   MacOS-test:
     runs-on: macos-latest
@@ -107,7 +125,11 @@ jobs:
       - name: Prepare python environment
         run: |
           python -m pip install --upgrade pip
-          python -m pip install networkx pytest-cov pytest numpy
+          if python -m pip help install | grep -q -- '--group'; then
+            python -m pip install --group test-full
+          else
+            python -m pip install networkx pytest-cov pytest numpy
+          fi
 
       - name: Install PySCIPOpt
         run: |

.github/workflows/test-release.yml

@@ -28,7 +28,7 @@ jobs:
       - name: Prepare python environment
         run: |
           python -m pip install --upgrade pip
-          python -m pip install wheel cython networkx pytest-cov build
+          python -m pip install wheel cython build
 
       - name: Build package
         run: |

.github/workflows/update-packages-and-documentation.yml

@@ -49,14 +49,22 @@ jobs:
       - name: Prepare python environment
         run: |
           python -m pip install --upgrade pip
-          python -m pip install wheel cython networkx pytest-cov
+          if python -m pip help install | grep -q -- '--group'; then
+            python -m pip install --group test-full
+          else
+            python -m pip install wheel cython networkx pytest-cov
+          fi
 
       - name: Install PySCIPOpt
         run: python -m pip install .
 
       - name: Run pyscipopt tests
         run: |
-          py.test
+          if python -m pip help install | grep -q -- '--group'; then
+            py.test -nauto
+          else
+            py.test
+          fi
 
   windows-test:
     needs: release-integration-test
@@ -86,7 +94,11 @@ jobs:
         shell: powershell
         run: |
           python -m pip install --upgrade pip
-          python -m pip install wheel cython networkx pytest-cov
+          if python -m pip help install | grep -q -- '--group'; then
+            python -m pip install --group test-full
+          else
+            python -m pip install wheel cython networkx pytest-cov
+          fi
       - name: Install PySCIPOpt
         shell: powershell
         run: |
@@ -95,7 +107,11 @@ jobs:
       - name: Run pyscipopt tests
         shell: powershell
         run: |
-          py.test
+          if python -m pip help install | grep -q -- '--group'; then
+            py.test -nauto
+          else
+            py.test
+          fi
 
 
   deploy-packages-and-generate-documentation:
@@ -117,7 +133,7 @@ jobs:
       - name: Prepare python environment
         run: |
           python -m pip install --upgrade pip
-          python -m pip install wheel cython networkx pytest-cov build
+          python -m pip install wheel cython build
 
       - name: Build package
         run: |

CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## Unreleased
 ### Added
+- Added basic type stubs to help with IDE autocompletion and type checking.
+### Fixed
+- Implemented all binary operations between MatrixExpr and GenExpr
+- Fixed the type of @ matrix operation result from MatrixVariable to MatrixExpr.
+### Changed
+- Add a PEP 735 dependency group for test dependencies in `pyproject.toml`
+- Speed up MatrixVariable.sum(axis=None) via quicksum
+- MatrixVariable now supports comparison with Expr
+### Removed
+
+## 5.6.0 - 2025.08.26
+### Added
 - More support for AND-Constraints
 - Added support for knapsack constraints
 - Added isPositive(), isNegative(), isFeasLE(), isFeasLT(), isFeasGE(), isFeasGT(), isHugeValue(), and tests
@@ -11,10 +23,16 @@
 - Wrapped SCIPgetNLPBranchCands
 - Added getConsVals() to get coefficients of any linear type constraint
 - Generalized getLhs() and getRhs() to additionally support any linear type constraint
+- Added recipe for getting local constraints
+- Added enableDebugSol() and disableDebugSol() for controlling the debug solution mechanism if DEBUGSOL=true
+- Added getVarPseudocostScore() and getVarPseudocost()
+- Added getNBranchings() and getNBranchingsCurrentRun()
 ### Fixed
 - Raised an error when an expression is used when a variable is required
+- Fixed some compile warnings
 ### Changed
-- MatrixExpr.sum() now supports axis arguments and can return either a scalar or MatrixExpr depending on the result dimensions
+- MatrixExpr.sum() now supports axis arguments and can return either a scalar or MatrixExpr, depending on the result dimensions.
+- AddMatrixCons() also accepts ExprCons.
 ### Removed
 
 ## 5.5.0 - 2025.05.06

INSTALL.md

@@ -116,17 +116,16 @@ Testing new installation
 ========================
 
 To test your brand-new installation of PySCIPOpt you need
-[pytest](https://pytest.org/) on your system.
+some dependencies which can be installed via pip. The testing
+dependencies are in the `test` dependency group.
 
-    pip install pytest
-
-Here is the complete [installation
-procedure](https://docs.pytest.org/en/latest/getting-started.html).
+    pip install --group test
 
 Tests can be run in the `PySCIPOpt` directory with: :
 
     py.test # all the available tests
     py.test tests/test_name.py # a specific tests/test_name.py (Unix)
+    py.test -nauto # run tests in parallel using all available cores
 
 Ideally, the status of your tests must be passed or skipped. Running
 tests with pytest creates the `__pycache__` directory in `tests` and,

docs/build.rst

@@ -168,28 +168,30 @@ Build with Debug
 To use debug information in PySCIPOpt you need to build it with the following command:
 
 .. code-block::
-
-  python -m pip install --install-option="--debug" .
+  export PYSCIPOPT_DEBUG=True # With Windows CMD: set PYSCIPOPT_DEBUG=True
+  python -m pip install .
 
 .. note:: Be aware that you will need the debug library of the SCIP Optimization Suite for this to work
   (cmake .. -DCMAKE_BUILD_TYPE=Debug).
 
 Testing the Installation
 ==========================
 
-To test your brand-new installation of PySCIPOpt you need `pytest <https://docs.pytest.org/en/stable/>`_
-on your system. To get pytest simply run the command:
+To test your brand-new installation of PySCIPOpt you need to
+install some dependencies via pip. The testing dependencies are in
+the `test` dependency group.
 
 .. code-block:: bash
 
-  pip install pytest
+  pip install --group test
 
 Tests can be run in the PySCIPOpt directory with the commands:
 
 .. code-block:: bash
 
   pytest # Will run all the available tests
   pytest tests/test_name.py # Will run a specific tests/test_name.py (Unix)
+  pytest -nauto # Will run tests in parallel using all available cores
 
 Ideally, the status of your tests must be passed or skipped.
 Running tests with pytest creates the __pycache__ directory in tests and, occasionally,

pyproject.toml

@@ -26,6 +26,21 @@ dynamic = ["version"]
 [project.urls]
 Homepage = "https://github.com/SCIP-Interfaces/PySCIPOpt"
 
+[dependency-groups]
+test = [
+    "pytest",
+    "pytest-xdist",
+]
+test-full = [
+    {"include-group" = "test" },
+    "networkx",  # only needed for a few tests
+]
+coverage = [
+    { "include-group" = "test-full" },
+    "coverage",
+    "cython",
+]
+
 [tool.pytest.ini_options]
 norecursedirs = ["check"]
 testpaths = ["tests"]
@@ -39,16 +54,25 @@ version = {attr = "pyscipopt._version.__version__"}
 [tool.cibuildwheel]
 skip="pp*" # currently doesn't work with PyPy
 manylinux-x86_64-image = "manylinux_2_28"
+manylinux-aarch64-image = "manylinux_2_28"
 
 
 [tool.cibuildwheel.linux]
 skip="pp* cp36* cp37* *musllinux*"
-before-all = [
-    "(apt-get update && apt-get install --yes wget) || yum install -y wget zlib libgfortran || brew install wget",
-    "wget https://github.com/scipopt/scipoptsuite-deploy/releases/download/v0.7.0/libscip-linux.zip -O scip.zip",
-    "unzip scip.zip",
-    "mv scip_install scip"
-    ]
+before-all = '''
+#!/bin/bash
+(apt-get update && apt-get install --yes wget) || yum install -y wget zlib libgfortran || brew install wget
+AARCH=$(uname -m)
+echo "------"
+echo $AARCH
+if [[ $AARCH == "aarch64" ]]; then
+    wget https://github.com/scipopt/scipoptsuite-deploy/releases/download/v0.8.0/libscip-linux-arm.zip -O scip.zip
+else
+    wget https://github.com/scipopt/scipoptsuite-deploy/releases/download/v0.8.0/libscip-linux.zip -O scip.zip
+fi
+unzip scip.zip
+mv scip_install scip
+'''
 environment = { SCIPOPTDIR="$(pwd)/scip", LD_LIBRARY_PATH="$(pwd)/scip/lib:$LD_LIBRARY_PATH", DYLD_LIBRARY_PATH="$(pwd)/scip/lib:$DYLD_LIBRARY_PATH", PATH="$(pwd)/scip/bin:$PATH", PKG_CONFIG_PATH="$(pwd)/scip/lib/pkgconfig:$PKG_CONFIG_PATH", RELEASE="true"}
 
 
@@ -58,10 +82,10 @@ before-all = '''
 #!/bin/bash
 brew install wget zlib gcc
 if [[ $CIBW_ARCHS == *"arm"* ]]; then
-    wget https://github.com/scipopt/scipoptsuite-deploy/releases/download/v0.7.0/libscip-macos-arm.zip -O scip.zip
+    wget https://github.com/scipopt/scipoptsuite-deploy/releases/download/v0.8.0/libscip-macos-arm.zip -O scip.zip
     export MACOSX_DEPLOYMENT_TARGET=14.0
 else
-    wget https://github.com/scipopt/scipoptsuite-deploy/releases/download/v0.7.0/libscip-macos-intel.zip -O scip.zip
+    wget https://github.com/scipopt/scipoptsuite-deploy/releases/download/v0.8.0/libscip-macos-intel.zip -O scip.zip
     export MACOSX_DEPLOYMENT_TARGET=13.0
 fi
 unzip scip.zip
@@ -87,7 +111,7 @@ repair-wheel-command = '''
 skip="pp* cp36* cp37*"
 before-all = [
     "choco install 7zip wget",
-    "wget https://github.com/scipopt/scipoptsuite-deploy/releases/download/v0.7.0/libscip-windows.zip -O scip.zip",
+    "wget https://github.com/scipopt/scipoptsuite-deploy/releases/download/v0.8.0/libscip-windows.zip -O scip.zip",
     "\"C:\\Program Files\\7-Zip\\7z.exe\" x \"scip.zip\" -o\"scip-test\"",
     "mv .\\scip-test\\scip_install .\\test",
     "mv .\\test .\\scip"