Make src/setup.py respect --build-base and --inplace, independent of SAGE_CYTHONIZED

[mkoeppe]

This is a follow-up on #21480, which put src/setup.py in charge of all sagelibbuilding and removed dependencies on various environment variables, as a step towards the goal of making sagelib an ordinary Python package (#21507).

However, there is still a dependency on $SAGE_CYTHONIZED, which needs to be set in a way that matches the build-base (set by setup.py build --build-base).

This dependency should be removed.

Also, --inplace should be supported.
(See also: #12659: build the sage library in place)

See also #21508 on other cleanup issues of src/setup.py.

Depends on #21480
Depends on #21600
Depends on #21604
Depends on #23744

CC: @jdemeyer @embray

Component: build

Author: Jeroen Demeyer

Branch/Commit: bd91b43

Reviewer: Matthias Koeppe

Issue created by migration from https://trac.sagemath.org/ticket/21535

[embray]

comment:1

I think I've brought this up with jdemeyer before, who had some objections (I think where I brought it up originally was in the context of cysignals, but same applies to sage itself). Ultimately what it came down to is that he prefers the source tree to always be clean of build artifacts, which I can certainly respect. But I don't personally have a problem like that, and like to be able to use ./setup.py build_ext --inplace for in-place testing, which I find cuts down on time spent in the "edit-build-install" cycle.

In any case, these are subjective preferences for development practice, and I think either way should work--eliminating dependency on $SAGE_CYTHONIZED should be a step in the right direction.

[mkoeppe]

comment:2

Replying to @embray:

Ultimately what it came down to is that [jdemeyer] prefers the source tree to always be clean of build artifacts, which I can certainly respect. But I don't personally have a problem like that, and

I also like to keep the source tree clean, which is why I usually use VPATH builds. I have created #21469 for that.

like to be able to use ./setup.py build_ext --inplace for in-place testing, which I find cuts down on time spent in the "edit-build-install" cycle.

Thanks for pointing out --inplace. I'll look into this.

[mkoeppe]

Dependencies: #21480, #21600, #21604

[mkoeppe]

Description changed:

--- 
+++ 
@@ -1,7 +1,9 @@
 This is a follow-up on #21480, which put `src/setup.py` in charge of all `sagelib`building and removed dependencies on various environment variables, as a step towards the goal of making `sagelib` an ordinary Python package (#21507). 
 
-However, there is still a dependency on `$SAGE_CYTHONIZED`, which needs to be set in a way that matches the build-base (set by setup.py build --build-base).
+However, there is still a dependency on `$SAGE_CYTHONIZED`, which needs to be set in a way that matches the build-base (set by `setup.py build --build-base`).
 
 This dependency should be removed.
 
+Also, `--inplace` should be supported.
+
 See also #21508 on other cleanup issues of `src/setup.py`. 

[embray]

comment:4

#21682 might help with this one--it makes SAGE_CYTHONIZED mostly irrelevant IMO.

[mkoeppe]

Description changed:

--- 
+++ 
@@ -5,5 +5,6 @@
 This dependency should be removed.
 
 Also, `--inplace` should be supported.
+(See also: #12659: build the sage library in place)
 
 See also #21508 on other cleanup issues of `src/setup.py`. 

[embray]

comment:6

I should be able to fix this with or without #21682, though I think it helps.

[jdemeyer]

comment:7

Wouldn't it be easier to fix with #21682, given that you are adding a --build-dir option?

[embray]

comment:8

Yes, it would be easier.

[embray]

comment:9

So what would be the impact of removing SAGE_CYTHONIZED entirely? As far as I can tell it is only really used by setup.py/sage_setup. Implementing this ticket makes it pretty pointless I think--it makes SAGE_CYTHONIZED not even make sense, really.

Would it be a problem to outright remove it? Or does it need to still be supported somehow?

[mkoeppe]

comment:10

+1 for getting rid of SAGE_CYTHONIZED completely if you can.

[mkoeppe]

comment:11

Erik and Jeroen, given that #21682 (setup.py build_cython) is merged, can we now get rid of SAGE_CYTHONIZED and support setup.py build --build-base?

[embray]

comment:12

I'd be all for that. Do you need me to work on it?

[jdemeyer]

Changed dependencies from #21480, #21600, #21604 to #21480, #21600, #21604, #23744