Make it compile on Windows

.github/workflows/dist.yml

@@ -23,8 +23,7 @@ jobs:
         run: |
           bash -x .install-pari.sh
         env:
-          PARI_VERSION: pari-2.17.1
-          URLDIR: unix
+          PARI_VERSION: pari-2.17.2
       - uses: actions/setup-python@v4
       - name: make sdist
         run: |

.github/workflows/main.yml

@@ -1,4 +1,4 @@
-name: cypari2
+name: CI
 
 on:
     pull_request:
@@ -15,34 +15,122 @@ concurrency:
 
 jobs:
     build:
+        name: Build and Test (${{ matrix.os }}, Python ${{ matrix.python-version }}, PARI ${{ matrix.pari-version }})
         runs-on: ${{ matrix.os }}
         strategy:
             fail-fast: false
             matrix:
                 os: [ubuntu-latest]
                 python-version: ['3.10', '3.11', '3.12', '3.13']
-                pari-version: ['pari-2.13.0', 'pari-2.15.4', 'pari-2.15.5', '2.17.2']
+                pari-version: ['2.13.0', '2.15.4', '2.15.5', '2.17.2']
+                include:
+                  - os: macos-latest
+                    python-version: '3.10'
+                    pari-version: '2.17.2' # Whatever comes with homebrew
+                  - os: macos-latest
+                    python-version: '3.13'
+                    pari-version: '2.17.2' # Whatever comes with homebrew
+                  - os: windows-latest
+                    python-version: '3.12' # Whatever comes with msys2
+                    pari-version: '2.15.4'
+                  - os: windows-latest
+                    python-version: '3.12' # Whatever comes with msys2
+                    pari-version: '2.17.2'
         env:
           LC_ALL: C
           PARI_VERSION: ${{ matrix.pari-version }}
+        defaults:
+          run:
+            shell: ${{ matrix.os == 'windows-latest' && 'msys2 {0}' || 'bash' }}
         steps:
         - name: Set up the repository
           uses: actions/checkout@v4
+        - name: Setup MSYS2
+          if: runner.os == 'Windows'
+          id: msys2
+          uses: msys2/setup-msys2@v2
+          with:
+              msystem: UCRT64
+              update: true
+              install: >-
+                base-devel
+                m4
+                bison
+                make
+                patch
+                sed
+                wget
+                mingw-w64-ucrt-x86_64-toolchain
+                mingw-w64-ucrt-x86_64-gmp
+                mingw-w64-ucrt-x86_64-python
+                mingw-w64-ucrt-x86_64-python-pip
+                mingw-w64-ucrt-x86_64-meson-python
+                mingw-w64-ucrt-x86_64-cython
+              path-type: inherit
         - name: Set up Python ${{ matrix.python-version }}
+          if: runner.os != 'Windows'
           uses: actions/setup-python@v4
           with:
             python-version: ${{ matrix.python-version }}
-        - name: Install pari
+        - name: Install PARI
+          if: matrix.os != 'macos-latest'
+          run: |         
+            bash -x .install-pari.sh
+        - name: Install PARI
+          if: matrix.os == 'macos-latest'
+          run: |
+            brew install pari
+        - name: Smoke test PARI
           run: |
