Skip to content

Commit 8493208

Browse files
oscarbenjaminoscarbenjamin
authored
Merge pull request #318 from oscarbenjamin/pr_wasm
Add WASM build
2 parents b71d9c2 + 4a347d2 commit 8493208

File tree

12 files changed

+386
-49
lines changed

12 files changed

+386
-49
lines changed

‎.github/workflows/ci-emscripten.yml‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
name: Run Pyodide CI
2+
3+
on:
4+
pull_request:
5+
workflow_dispatch:
6+
7+
env:
8+
FORCE_COLOR: 3
9+
10+
concurrency:
11+
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
12+
# cancel-in-progress: true
13+
14+
jobs:
15+
build:
16+
runs-on: ubuntu-latest
17+
env:
18+
PYODIDE_VERSION: "https://github.com/pyodide/pyodide-build-environment-nightly/releases/download/20250523-emscripten_4.0.9/xbuildenv.tar.bz2"
19+
PYTHON_VERSION: 3.13 # any 3.13.x version works
20+
EMSCRIPTEN_VERSION: 4.0.9
21+
NODE_VERSION: 22
22+
steps:
23+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
24+
25+
- name: Set up Python ${{ env.PYTHON_VERSION }}
26+
uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
27+
with:
28+
python-version: ${{ env.PYTHON_VERSION }}
29+
30+
- name: Set up Emscripten toolchain
31+
uses: mymindstorm/setup-emsdk@6ab9eb1bda2574c4ddb79809fc9247783eaf9021 # v14
32+
with:
33+
version: ${{ env.EMSCRIPTEN_VERSION }}
34+
actions-cache-folder: emsdk-cache
35+
36+
- name: Set up Node.js
37+
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
38+
with:
39+
node-version: ${{ env.NODE_VERSION }}
40+
41+
- name: Install pyodide-build
42+
run: |
43+
pip install pyodide-build
44+
pyodide xbuildenv install --url ${{ env.PYODIDE_VERSION }}
45+
46+
- name: Restore WASM library directory from cache
47+
id: cache-wasm-library-dir
48+
uses: actions/cache/restore@d4323d4df104b026a6aa633fdb11d772146be0bf # v4.2.2
49+
with:
50+
path: ${{ github.workspace }}/wasm-library-dir
51+
key: wasm-library-dir-${{ hashFiles('bin/pyodide_build_dependencies.sh', 'bin/build_variables.sh') }}-0
52+
53+
- name: Build GMP, MPFR and FLINT
54+
if: steps.cache-wasm-library-dir.outputs.cache-hit != 'true'
55+
env:
56+
CFLAGS: "-fPIC"
57+
run: bin/pyodide_build_dependencies.sh --wasm-library-dir ${{ github.workspace }}/wasm-library-dir
58+
59+
- name: Persist WASM library directory to cache
60+
uses: actions/cache/save@d4323d4df104b026a6aa633fdb11d772146be0bf # v4.2.2
61+
with:
62+
path: ${{ github.workspace }}/wasm-library-dir
63+
key: wasm-library-dir-${{ hashFiles('bin/pyodide_build_dependencies.sh', 'bin/build_variables.sh') }}-0
64+
65+
- name: Restore python-flint build directory from cache
66+
uses: actions/cache/restore@d4323d4df104b026a6aa633fdb11d772146be0bf # v4.2.2
67+
with:
68+
path: ${{ github.workspace }}/flint_wasm_build
69+
key: flint-wasm-build-${{ hashFiles('**/meson.build', '**/pyproject.toml', '**/setup.py') }}
70+
71+
- name: Build python-flint
72+
env:
73+
WASM_LIBRARY_DIR: ${{ github.workspace }}/wasm-library-dir
74+
run: |
75+
export PKG_CONFIG_PATH="${{ env.WASM_LIBRARY_DIR }}/lib/pkgconfig:${PKG_CONFIG_PATH}"
76+
export CFLAGS="-I${{ env.WASM_LIBRARY_DIR }}/include ${CFLAGS:-}"
77+
export LDFLAGS="-L${{ env.WASM_LIBRARY_DIR }}/lib -lflint -lmpfr -lgmp ${LDFLAGS:-}"
78+
79+
echo "PKG_CONFIG_PATH=${PKG_CONFIG_PATH}"
80+
echo "CFLAGS=${CFLAGS}"
81+
echo "LDFLAGS=${LDFLAGS}"
82+
83+
pkg-config --modversion python3
84+
pkg-config --modversion mpfr
85+
pkg-config --modversion flint
86+
87+
pyodide build -Cbuild-dir=flint_wasm_build -Csetup-args="-Dflint_version_check=false"
88+
89+
- name: Persist python-flint build directory to cache
90+
uses: actions/cache/save@d4323d4df104b026a6aa633fdb11d772146be0bf # v4.2.2
91+
with:
92+
path: ${{ github.workspace }}/flint_wasm_build
93+
key: flint-wasm-build-${{ hashFiles('**/meson.build', '**/pyproject.toml', '**/setup.py') }}
94+
95+
- name: Set up Pyodide virtual environment and test python-flint
96+
run: |
97+
pyodide venv .venv-pyodide
98+
99+
source .venv-pyodide/bin/activate
100+
pip install dist/*.whl
101+
102+
cd doc
103+
104+
pip install pytest hypothesis
105+
# Don't use the cache provider plugin, as it doesn't work with Pyodide
106+
# right now: https://github.com/pypa/cibuildwheel/issues/1966
107+
pytest -svra -p no:cacheprovider --pyargs flint

‎README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,9 +165,16 @@ Next release (0.9.0)...
165165
Contributors (0.9.0):
166166

167167
- Rémy Oudompheng (RO)
168+
- Agriya Khetarpal (AK)
169+
- Oscar Benjamin (OB)
168170

169171
Changes (0.9.0):
170172

173+
- [gh-318](https://github.com/flintlib/python-flint/pull/318),
174+
Add emscripten build in CI. Polynomial factors and roots are
175+
now sorted into a consistent order for `nmod_poly` and
176+
`fq_default_poly`. Some tests are fixed so that they pass on
177+
32-bit systems. (AK, OB)
171178
- [gh-312](https://github.com/flintlib/python-flint/pull/312),
172179
Add `discriminant` method to `fmpz_poly`, `fmpq_poly` and
173180
`nmod_poly`. (RO)

‎bin/pyodide_build_dependencies.sh‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
#!/bin/bash
2+
3+
set -e
4+
5+
while [[ $# -gt 0 ]]
6+
do
7+
key="$1"
8+
case $key in
9+
-h|--help)
10+
echo "bin/pyodide_build_dependencies.sh [options]"
11+
echo
12+
echo "Build local emscripten installs of python-flint's dependencies."
13+
echo
14+
echo "Supported options:"
15+
echo " --help - show this help message"
16+
echo " --wasm-library-dir <WASM_LIBRARY_DIR> - directory to install libraries"
17+
echo " --flint-commit <FLINT_COMMIT> - flint commit to build"
18+
echo
19+
exit
20+
;;
21+
--wasm-library-dir)
22+
# e.g. --wasm-library-dir /path/to/wasm-library-dir
23+
WASM_LIBRARY_DIR="$2"
24+
shift
25+
shift
26+
;;
27+
--flint-commit)
28+
# e.g. --flint-commit 3.3.1
29+
FLINT_COMMIT="$2"
30+
shift
31+
shift
32+
;;
33+
*)
34+
2>&1 echo "unrecognised argument:" $key
35+
exit 1
36+
;;
37+
esac
38+
done
39+
40+
41+
if [ -z "$WASM_LIBRARY_DIR" ]; then
42+
echo "WASM_LIBRARY_DIR not set"
43+
exit 1
44+
fi
45+
46+
source bin/build_variables.sh
47+
48+
49+
# ---------------------------Build GMP ----------------------------------#
50+
51+
52+
curl -L https://ftp.gnu.org/gnu/gmp/gmp-$GMPVER.tar.xz -o gmp-$GMPVER.tar.xz
53+
tar -xf gmp-$GMPVER.tar.xz
54+
55+
cd gmp-$GMPVER
56+
57+
emconfigure ./configure \
58+
--disable-dependency-tracking \
59+
--host none \
60+
--disable-shared \
61+
--enable-static \
62+
--enable-cxx \
63+
--prefix=$WASM_LIBRARY_DIR
64+
65+
emmake make -j $(nproc)
66+
emmake make install
67+
68+
cd ..
69+
70+
71+
# ---------------------------Build MPFR ----------------------------------#
72+
73+
74+
curl -L https://ftp.gnu.org/gnu/mpfr/mpfr-$MPFRVER.tar.xz -o mpfr-$MPFRVER.tar.xz
75+
tar -xf mpfr-$MPFRVER.tar.xz
76+
77+
cd mpfr-$MPFRVER
78+
79+
emconfigure ./configure \
80+
--disable-dependency-tracking \
81+
--disable-shared \
82+
--with-gmp=$WASM_LIBRARY_DIR \
83+
--prefix=$WASM_LIBRARY_DIR
84+
85+
emmake make -j $(nproc)
86+
emmake make install
87+
88+
cd ..
89+
90+
91+
# ---------------------------Build FLINT----------------------------------#
92+
93+
94+
if [ -z "$FLINT_COMMIT" ]; then
95+
curl -O -L https://github.com/flintlib/flint/releases/download/v$FLINTVER/flint-$FLINTVER.tar.gz
96+
tar xf flint-$FLINTVER.tar.gz
97+
cd flint-$FLINTVER
98+
else
99+
git clone https://github.com/flintlib/flint --branch $FLINT_COMMIT
100+
cd flint
101+
fi
102+
103+
./bootstrap.sh
104+
105+
emconfigure ./configure \
106+
--disable-dependency-tracking \
107+
--disable-shared \
108+
--prefix=$WASM_LIBRARY_DIR \
109+
--with-gmp=$WASM_LIBRARY_DIR \
110+
--with-mpfr=$WASM_LIBRARY_DIR \
111+
--host=wasm32-unknown-emscripten \
112+
--disable-assembly \
113+
--disable-pthread
114+
115+
emmake make -j $(nproc)
116+
emmake make install
117+
118+
cd ..

‎coverage_plugin.py‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,6 @@ class CyFileTracer(FileTracer):
128128
"""File tracer for Cython files (.pyx,.pxd)."""
129129

130130
def __init__(self, srcpath):
131-
print(srcpath)
132131
assert (src_dir / srcpath).exists()
133132
self.srcpath = srcpath
134133

‎src/flint/test/test_all.py‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1939,7 +1939,7 @@ def test_fmpz_mod_dlog():
19391939
F = fmpz_mod_ctx(p)
19401940

19411941
for _ in range(10):
1942-
g = F(random.randint(0,p))
1942+
g = F(random.randint(1,p-1))
19431943
for _ in range(10):
19441944
i = random.randint(0,p)
19451945
a = g**i
@@ -1983,12 +1983,12 @@ def test_fmpz_mod_poly():
19831983

19841984
# Random testing
19851985
f = R1.random_element()
1986-
assert f.degree() == 3
1986+
assert f.degree() <= 3
19871987
f = R1.random_element(degree=5, monic=True)
19881988
assert f.degree() == 5
19891989
assert f.is_monic()
19901990
f = R1.random_element(degree=100, irreducible=True)
1991-
assert f.degree() == 100
1991+
assert f.degree() <= 100
19921992
assert f.is_irreducible()
19931993
f = R1.random_element(degree=1, monic=True, irreducible=True)
19941994
assert f.degree() == 1
@@ -5030,7 +5030,10 @@ def test_fq_default_poly():
50305030
break
50315031
g = f.inverse_mod(h)
50325032
assert f.mul_mod(g, h).is_one()
5033-
assert raises(lambda: f.inverse_mod(2*f), ValueError)
5033+
if f.degree() >= 1:
5034+
assert raises(lambda: f.inverse_mod(2*f), ValueError)
5035+
else:
5036+
assert f.inverse_mod(2*f) == 0 # ???
50345037

50355038
# series
50365039
f_non_square = R_test([nqr, 1, 1, 1])
@@ -5086,10 +5089,13 @@ def test_python_threads():
50865089
# matrices/polynomials that are shared between multiple threads should just
50875090
# be disallowed.
50885091
#
5092+
# This thread is skipped on Emscripten/WASM builds as we can't start new
5093+
# threads in Pyodide.
50895094

5090-
# Skip the test on the free-threaded build...
5095+
# Skip the test on the free-threaded build and on WASM...
50915096
import sys
5092-
if sys.version_info[:2] >= (3, 13) and not sys._is_gil_enabled(): # type: ignore
5097+
if (sys.version_info[:2] >= (3, 13) and not sys._is_gil_enabled()) or ( # type: ignore
5098+
sys.platform == "emscripten" or platform.machine() in ["wasm32", "wasm64"]):
50935099
return
50945100

50955101
from threading import Thread
@@ -5130,7 +5136,6 @@ def test_all_tests():
51305136

51315137

51325138
all_tests = [
5133-
51345139
test_pyflint,
51355140
test_showgood,
51365141

‎src/flint/types/_gr.pyx‎

Lines changed: 36 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1201,21 +1201,25 @@ cdef class gr_nf_ctx(gr_scalar_ctx):
12011201
def new(poly) -> gr_nf_ctx:
12021202
"""Create a new context for number fields.
12031203

1204-
>>> from flint.types._gr import gr_nf_ctx
1205-
>>> Qa = gr_nf_ctx.new([-2, 0, 1])
1206-
>>> Qa
1207-
gr_nf_ctx(x^2 + (-2))
1208-
>>> Qa.modulus()
1209-
x^2 + (-2)
1210-
>>> a = Qa.gen()
1211-
>>> a
1212-
a
1213-
>>> a**2
1214-
2
1215-
>>> (1 + a) ** 2
1216-
2*a+3
1217-
>>> (1 + a) / 2
1218-
1/2*a+1/2
1204+
The doctests below are commented out because they crash under WASM:
1205+
1206+
https://github.com/flintlib/python-flint/issues/319
1207+
1208+
# >>> from flint.types._gr import gr_nf_ctx
1209+
# >>> Qa = gr_nf_ctx.new([-2, 0, 1])
1210+
# >>> Qa
1211+
# gr_nf_ctx(x^2 + (-2))
1212+
# >>> Qa.modulus()
1213+
# x^2 + (-2)
1214+
# >>> a = Qa.gen()
1215+
# >>> a
1216+
# a
1217+
# >>> a**2
1218+
# 2
1219+
# >>> (1 + a) ** 2
1220+
# 2*a+3
1221+
# >>> (1 + a) / 2
1222+
# 1/2*a+1/2
12191223
"""
12201224
poly = fmpq_poly(poly)
12211225
return gr_nf_ctx._new(poly)
@@ -1244,19 +1248,23 @@ cdef class gr_nf_fmpz_poly_ctx(gr_scalar_ctx):
12441248
def new(poly) -> gr_nf_fmpz_poly_ctx:
12451249
"""Create a new context for number fields.
12461250

1247-
>>> from flint.types._gr import gr_nf_fmpz_poly_ctx
1248-
>>> Qa = gr_nf_fmpz_poly_ctx.new([-2, 0, 1])
1249-
>>> Qa
1250-
gr_nf_fmpz_poly_ctx(x^2 + (-2))
1251-
>>> Qa.modulus()
1252-
x^2 + (-2)
1253-
>>> a = Qa.gen()
1254-
>>> a
1255-
a
1256-
>>> a**2
1257-
2
1258-
>>> (1 + a) ** 2
1259-
2*a+3
1251+
The doctests below are commented out because they crash under WASM:
1252+
1253+
https://github.com/flintlib/python-flint/issues/319
1254+
1255+
# >>> from flint.types._gr import gr_nf_fmpz_poly_ctx
1256+
# >>> Qa = gr_nf_fmpz_poly_ctx.new([-2, 0, 1])
1257+
# >>> Qa
1258+
# gr_nf_fmpz_poly_ctx(x^2 + (-2))
1259+
# >>> Qa.modulus()
1260+
# x^2 + (-2)
1261+
# >>> a = Qa.gen()
1262+
# >>> a
1263+
# a
1264+
# >>> a**2
1265+
# 2
1266+
# >>> (1 + a) ** 2
1267+
# 2*a+3
12601268
"""
12611269
poly = fmpz_poly(poly)
12621270
return gr_nf_fmpz_poly_ctx._new(poly)

0 commit comments

Comments
 (0)