R2022b 9.13.1a0

Author: alanfmw

.github/workflows/python-publish.yml

@@ -26,8 +26,17 @@ jobs:
     - name: Build package
       run: python setup.py sdist
 
-    - name: Publish package
+    - name: Publish package to TestPyPI since the "prerelease" checkbox is checked
+      if: "github.event.release.prerelease"
       uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
       with:
         user: __token__
         password: ${{ secrets.MATLABENGINE_TEST_PYPI_TOKEN }}
+        repository_url: https://test.pypi.org/legacy/
+        
+    - name: Publish package to PyPI since the "prerelease" checkbox is unchecked
+      if: "!github.event.release.prerelease"
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.MATLABENGINE_PYPI_TOKEN }}

README.md

@@ -6,11 +6,11 @@ The MATLAB® Engine API for Python® provides a package to integrate MATLA
 ## Requirements
 ### Required MathWorks Products
 <!-- MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string) -->
-* MATLAB release R2022a
+* MATLAB release R2022b
 
 ### Required 3rd Party Products
 <!-- MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string) -->
-* Python 3.8 or 3.9
+* Python 3.8, 3.9, or 3.10
     * Supported Python versions by MATLAB release can be found [here](https://www.mathworks.com/content/dam/mathworks/mathworks-dot-com/support/sysreq/files/python-compatibility.pdf).
 
 ---
@@ -21,15 +21,15 @@ The MATLAB&reg; Engine API for Python&reg; 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
+$ python -m pip install matlabengine==9.13.1a0
 ```
 
 
 
 ### Linux&reg; 
 Prior to installation, check the default install location of MATLAB by calling ```matlabroot``` in a MATLAB Command Window. By default, Linux installs MATLAB at:<br>
 <!-- MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string) -->
-```/usr/local/MATLAB/R2022a```
+```/usr/local/MATLAB/R2022b```
 
 When MATLAB is not installed in the default location, the bin/*architecture* directory within the MATLAB root directory must be added to an environment variable. The path can be added to the environment variable within the shell startup configuration file (for example, .bashrc for bash shell or .tcshrc for tcsh).
 
@@ -46,14 +46,14 @@ 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
+$ python -m pip install matlabengine==9.13.1a0
 ```
 
 ### macOS
 Prior to installation, check the default install location of MATLAB by calling ```matlabroot``` in a MATLAB Command Window. By default, macOS installs MATLAB at:<br>
 
 <!-- MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string) -->
