Fix debian build with python 3.10 and deprecate distutils

Summary is that distutils has been deprecated for a while and will be
removed in 3.12. setuptools is its replacement. However its use as an
installation mechanism, e.g. *calling* setup.py install with CLI
arguments is also being deprecated - with no good alternative (yet)
being available. Since the whole world still depends on it I don't
expect the latter to go away any time soon though, but it does seem to
no longer care about fixing things for that frontend
which is what now cause prefix arguments to not work as expected
(installing things in /usr/local/ whilst specifying --prefix=/usr),
which breaks the building of Debian packages. What Debian/Ubuntu seem
to have done is patch setuptools to make it keep on behaving as they want,
but only if you provide --install-layout=deb. So now providing that
argument for all calls of "python setup.py install" in the Debian build.

This would have also worked in combination with distutils, but taking
this opportunity to upgrade to setuptools (since we'll have to soon
anyway). These are changes by @Patol75, taken from
FluidityProject/fluidity#351.

Author: stephankramer

debian/rules

@@ -70,23 +70,13 @@ install-prereq:
 	dh_installdirs -a 
 
 install-python%:
-# Force setuptools, but reset sys.argv[0] to 'setup.py' because setup.py files expect that.
-	cd diamond;python$* -c "import setuptools,sys;f='setup.py';sys.argv[0]=f;exec(open(f,'r').read(),{'__file__':f,'__name__':'__main__'})" install --prefix=/usr --no-compile --single-version-externally-managed --root=$(CURDIR)/debian/${PACKAGE_NAME}
-	if [ -d debian/${PACKAGE_NAME}/usr/lib/python$*/site-packages/${MODULE_NAME}-${DEB_UPSTREAM_VERSION}.egg-info ]; then \
-	    mv debian/${PACKAGE_NAME}/usr/lib/python$*/site-packages  debian/${PACKAGE_NAME}/usr/lib/python$*/dist-packages ; \
-	    mv debian/${PACKAGE_NAME}/usr/lib/python$*/dist-packages/${MODULE_NAME}-${DEB_UPSTREAM_VERSION}.egg-info		 debian/${PACKAGE_NAME}/usr/lib/python$*/dist-packages/${MODULE_NAME}.egg-info ; \
-	elif [ -d debian/${PACKAGE_NAME}/usr/lib/python$*/site-packages/${MODULE_NAME}-${DEB_UPSTREAM_VERSION}-py$*.egg-info ]; then \
-	    mv debian/${PACKAGE_NAME}/usr/lib/python$*/site-packages  debian/${PACKAGE_NAME}/usr/lib/python$*/dist-packages ; \
-	    mv debian/${PACKAGE_NAME}/usr/lib/python$*/dist-packages/${MODULE_NAME}-${DEB_UPSTREAM_VERSION}-py$*.egg-info		 debian/${PACKAGE_NAME}/usr/lib/python$*/dist-packages/${MODULE_NAME}.egg-info ; \
-	else \
-	    echo "Failed to locate python egg, was it built correctly?" && exit 1 ; \
-	fi
+	cd diamond; python$* setup.py install --prefix=/usr --no-compile --single-version-externally-managed --root=$(CURDIR)/debian/${PACKAGE_NAME} --install-layout=deb
 
 install-pyspud:
 	$(MAKE) install-pyspud DESTDIR=$(CURDIR)/debian/python3-spud BUILDING_DEBIAN=yes
 
 install-dxdiff:
-	$(MAKE) install-dxdiff DESTDIR=$(CURDIR)/debian/python3-dxdiff
+	$(MAKE) install-dxdiff DESTDIR=$(CURDIR)/debian/python3-dxdiff BUILDING_DEBIAN=yes
 
 binary-arch: build-libspud install-libspud install-spudtools install-pyspud
 	dh_testdir
@@ -135,5 +125,8 @@ binary-indep: build-spud-diamond install-spud-diamond build-libspud install-libs
 
 binary: binary-indep binary-arch
 
