|
| 1 | +# Copyright (c) 2026, Intel Corporation |
| 2 | +# |
| 3 | +# Redistribution and use in source and binary forms, with or without |
| 4 | +# modification, are permitted provided that the following conditions are met: |
| 5 | +# |
| 6 | +# * Redistributions of source code must retain the above copyright notice, |
| 7 | +# this list of conditions and the following disclaimer. |
| 8 | +# * Redistributions in binary form must reproduce the above copyright |
| 9 | +# notice, this list of conditions and the following disclaimer in the |
| 10 | +# documentation and/or other materials provided with the distribution. |
| 11 | +# * Neither the name of Intel Corporation nor the names of its contributors |
| 12 | +# may be used to endorse or promote products derived from this software |
| 13 | +# without specific prior written permission. |
| 14 | +# |
| 15 | +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 16 | +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 17 | +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| 18 | +# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE |
| 19 | +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 20 | +# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| 21 | +# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| 22 | +# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 23 | +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 24 | + |
| 25 | +"""Persistent patch management for NumPy umath submodule.""" |
| 26 | + |
| 27 | +import site |
| 28 | +import sys |
| 29 | +import warnings |
| 30 | +from pathlib import Path |
| 31 | + |
| 32 | + |
| 33 | +class PatchOperationError(RuntimeError): |
| 34 | + """Raised when a persistent patch operation cannot be completed.""" |
| 35 | + |
| 36 | + |
| 37 | +def get_pth_path(): |
| 38 | + """Get the path to mkl_umath_patch.pth in the appropriate site-packages.""" |
| 39 | + site_packages = site.getsitepackages() |
| 40 | + if site_packages: |
| 41 | + target_site = site_packages[0] |
| 42 | + else: |
| 43 | + target_site = site.getusersitepackages() |
| 44 | + return Path(target_site) / "mkl_umath_patch.pth" |
| 45 | + |
| 46 | + |
| 47 | +PTH_CONTENT = """import mkl_umath._patch_startup""" |
| 48 | + |
| 49 | + |
| 50 | +def install_patch(verbose=False): |
| 51 | + """Install persistent NumPy umath patch using .pth file.""" |
| 52 | + pth_path = get_pth_path() |
| 53 | + |
| 54 | + if pth_path.exists(): |
| 55 | + if verbose: |
| 56 | + warnings.warn( |
| 57 | + f"Persistent patch already installed at {pth_path}", |
| 58 | + UserWarning, |
| 59 | + stacklevel=2, |
| 60 | + ) |
| 61 | + return |
| 62 | + |
| 63 | + try: |
| 64 | + pth_path.parent.mkdir(parents=True, exist_ok=True) |
| 65 | + pth_path.write_text(PTH_CONTENT) |
| 66 | + if verbose: |
| 67 | + print(f"Persistent patch installed at {pth_path}") |
| 68 | + print() |
| 69 | + print("NumPy umath will now use MKL-accelerated implementations in") |
| 70 | + print("all Python sessions. To disable, run:") |
| 71 | + print(" python -m mkl_umath --patch uninstall") |
| 72 | + except OSError as e: |
| 73 | + raise PatchOperationError( |
| 74 | + f"Error installing patch at {pth_path}: {e}\n\n" |
| 75 | + "You may need to run with appropriate permissions or install to " |
| 76 | + "a user site-packages directory." |
| 77 | + ) from e |
| 78 | + |
| 79 | + |
| 80 | +def uninstall_patch(verbose=False): |
| 81 | + """Uninstall persistent NumPy umath patch.""" |
| 82 | + pth_path = get_pth_path() |
| 83 | + |
| 84 | + if not pth_path.exists(): |
| 85 | + if verbose: |
| 86 | + print("No persistent patch found.") |
| 87 | + return |
| 88 | + |
| 89 | + try: |
| 90 | + pth_path.unlink() |
| 91 | + if verbose: |
| 92 | + print(f"Persistent patch removed from {pth_path}") |
| 93 | + print() |
| 94 | + print("NumPy umath will now use the default implementations.") |
| 95 | + except OSError as e: |
| 96 | + raise PatchOperationError( |
| 97 | + f"Error removing patch at {pth_path}: {e}" |
| 98 | + ) from e |
| 99 | + |
| 100 | + |
| 101 | +def check_status(verbose=False): |
| 102 | + """Check if persistent patch is installed.""" |
| 103 | + pth_path = get_pth_path() |
| 104 | + |
| 105 | + if pth_path.exists(): |
| 106 | + if verbose: |
| 107 | + print(f"Persistent patch is installed at {pth_path}") |
| 108 | + print() |
| 109 | + print( |
| 110 | + "NumPy umath is configured to use MKL-accelerated " |
| 111 | + "implementations." |
| 112 | + ) |
| 113 | + return True |
| 114 | + else: |
| 115 | + if verbose: |
| 116 | + print("No persistent patch installed") |
| 117 | + print() |
| 118 | + print("To enable MKL-accelerated NumPy umath globally, run:") |
| 119 | + print(" python -m mkl_umath --patch install") |
| 120 | + return False |
| 121 | + |
| 122 | + |
| 123 | +if __name__ == "__main__": |
| 124 | + if len(sys.argv) < 2: |
| 125 | + print("Usage: python -m mkl_umath.patch <install|uninstall|status>") |
| 126 | + sys.exit(1) |
| 127 | + |
| 128 | + command = sys.argv[1] |
| 129 | + try: |
| 130 | + if command == "install": |
| 131 | + install_patch(verbose=True) |
| 132 | + elif command == "uninstall": |
| 133 | + uninstall_patch(verbose=True) |
| 134 | + elif command == "status": |
| 135 | + sys.exit(0 if check_status(verbose=True) else 1) |
| 136 | + else: |
| 137 | + print(f"Unknown command: {command}") |
| 138 | + sys.exit(1) |
| 139 | + except PatchOperationError as exc: |
| 140 | + print(exc, file=sys.stderr) |
| 141 | + sys.exit(1) |
0 commit comments