better error messages (as in 9.11.17a0); changed version number to 9.12.11

Author: alanfmw

README.md

@@ -21,7 +21,7 @@ The MATLAB® Engine API for Python® provides a package to integrate MATLA
 MATLAB Engine API for Python can be installed directly from the Python Package Index.
 <!-- MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string) -->
 ```bash
-$ python -m pip install matlabengine==9.12.10
+$ python -m pip install matlabengine==9.12.11
 ```
 
 
@@ -46,7 +46,7 @@ setenv LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:matlabroot/bin/glnxa64
 MATLAB Engine API for Python can be installed directly from the Python Package Index.
 <!-- MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string) -->
 ```bash
-$ python -m pip install matlabengine==9.12.10
+$ python -m pip install matlabengine==9.12.11
 ```
 
 ### macOS
@@ -70,7 +70,7 @@ setenv DYLD_LIBRARY_PATH ${DYLD_LIBRARY_PATH}:matlabroot/bin/maci64
 MATLAB Engine API for Python can be installed directly from the Python Package Index.
 <!-- MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string) -->
 ```bash
-$ python -m pip install matlabengine==9.12.10
+$ python -m pip install matlabengine==9.12.11
 ```
 
 ---

setup.py

@@ -24,7 +24,7 @@ class _MatlabFinder(build_py):
     MATLAB_REL = 'R2022a'
 
     # MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string)
-    MATLAB_VER = '9.12.10' 
+    MATLAB_VER = '9.12.11' 
 
     # MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string)
     SUPPORTED_PYTHON_VERSIONS = set(['3.8', '3.9'])
@@ -52,7 +52,8 @@ class _MatlabFinder(build_py):
     found_matlab = ''
 
     # ERROR MESSAGES
-    minimum_required = "No compatible version of MATLAB was found. This feature supports MATLAB R2019a and later."
+    minimum_maximum = "No compatible version of MATLAB was found. " + \
+        "This feature supports MATLAB {minimum:s} through {maximum:s}, inclusive."
     dir_not_found = "Directory not found: "
     install_compatible = "To install a compatible version, call python -m pip install matlabengine=="
     no_windows_install = "MATLAB installation not found in Windows Registry:"
@@ -61,7 +62,7 @@ class _MatlabFinder(build_py):
     set_path = "MATLAB installation not found in {path1:s}. Add matlabroot/bin/{arch:s} to {path2:s}."
     no_compatible_matlab = "No compatible MATLAB installation found in Windows Registry. This release of " + \
         "MATLAB Engine API for Python is compatible with version {ver:s}. The found versions were"
-    no_matlab = "No MATLAB installation found in Windows Registry."
+    no_matlab = "No compatible MATLAB installation found in Windows Registry."
     incompatible_ver = "MATLAB version {ver:s} was found, but MATLAB Engine API for Python is not compatible with it. " + \
         "To install a compatible version, call python -m pip install matlabengine=={found:s}."
     invalid_version_from_matlab_ver = "Format of MATLAB version '{ver:s}' is invalid."
@@ -171,34 +172,37 @@ def _find_matlab_key_from_windows_registry(self, key):
         found_vers = []
         for idx in range(num_keys):
             sub_key = winreg.EnumKey(key, idx)
-            found_vers.append(sub_key)
-            # Example: the version in the registry could be "9.13.1" whereas our version is "9.13"
-            # we still want to allow this
-            if self._check_matlab_ver_against_engine(sub_key):
-                key_value = sub_key
-                break
+            if sub_key in self.VER_TO_REL:
+                found_vers.append(sub_key)
+                # Example: the version in the registry could be "9.12" whereas the version in this file is "9.12.1".
+                # We want to allow this.
+                if self._check_matlab_ver_against_engine(sub_key):
+                    key_value = sub_key
+                    break
 
         if not key_value:
             if found_vers:
                 vers = ', '.join(found_vers)
-                raise RuntimeError(f"{self.no_compatible_matlab.format(ver=self.MATLAB_VER)} {vers}. {self.install_compatible}{found_vers[-1]}.")
+                raise RuntimeError(f"{self.no_compatible_matlab.format(ver=self._get_engine_ver_major_minor())} {vers}. {self.install_compatible}{found_vers[-1]}.")
             else:
                 raise RuntimeError(f"{self.no_matlab}")
 
         return key_value       
 
-    def _check_matlab_ver_against_engine(self, matlab_ver):
+    def _get_engine_ver_major_minor(self):
         re_major_minor = "^(\d+)\.(\d+)"
-        matlab_ver_match = re.match(re_major_minor, matlab_ver)
-        if not matlab_ver_match:
-            raise RuntimeError(f"{self.invalid_version_from_matlab_ver.format(ver=matlab_ver)}")
         eng_match = re.match(re_major_minor, self.MATLAB_VER)
         if not eng_match:
             raise RuntimeError(f"{self.invalid_version_from_eng.format(ver=self.MATLAB_VER)}")
+        return (eng_match.group(1), eng_match.group(2))
 
+    def _check_matlab_ver_against_engine(self, matlab_ver):
+        re_major_minor = "^(\d+)\.(\d+)"
+        matlab_ver_match = re.match(re_major_minor, matlab_ver)
+        if not matlab_ver_match:
+            raise RuntimeError(f"{self.invalid_version_from_matlab_ver.format(ver=matlab_ver)}")
+        eng_major_minor = self._get_engine_ver_major_minor()
         matlab_ver_major_minor = (matlab_ver_match.group(1), matlab_ver_match.group(2))
-        eng_major_minor = (eng_match.group(1), eng_match.group(2))
-        
         return (matlab_ver_major_minor == eng_major_minor)
 
     def verify_matlab_release(self, root):
@@ -250,9 +254,10 @@ def search_path_for_directory_unix(self):
             if self.found_matlab:
                 if self.found_matlab in self.VER_TO_REL:
                     raise RuntimeError(self.incompatible_ver.format(ver=self.VER_TO_REL[self.found_matlab], found=self.found_matlab))
-                # we found a MATLAB release but it is older than R2019a
+                # We found a MATLAB release but it is older than the oldest version we support,
+                # or newer than the newest version we support.
                 else:
-                    raise RuntimeError(self.minimum_required)
+                    raise RuntimeError(self.minimum_maximum.format(minimum=self.VER_TO_REL[0], maximum=self.VER_TO_REL[-1]))
             else:
                 raise RuntimeError(self.set_path.format(path1=self.path_name, arch=self.arch, path2=self.path_name))
 
@@ -299,7 +304,7 @@ def run(self):
     setup(
         name="matlabengine",
         # MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string)
-        version="9.12.10",
+        version="9.12.11",
         description='A module to call MATLAB from Python',
         author='MathWorks',
         license="MathWorks XSLA License",