-              bash -x .install-pari.sh
-        - name: Local build
+            if [ ${{ runner.os }} = macOS ]; then
+              HOMEBREW=`brew --prefix`
+              gcc -v tests/test.c -o test -I$HOMEBREW/include -L$HOMEBREW/lib -lpari -lgmp 
+              export C_INCLUDE_PATH=$HOMEBREW/include
+              export LIBRARY_PATH=$HOMEBREW/lib:$HOMEBREW/Cellar/pari/${{ matrix.pari-version }}/lib:$LIBRARY_PATH
+              gcc -v tests/test.c -o test -lpari -lgmp
+            else
+              gcc -v tests/test.c -o test -I/usr/local/include -L/usr/local/bin -lpari -lgmp
+            fi
+            expected="zeta(2) = 1.6449340668482264364
+            p = x^3 + x^2 + x - 1
+            modulus = y^3 + y^2 + y - 1
+            centerlift(lift(fq)) = [x - y, 1; x + (y^2 + y - 1), 1; x + (-y^2 - 1), 1]"
+            output="$(./test)"
+            # Normalize newlines for comparison
+            output="$(echo "$output" | tr -d '\r')"
+            expected="$(echo "$expected" | tr -d '\r')"
+            echo -e "Got:\n$output"
+            if [ "$output" != "$expected" ]; then
+              echo "Unexpected output from test.c"
+              echo -e "Expected:\n$expected"
+              exit 1
+            fi
+        - name: Build
+          run: |
+            if [ ${{ runner.os }} = Windows ]; then
+              export C_INCLUDE_PATH=$(cygpath -am "${{ steps.msys2.outputs.msys2-location }}")/usr/local/include
+              export LIBRARY_PATH=$(cygpath -am "${{ steps.msys2.outputs.msys2-location }}")/usr/local/bin
+            elif [ ${{ runner.os }} = macOS ]; then
+              HOMEBREW=`brew --prefix`
+              export C_INCLUDE_PATH=$HOMEBREW/include
+              ls -l $HOMEBREW/lib
+              export DYLD_LIBRARY_PATH=$HOMEBREW/lib:$HOMEBREW/Cellar/pari/${{ matrix.pari-version }}/lib:$LIBRARY_PATH
+            fi
+            echo $PATH
+            echo $C_INCLUDE_PATH
+            echo $LIBRARY_PATH
+            which python
+            python -m pip install -v .
+        - name: Test
           run: |
-            make install
             make check
+        - name: Build docs
+          run: |
             pip install sphinx
             (cd docs && make html)
 
     dist:
+        name: Build source distribution
         runs-on: ubuntu-latest
         steps:
           - name: Check out ${{ env.SPKG }}
@@ -56,7 +144,7 @@ jobs:
               sudo DEBIAN_FRONTEND=noninteractive apt-get update
               sudo DEBIAN_FRONTEND=noninteractive apt-get install $DIST_PREREQ
               python3 -m pip install build