+build-arch: binary-arch
+build-indep: binary-indep
+
 
 .PHONY: build clean binary-indep binary-arch binary-spud-diamond binary-libspud install configure

diamond/setup.py.in

@@ -1,20 +1,19 @@
-from distutils.core import setup
-from distutils.extension import Extension
-import os
-import os.path
-import glob
+from glob import glob
+from os import listdir
+from os.path import isdir, join
+from setuptools import setup
+from sys import argv, platform
 
 # There are a number of local hacks in this file, to deal with the multiple
-# ways in which setup.py is called by various scripts and packaging methods 
+# ways in which setup.py is called by various scripts and packaging methods
 # that interact with spud, enabling setuptools to grok their intentions.
 
 # In some cases, we will be passed a 'DESTDIR' from an upstream packagaing
 # system. This will be a local directory to install into, and act as local '/'
-# as far as all paths are concerned. Check for this, and fail nicely if not set.
+# as far as all paths are concerned. Check for this and fail nicely if not set.
 
 prefix = None
-import sys
-packaging=False
+packaging = False
 
 # We may also be given prefix, either as a configuration option (which will be
 # dealt with by substitutions later) or as a command line option. If a command
@@ -27,9 +26,9 @@ packaging=False
 # parsed if present, and supercedes any previous DESTDIR picked up from
 # environment.
 
-for i, arg in enumerate(sys.argv):
-  if "--prefix" in arg:
-    prefix = arg.split('=')[1]
+for i, arg in enumerate(argv):
+    if "--prefix" in arg:
+        prefix = arg.split('=')[1]
 
 # Given the above prefix possibilities, as well as root and DESTDIR, we need to
 # construct a list of data directories to be installed
@@ -43,45 +42,43 @@ for i, arg in enumerate(sys.argv):
 # on the command line in preference to the configure prefix.
 
 # First parse the plugin directories
-plugin_dirs = [dir for dir in os.listdir('plugins') if os.path.isdir(os.path.join('plugins', dir)) and dir[0] != '.']
+plugin_dirs = [dir for dir in listdir('plugins')
+               if isdir(join('plugins', dir)) and dir[0] != '.']
 plugin_data_files = []
-if sys.platform == 'darwin' and packaging:
-	for plugin in plugin_dirs:
-  		plugin_data_files.append(("./plugins/" + plugin,
-		  glob.glob('plugins/' + plugin + '/*.py')))
+if platform == 'darwin' and packaging:
+    for plugin in plugin_dirs:
+        plugin_data_files.append(("./plugins/" + plugin,
+                                  glob('plugins/' + plugin + '/*.py')))
 else:
-	for plugin in plugin_dirs:
-	  if prefix is None:
-            plugin_data_files.append(("@prefix@/share/diamond/plugins/" + plugin,
-                                      glob.glob('plugins/' + plugin + '/*.py')))
-	  else:
-            plugin_data_files.append((prefix + "/share/diamond/plugins/" + plugin,
-                                      glob.glob('plugins/' + plugin + '/*.py')))
+    for plugin in plugin_dirs:
+        if prefix is None:
+            plugin_data_files.append(
+                ("@prefix@/share/diamond/plugins/" + plugin,
+                 glob('plugins/' + plugin + '/*.py')))
+        else:
+            plugin_data_files.append(
+                (prefix + "/share/diamond/plugins/" + plugin,
+                 glob('plugins/' + plugin + '/*.py')))
 
 # Now parse the GUI directories
 gui_data_files = []
-if sys.platform == 'darwin' and packaging	:
-  gui_data_files.append(("./gui",
-    ["gui/gui.ui", "gui/diamond.svg", "gui/diamond.png"]))
+if platform == 'darwin' and packaging:
+    gui_data_files.append(
+        ("./gui", ["gui/gui.ui", "gui/diamond.svg", "gui/diamond.png"]))
 else:
-	if prefix is None:
-	  gui_data_files.append(("@prefix@/share/diamond/gui",
-		["gui/gui.ui", "gui/diamond.svg"]))
-	else:
-	  gui_data_files.append((prefix + "/share/diamond/gui",
-		["gui/gui.ui", "gui/diamond.svg"]))
+    if prefix is None:
+        gui_data_files.append(("@prefix@/share/diamond/gui",
+                               ["gui/gui.ui", "gui/diamond.svg"]))
+    else:
+        gui_data_files.append((prefix + "/share/diamond/gui",
+                               ["gui/gui.ui", "gui/diamond.svg"]))
 
 # We now have all the information we need; run setup.
-setup(
-      name='diamond',
-      version='1.0',
+setup(name='diamond', version='1.0',
       description="Fluidity preprocessor",
-      author = "The ICOM team",
-      author_email = "patrick.farrell@imperial.ac.uk",
-      url = "http://amcg.ese.ic.ac.uk",
-      packages = ['diamond'],
-      package_dir = {'diamond': 'diamond'},
+      author="The ICOM team",
+      author_email="patrick.farrell@imperial.ac.uk",
+      url="http://amcg.ese.ic.ac.uk", packages=['diamond'],
+      package_dir={'diamond': 'diamond'},
       scripts=["bin/diamond"],
-      data_files = gui_data_files + plugin_data_files
-     )
-
+      data_files=gui_data_files + plugin_data_files)

dxdiff/setup.py

@@ -1,21 +1,10 @@
-from distutils.core import setup
-import os
-import os.path
-import glob
+from setuptools import setup
 
-try:
-  destdir = os.environ["DESTDIR"]
-except KeyError:
-  destdir = ""
-
-setup(
-      name='dxdiff',
+setup(name='dxdiff',
       version='1.0',
-      description="An XML aware diff tool.",
-      author = "The ICOM team",
-      author_email = "fraser.waters08@imperial.ac.uk",
-      url = "http://amcg.ese.ic.ac.uk",
-      packages = ['dxdiff'],
-      scripts=["dxdiff/dxdiff"],
-     )
-
+      description="An XML aware diff tool",
+      author="The ICOM team",
+      author_email="fraser.waters08@imperial.ac.uk",
+      url="http://amcg.ese.ic.ac.uk",
+      packages=['dxdiff'],
+      scripts=["dxdiff/dxdiff"])

python/libspud.c

@@ -11,7 +11,7 @@
 #define PyString_Type PyUnicode_Type
 #define PyString_AsString PyUnicode_AsUTF8
 #define PyString_Check PyUnicode_Check
-#define PyString_GET_SIZE PyUnicode_GET_SIZE
+#define PyString_GET_SIZE PyUnicode_GET_LENGTH
 #endif
 
 static PyObject *SpudError;