-```/Applications/MATLAB_R2022a.app```
+```/Applications/MATLAB_R2022b.app```
 
 When MATLAB is not installed in the default location, the bin/*architecture* directory within the MATLAB root directory must be added to an environment variable. The path can be added to the environment variable within the shell startup configuration file (for example, .bashrc for bash shell or .tcshrc for tcsh).
 
@@ -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
+$ python -m pip install matlabengine==9.13.1a0
 ```
 
 ---

setup.py

@@ -3,6 +3,7 @@
 from setuptools import setup, find_packages
 from setuptools.command.build_py import build_py 
 import os
+import re
 import sys
 import platform
 import xml.etree.ElementTree as xml
@@ -20,23 +21,21 @@ class _MatlabFinder(build_py):
     }
 
     # MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string)
-    MATLAB_REL = 'R2022a'
+    MATLAB_REL = 'R2022b'
 
     # MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string)
-    MATLAB_VER = '9.12' 
+    MATLAB_VER = '9.13.1a0'
 
     # MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string)
-    SUPPORTED_PYTHON_VERSIONS = set(['3.8', '3.9'])
+    SUPPORTED_PYTHON_VERSIONS = set(['3.8', '3.9', '3.10'])
 
     # MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string)
     VER_TO_REL = {
-        "9.6": "R2019a",
-        "9.7": "R2019b",
-        "9.8": "R2020a",
         "9.9": "R2020b",
         "9.10": "R2021a",
         "9.11": "R2021b",
-        "9.12": "R2022a"
+        "9.12": "R2022a",
+        "9.13": "R2022b"
     }
 
     DEFAULT_INSTALLS = {
@@ -51,7 +50,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 {min_v:s} ({min_r:s}) through {max_v:s} ({max_r: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:"
@@ -60,9 +60,11 @@ 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."
+    invalid_version_from_eng = "Format of MATLAB Engine API version '{ver:s}' is invalid."
 
     def set_platform_and_arch(self):
         """
@@ -168,26 +170,46 @@ 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 sub_key.startswith(self.MATLAB_VER):
-                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.X" whereas the version in this file could be "9.X.Y".
+                # 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]}.")
+                eng_ver_major_minor = self._get_engine_ver_major_minor()
+                eng_ver_major_minor_as_str = '{}.{}'.format(eng_ver_major_minor[0], eng_ver_major_minor[1])
+                raise RuntimeError(f"{self.no_compatible_matlab.format(ver=eng_ver_major_minor_as_str)} {vers}. {self.install_compatible}{found_vers[-1]}.")
             else:
                 raise RuntimeError(f"{self.no_matlab}")
 
         return key_value       
 
+    def _get_engine_ver_major_minor(self):
+        re_major_minor = "^(\d+)\.(\d+)"
+        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))
+        return (matlab_ver_major_minor == eng_major_minor)
+    
     def verify_matlab_release(self, root):
         """
         Parses VersionInfo.xml to verify the MATLAB release matches the supported release
-        for the Python Engine.
+        for the Python Engine. The major and minor version numbers must match. Everything
+        else will be ignored.
         """
         version_info = os.path.join(root, 'VersionInfo.xml')
         if not os.path.isfile(version_info):
@@ -201,10 +223,7 @@ def verify_matlab_release(self, root):
             if child.tag == 'release':
                 matlab_release = self.found_matlab = child.text
                 break
-        
-        if matlab_release != self.MATLAB_REL:
-            return False
-        return True
+        return matlab_release == self.MATLAB_REL
 
     def search_path_for_directory_unix(self):
         """
@@ -225,8 +244,8 @@ def search_path_for_directory_unix(self):
             while not matlab_root and ending_idx < len(endings):
                 ending = endings[ending_idx]
                 if path.endswith(ending):
-                    # _get_matlab_root_from_unix_bin will return an empty string if MATLAB is not found
-                    # non-empty string (MATLAB found) will break both loops
+                    # _get_matlab_root_from_unix_bin will return an empty string if MATLAB is not found.
+                    # Non-empty string (MATLAB found) will break both loops.
                     matlab_root = self._get_matlab_root_from_unix_bin(path)
                 ending_idx += 1
             dir_idx += 1
@@ -235,9 +254,15 @@ 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)
+                    v_to_r_keys = list(self.VER_TO_REL.keys())
+                    min_v = v_to_r_keys[0]
+                    min_r = self.VER_TO_REL[min_v]
+                    max_v = v_to_r_keys[-1]
+                    max_r = self.VER_TO_REL[max_v]
+                    raise RuntimeError(self.minimum_maximum.format(min_v=min_v, min_r=min_r, max_v=max_v, max_r=max_r))
             else:
                 raise RuntimeError(self.set_path.format(path1=self.path_name, arch=self.arch, path2=self.path_name))
 
@@ -284,7 +309,7 @@ def run(self):
     setup(
         name="matlabengine",
         # MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string)
-        version="9.12",
+        version="9.13.1a0",
         description='A module to call MATLAB from Python',
         author='MathWorks',
         license="MathWorks XSLA License",
@@ -310,8 +335,9 @@ def run(self):
             "Intended Audience :: Developers",
             # MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string)
             "Programming Language :: Python :: 3.8",
-            "Programming Language :: Python :: 3.9"
+            "Programming Language :: Python :: 3.9",
+            "Programming Language :: Python :: 3.10"
         ],
         # MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string)
-        python_requires=">=3.8, <3.10"
+        python_requires=">=3.8, <3.11"
     )

src/matlab/engine/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2022 MathWorks, Inc.
+#Copyright 2014-2022 MathWorks, Inc.
 
 """
 The MATLAB Engine enables you to call any MATLAB statement either synchronously
@@ -19,73 +19,63 @@
 """
 
 
+import os
 import sys
 import importlib
 import atexit
+import weakref
 import threading
-import platform
-import os
-
-package_folder = os.path.dirname(os.path.realpath(__file__))
-
-def add_dirs_to_path(bin_dir, engine_dir, extern_dir):
-        """
-        Adds MATLAB engine and extern/bin directories to sys.path.
-        """
-        path = 'PATH'
-
-        if not os.path.isdir(engine_dir):
-            raise RuntimeError("Could not find directory: {0}".format(engine_dir))
-        
-        if not os.path.isdir(extern_dir):
-            raise RuntimeError("Could not find directory: {0}".format(extern_dir))
-        
-        if platform.system() == 'Windows':
-            if not os.path.isdir(bin_dir):
-                raise RuntimeError("Could not find directory: {0}".format(bin_dir))
-            if path in os.environ:
-                paths = os.environ[path]
-                os.environ[path] = bin_dir + os.pathsep + paths
-            else:
-                os.environ[path] = bin_dir
-            if sys.version_info.major >= 3 and sys.version_info.minor >= 8:
-                os.add_dll_directory(bin_dir)
-
-        sys.path.insert(0, engine_dir)
-        sys.path.insert(0, extern_dir)
 
-# MUST_BE_UPDATED_EACH_RELEASE (Search repo for this string)
-_supported_versions = set(['3_8', '3_9'])
+# UPDATE_IF_PYTHON_VERSION_ADDED_OR_REMOVED : search for this string in codebase 
+# when support for a Python version must be added or removed
+_supported_versions = ['2_7', '3_8', '3_9', '3_10']
 _ver = sys.version_info
 _version = '{0}_{1}'.format(_ver[0], _ver[1])
-if _version not in _supported_versions:
-    raise RuntimeError("Python {0}.{1} is not supported. Supported versions " + 
-    'are {2}.'.format(_ver[0], _ver[1, _supported_versions]))
-
-first_exception_message = ''
-second_exception_message = ''
+_PYTHONVERSION = None
+
+if _version in _supported_versions:
+    _PYTHONVERSION = _version
+else:
+    raise EnvironmentError("Python %s is not supported." % _version)
+
+_module_folder = os.path.dirname(os.path.realpath(__file__))
+_arch_filename = os.path.join(_module_folder, "_arch.txt")
+success = False 
+firstExceptionMessage = ''
+secondExceptionMessage = ''
 try:
-    pythonengine = importlib.import_module("matlabengineforpython"+_version)
-except Exception as first_error:
-    first_exception_message = str(first_error)
+    pythonengine = importlib.import_module("matlabengineforpython"+_PYTHONVERSION)
+except Exception as firstE:
+    firstExceptionMessage = str(firstE)
 
-if first_exception_message:
+if firstExceptionMessage:
     try:
-        arch_file = os.path.join(package_folder, '_arch.txt')
-        with open(arch_file, 'r') as root:
-            [arch, bin_folder, engine_folder, extern_bin] = [line.strip() for line in root.readlines()]
-
-        add_dirs_to_path(bin_folder, engine_folder, extern_bin)
-        pythonengine = importlib.import_module("matlabengineforpython"+_version)
-
-    except Exception as second_error:
+        _arch_file = open(_arch_filename,'r')
+        _lines = _arch_file.readlines()
+        [_arch, _bin_dir,_engine_dir, _extern_bin_dir] = [x.rstrip() for x in _lines if x.rstrip() != ""]
+        _arch_file.close()
+        sys.path.insert(0,_engine_dir)
+        sys.path.insert(0,_extern_bin_dir)
+
+        _envs = {'win32': 'PATH', 'win64': 'PATH'}
+        if _arch in _envs:
+            if _envs[_arch] in os.environ:
+                _env = os.environ[_envs[_arch]]
+                os.environ[_envs[_arch]] = _bin_dir + os.pathsep + os.environ[_envs[_arch]]
+            else:
+                os.environ[_envs[_arch]] = _bin_dir
+            if sys.version_info.major >= 3 and sys.version_info.minor >= 8:
+                os.add_dll_directory(_bin_dir)
+        pythonengine = importlib.import_module("matlabengineforpython"+_PYTHONVERSION)
+    except Exception as secondE:
         str1 = 'Please reinstall MATLAB Engine for Python or contact '
         str2 = 'MathWorks Technical Support for assistance:\nFirst issue: {}\nSecond issue: {}'.format(
-            first_exception_message, second_error)
-        second_exception_message = str1 + str2
+            firstExceptionMessage, secondE)
+        secondExceptionMessage = str1 + str2
+
+if secondExceptionMessage:        
+    raise EnvironmentError(secondExceptionMessage)
 
-if second_exception_message:        
-    raise EnvironmentError(second_exception_message)
 
 """
 This lock can make sure the global variable _engines is updated correctly in