-          - name: Run make dist, prepare upstream artifact
+          - name: Build dist, prepare upstream artifact
             run: |
               (cd build/pkgs/${{ env.SPKG }}/src && python3 -m build --sdist) \
               && mkdir -p upstream && cp build/pkgs/${{ env.SPKG }}/src/dist/*.tar.gz upstream/${{ env.SPKG }}-git.tar.gz \
@@ -69,6 +157,7 @@ jobs:
               name: upstream
 
     sage:
+        name: Test with Sage
         uses: sagemath/sage/.github/workflows/docker.yml@develop
         with:
           targets:           SAGE_CHECK=no SAGE_CHECK_PACKAGES="cypari" cypari

.gitignore

@@ -1,20 +1,3 @@
-# Autogenerated files
-# (either by Cython or autogen)
-cypari2/auto_gen.pxi.tmp
-cypari2/auto_gen.pxi
-cypari2/auto_instance.pxi.tmp
-cypari2/auto_instance.pxi
-cypari2/auto_paridecl.pxd.tmp
-cypari2/auto_paridecl.pxd
-cypari2/closure.c
-cypari2/convert.c
-cypari2/custom_block.c
-cypari2/gen.c
-cypari2/handle_error.c
-cypari2/pari_instance.c
-cypari2/stack.c
-cypari2/string_utils.c
-
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.install-pari.sh

@@ -1,24 +1,112 @@
-# Helper script to install PARI for github workflows
+#!/bin/bash
+
+# Helper script to install PARI (e.g. for CI builds).
+# On macOS: the default system gcc is used
+# On Linux: the default system gcc is used
+# On Windows: uses the ucrt64 toolchain in Msys2
 
 # Exit on error
 set -e
 
-if [ "$URLDIR" = "" ]; then
-    PURE_VERSION=${PARI_VERSION/pari-}
-    URLDIR=OLD/${PURE_VERSION%.*}
+# Detect platform
+PLATFORM="unknown"
+case "$(uname -s)" in
+    MSYS_NT*|MINGW*)
+        PLATFORM="msys"
+        ;;
+    Linux)
+        PLATFORM="linux"
+        ;;
+    Darwin)
+        PLATFORM="macos"
+        ;;
+    *)
+        echo "Unknown platform"
+        exit 1
+        ;;
+esac
+
+# Run the script again in UCRT64 system for msys
+if [ "$ucrt" != "0" ] && [ "$PLATFORM" = "msys" ]; then
+    MSYSTEM=UCRT64 MSYS2_PATH_TYPE=inherit bash --login -c "cd $pwd ; $self"
+fi
+
+# Windows conda prefix is not added to path automatically
+# thus mingw compiler is not found later
+if [ -n "$CONDA_PREFIX" ]; then
+    export PATH="$(cygpath "$CONDA_PREFIX")/Library/bin:$PATH"
 fi
 
+if [ "$PARI_VERSION" = "" ]; then
+    PARI_VERSION=2.17.2
+fi
+
+PURE_VERSION=${PARI_VERSION/pari-}
+URLDIR=OLD/${PURE_VERSION%.*}
+
 PARI_URL="https://pari.math.u-bordeaux.fr/pub/pari/$URLDIR"
 PARI_URL1="https://pari.math.u-bordeaux.fr/pub/pari/unix"
 PARI_URL2="https://pari.math.u-bordeaux.fr/pub/pari/unstable"
 
-# Download PARI sources
-wget --no-verbose "$PARI_URL/$PARI_VERSION.tar.gz" -O pari.tgz || wget --no-verbose "$PARI_URL1/pari-$PARI_VERSION.tar.gz" -O pari.tgz || wget --no-verbose "$PARI_URL2/pari-$PARI_VERSION.tar.gz" -O pari.tgz
+if [ -d build/pari-$PURE_VERSION ] ; then
+    echo "Using existing pari-$PURE_VERSION build directory"
+    cd "build/pari-$PURE_VERSION"
+else
+    echo "Download PARI sources"
+    if [ ! -d build ] ; then
+        mkdir build
+    fi
+    cd build
+    wget --no-verbose "$PARI_URL/$PURE_VERSION.tar.gz" -O "pari-$PURE_VERSION.tgz" \
+        || wget --no-verbose "$PARI_URL1/pari-$PURE_VERSION.tar.gz" -O "pari-$PURE_VERSION.tgz" \
+        || wget --no-verbose "$PARI_URL2/pari-$PURE_VERSION.tar.gz" -O "pari-$PURE_VERSION.tgz" \
+        || wget --no-verbose "$PARI_URL/pari-$PURE_VERSION.tar.gz" -O "pari-$PURE_VERSION.tgz"
+    tar xzf "pari-$PURE_VERSION.tgz"
+    cd "pari-$PURE_VERSION"
+fi
+
+echo "Building Pari ..."
+if [ "$PLATFORM" = "msys" ]; then
+    # Remove "export_file='$(LIBPARI).def';" line from config/Makefile.SH"
+    # Otherwise we get a Segmentation Fault during the resulting dlltool call
+    sed -i.bak "/export_file='\\\$(LIBPARI).def';/d" config/Makefile.SH
+fi
+# For debugging:
+# export CFLAGS="-g"
+if [[ "$PLATFORM" = "msys" ]]; then
+  # If one installs in a non-default location, then one needs to call os.add_dll_directory
+  # in Python to find the DLLs.
+  CONFIG_ARGS="--without-readline --prefix=$MSYSTEM_PREFIX"
+else
+  CONFIG_ARGS="--prefix=/usr"
+fi
+./Configure $CONFIG_ARGS
+
+# On Windows, disable UNIX-specific code in language files
+# (not sure why UNIX is defined)
+lang_es="src/language/es.c"
+if [ -f "$lang_es" ] && [ "$PLATFORM" = "msys" ]; then
+    sed -i.bak \
+        -e 's/#if[[:space:]]*defined(UNIX)/#if 0/' \
+        -e 's/#ifdef[[:space:]]*UNIX/#if 0/' \
+        "$lang_es"
+fi
+
 
-# Install
-mkdir Pari42
-tar xzf pari.tgz -C Pari42
-cd Pari42/*
-./Configure --prefix=/usr
-make gp
-sudo make install
+if [ "$PLATFORM" = "msys" ]; then
+    # Windows
+    cd Omingw-x86_64
+    make install-lib-dyn
+    make install-include
+    make install-doc
+    make install-cfg
+
+    # Fix location of libpari.dll.a
+    if [ -f "$MSYSTEM_PREFIX/bin/libpari.dll.a" ]; then
+        cp "$MSYSTEM_PREFIX/bin/libpari.dll.a" "$MSYSTEM_PREFIX/lib/"
+    fi
+else
+    # Linux or macOS
+    make gp
+    sudo make install
+fi

README.rst

@@ -42,10 +42,30 @@ From source with pip
 
 Requirements:
 
-  PARI/GP >= 2.9.4 (header files and library); see
+- PARI/GP >= 2.9.4 (header files and library); see
   https://doc.sagemath.org/html/en/reference/spkg/pari#spkg-pari
   for availability in distributions (GNU/Linux, conda-forge, Homebrew, FreeBSD),
-  or install from source.
+  or install from source (e.g using the script ``.install-pari.sh`` provided in this
+  repository).
+- gmp (if PARI/GP was built with gmp)
+- A C compiler (GCC)
+- pkg-config
+- Python >= 3.9
+- pip
+
+On Windows, we recommend to use MSYS2, which can be installed from
+`Rtools <https://cran.r-project.org/bin/windows/Rtools/>`_.
+Afterwards, start the MSYS2 (UCRT64) terminal and install the above
+dependencies via
+::
+
+    $ pacman -Syu
+    $ pacman -S mingw-w64-ucrt-x86_64-toolchain mingw-w64-ucrt-x86_64-gmp mingw-w64-ucrt-x86_64-python mingw-w64-ucrt-x86_64-python-pip mingw-w64-ucrt-x86_64-meson-python mingw-w64-ucrt-x86_64-cython mingw-w64-ucrt-x86_64-wget
+    $ pacman -S bison # for building pari from source
+    $ .install-pari.sh
+    $ export C_INCLUDE_PATH=/usr/local/include
+    $ export LIBRARY_PATH=/usr/local/bin
+
 
 Install cypari2 via the Python Package Index (PyPI) via
 
@@ -66,6 +86,22 @@ If you want to try the development version, use
 
     $ pip install git+https://github.com/sagemath/cypari2.git [--user]
 
+or clone the repository and run
+::
+
+    $ python -m venv venv
+    $ source venv/bin/activate
+    $ pip install "meson-python>=0.18.0" "cython>=3.0" "cysignals>=1.11.3" "ninja>=1.8.2"
+    $ pip install -e . --no-build-isolation
+
+If you run into certification issues on Windows, you can try to
+upgrade the certifi package via
+::
+
+    $ pip install --upgrade certifi
+    $ export SSL_CERT_FILE=$(python -m certifi)
+
+and then retry the installation.
 
 Usage
 -----
@@ -143,14 +179,28 @@ CyPari 2 is maintained by the SageMath community.
 Open issues or submit pull requests at https://github.com/sagemath/cypari2
 and join https://groups.google.com/group/sage-devel to discuss.
 
-To get started with development, you can set up an environment using Conda 
-as follows:
+To get started with development, you can use the provided ``environment.yml`` 
+file to create the full development environment including build backend, 
+compilers, and documentation dependencies:
 
 ::
-    $ conda create -n cypari2-dev python cython pari=*=*_pthread ninja meson-python cysignals c-compiler
+
+    $ conda env create -f environment.yml
     $ conda activate cypari2-dev
+    $ pip install -e . --no-build-isolation
 
-Afterwards, you can build and install the package in editable mode: 
+On Windows, you can use ``environment-win.yml`` and you may also need to set a
+few environment variables:
 
 ::
+    $ conda env create -f environment-win.yml
+    $ conda activate cypari2-dev
+    $ set LIBRARY_PATH=%CONDA_PREFIX%\Library\lib;%LIBRARY_PATH%
+    $ set C_INCLUDE_PATH=%CONDA_PREFIX%\Library\include;%C_INCLUDE_PATH%
     $ pip install -e . --no-build-isolation
+
+To update an existing environment after changes to ``environment.yml``:
+
+::
+
+    $ conda env update -f environment.yml --prune