@@ -360,7 +360,7 @@ spud_get_option_aux_scalar_or_string(const char *key, int key_len, int type, int
         int i;
         for (i = 0; i < size+1; i++)
           val[i] = '\0';
-          
+
         outcomeGetOption = spud_get_option(key, key_len, val);
         if (error_checking(outcomeGetOption, "get option aux scalar or string") == NULL){
             return NULL;
@@ -478,7 +478,7 @@ libspud_get_option(PyObject *self, PyObject *args)
     if (error_checking(outcomeGetOptionShape, "get option") == NULL){
         return NULL;
     }
-    
+
     if (rank == -1){ // type error
         char errormessage [MAXLENGTH];
         snprintf(errormessage, MAXLENGTH, "Error: The specified option has a different \
@@ -506,7 +506,7 @@ libspud_get_option(PyObject *self, PyObject *args)
         }
         else if (type == SPUD_INT){  //a tensor of ints
             return spud_get_option_aux_tensor_ints(key, key_len, type, rank, shape);
-        } 
+        }
     }
 
     PyErr_SetString(SpudError,"Error: Get option failed.");
@@ -562,7 +562,7 @@ set_option_aux_list_doubles(PyObject *pylist, const char *key, int key_len, int
 static PyObject*
 set_option_aux_string(PyObject *pystring, const char *key, int key_len, int type, int rank, int *shape)
 {   // this function is for setting option when the second argument is of type string
-    char *val = PyString_AsString(pystring);
+    const char *val = PyString_AsString(pystring);
     int outcomeSetOption = spud_set_option(key, key_len, val, type, rank, shape);
     return error_checking(outcomeSetOption, "set option aux string");
 }
@@ -613,10 +613,10 @@ set_option_aux_tensor_doubles(PyObject *pylist, const char *key, int key_len, in
     int outcomeSetOption;
 
     int size = shape[0]*shape[1];
-    
+
     double element;
     double val [size];
-    
+
     for (i = 0; i < shape[0]; i++){
         PyObject* pysublist = PyList_GetItem(pylist, i);
         for (j = 0; j < shape[1]; j++){
@@ -687,7 +687,7 @@ libspud_set_option(PyObject *self, PyObject *args)
     int shape[2];
     PyObject* firstArg;
     PyObject* secondArg;
-    
+
     if(PyTuple_GET_SIZE(args)!=2){
         PyErr_SetString(SpudError,"Error: set_option takes exactly 2 arguments.");
         return NULL;
@@ -697,19 +697,19 @@ libspud_set_option(PyObject *self, PyObject *args)
     secondArg = PyTuple_GetItem(args, 1);
     PyArg_Parse(firstArg, "s", &key);
     key_len = strlen(key);
-    
+
     if (!spud_have_option(key, key_len)){ //option does not exist yet
         int outcomeAddOption = spud_add_option(key, key_len);
         error_checking(outcomeAddOption, "set option");
-    } 
-    
+    }
+
     if (PyInt_Check(secondArg)){ //just an int
         type = SPUD_INT;
         rank = 0;
         shape[0] = -1;
         shape[1] = -1;
-            
-    }       
+
+    }
     else if (PyString_Check(secondArg)){// a string
         type = SPUD_STRING;
         rank = 1;
@@ -745,13 +745,13 @@ libspud_set_option(PyObject *self, PyObject *args)
             }
             else if (PyFloat_Check(sublistElement)){//list of lists of doubles
                 type = SPUD_DOUBLE;
-            }            
+            }
             rank = 2;
             shape[0] = pylistSize;
             shape[1] = pysublistSize;
         }
     }
-    
+
     if (rank == 0){ // scalar
         set_option_aux_scalar(secondArg, key, key_len, type, rank, shape);
     }
@@ -761,10 +761,10 @@ libspud_set_option(PyObject *self, PyObject *args)
         }
         else if (type == SPUD_INT) { // list of ints
             set_option_aux_list_ints(secondArg, key, key_len, type, rank, shape);
-        }    
+        }
         else if (type == SPUD_DOUBLE){ // list of doubles
             set_option_aux_list_doubles(secondArg, key, key_len, type, rank, shape);
-        } 
+        }
     }
     else if (rank == 2){ // tensor
         if (type == SPUD_DOUBLE) { // tensor of doubles
@@ -907,5 +907,3 @@ initlibspud(void)
 #endif
 
 }
-
-

python/setup.py

@@ -1,9 +1,10 @@
-from distutils.core import setup, Extension
-import os.path
+from os.path import abspath
+from setuptools import setup, Extension
 
-module1 = Extension('libspud', sources = ['libspud.c'], libraries=["spud"], library_dirs=[os.path.abspath("..")], include_dirs=[os.path.abspath("../include")])
-
-setup (name = 'libspud',
-       version = '1.1.3',
-       description = 'Python bindings for libspud',
-       ext_modules = [module1])
+setup(name='libspud',
+      version='1.1.3',
+      description='Python bindings for libspud',
+      ext_modules=[Extension('libspud', sources=['libspud.c'],
+                             libraries=["spud"],
+                             library_dirs=[abspath("..")],
+                             include_dirs=[abspath("../include")])])