pyopencl 2024.1__cp310-cp310-macosx_11_0_arm64.whl → 2024.2__cp310-cp310-macosx_11_0_arm64.whl

pyopencl/__init__.py

@@ -20,16 +20,16 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 """
 
+import logging
 from sys import intern
-from warnings import warn
 from typing import Any, Dict, List, Optional, Sequence, Tuple, Union
-
-from pyopencl.version import VERSION, VERSION_STATUS, VERSION_TEXT  # noqa: F401
+from warnings import warn
 
 # must import, otherwise dtype registry will not be fully populated
 import pyopencl.cltypes  # noqa: F401
+from pyopencl.version import VERSION, VERSION_STATUS, VERSION_TEXT  # noqa: F401
+
 
-import logging
 logger = logging.getLogger(__name__)
 
 # This supports ocl-icd find shipped OpenCL ICDs, cf.
@@ -37,6 +37,8 @@ logger = logging.getLogger(__name__)
 # via
 # https://github.com/inducer/pyopencl/blob/0b3d0ef92497e6838eea300b974f385f94cb5100/scripts/build-wheels.sh#L43-L44
 import os
+
+
 os.environ["PYOPENCL_HOME"] = os.path.dirname(os.path.abspath(__file__))
 
 try:
@@ -50,7 +52,7 @@ except ImportError:
             stacklevel=2)
     raise
 
-import numpy as np
+import numpy as np  # noqa: I003
 
 import sys
 
@@ -168,6 +170,7 @@ from pyopencl._cl import (  # noqa: F401
         Pipe,
         )
 
+
 try:
     from pyopencl._cl import DeviceTopologyAmd  # noqa: F401
     from pyopencl._cl import enqueue_copy_buffer_p2p_amd  # noqa: F401
@@ -176,46 +179,24 @@ except ImportError:
 
 if not _PYPY:
     # FIXME: Add back to default set when pypy support catches up
-    from pyopencl._cl import (  # noqa: F401
-        enqueue_map_buffer,
-        enqueue_map_image,
-        )
+    from pyopencl._cl import enqueue_map_buffer  # noqa: F401
+    from pyopencl._cl import enqueue_map_image  # noqa: F401
 
 if get_cl_header_version() >= (1, 1):
-    from pyopencl._cl import (  # noqa: F401
-        UserEvent,
-        )
+    from pyopencl._cl import UserEvent  # noqa: F401
 if get_cl_header_version() >= (1, 2):
+    from pyopencl._cl import ImageDescriptor  # noqa: F401
     from pyopencl._cl import (  # noqa: F401
-        _enqueue_marker_with_wait_list,
-        _enqueue_barrier_with_wait_list,
-
-        unload_platform_compiler,
-
-
-        enqueue_migrate_mem_objects,
-        _enqueue_fill_buffer,
-        enqueue_fill_image,
-
-        ImageDescriptor,
-        )
+        _enqueue_barrier_with_wait_list, _enqueue_fill_buffer,
+        _enqueue_marker_with_wait_list, enqueue_fill_image,
+        enqueue_migrate_mem_objects, unload_platform_compiler)
 
 if get_cl_header_version() >= (2, 0):
-    from pyopencl._cl import (  # noqa: F401
-        SVMPointer,
-        SVM,
-        SVMAllocation,
-        )
+    from pyopencl._cl import SVM, SVMAllocation, SVMPointer  # noqa: F401
 
 if _cl.have_gl():
     from pyopencl._cl import (  # noqa: F401
-        gl_object_type,
-        gl_texture_info,
-
-        GLBuffer,
-        GLRenderBuffer,
-        GLTexture,
-        )
+        GLBuffer, GLRenderBuffer, GLTexture, gl_object_type, gl_texture_info)
 
     try:
         from pyopencl._cl import get_apple_cgl_share_group  # noqa: F401
@@ -223,15 +204,14 @@ if _cl.have_gl():
         pass
 
     try:
-        from pyopencl._cl import (  # noqa: F401
-            enqueue_acquire_gl_objects,
-            enqueue_release_gl_objects,
-        )
+        from pyopencl._cl import enqueue_acquire_gl_objects  # noqa: F401
+        from pyopencl._cl import enqueue_release_gl_objects  # noqa: F401
     except ImportError:
         pass
 
 import inspect as _inspect
 
+
 CONSTANT_CLASSES = tuple(
         getattr(_cl, name) for name in dir(_cl)
         if _inspect.isclass(getattr(_cl, name))
@@ -266,8 +246,9 @@ class CommandQueueUsedAfterExit(UserWarning):
     pass
 
 
-def compiler_output(text):
-    if int(os.environ.get("PYOPENCL_COMPILER_OUTPUT", "0")):
+def compiler_output(text: str) -> None:
+    from pytools import strtobool
+    if strtobool(os.environ.get("PYOPENCL_COMPILER_OUTPUT", "False")):
         warn(text, CompilerWarning, stacklevel=3)
     else:
         warn("Non-empty compiler output encountered. Set the "
@@ -279,21 +260,21 @@ def compiler_output(text):
 
 # {{{ find pyopencl shipped source code
 
-def _find_pyopencl_include_path():
-    from os.path import join, abspath, dirname, exists
-    try:
-        # Try to find the include path in the same directory as this file
-        include_path = join(abspath(dirname(__file__)), "cl")
-        if not exists(include_path):
-            raise OSError("unable to find pyopencl include path")
-    except Exception:
-        # Try to find the resource with pkg_resources (the recommended
-        # setuptools approach). This is very slow.
-        from pkg_resources import Requirement, resource_filename
-        include_path = resource_filename(
-                Requirement.parse("pyopencl"), "pyopencl/cl")
+def _find_pyopencl_include_path() -> str:
+    from os.path import abspath, dirname, exists, join
+
+    # Try to find the include path in the same directory as this file
+    include_path = join(abspath(dirname(__file__)), "cl")
+    if not exists(include_path):
+        try:
+            # NOTE: only available in Python >=3.9
+            from importlib.resources import files
+        except ImportError:
+            from importlib_resources import files
+
+        include_path = str(files("pyopencl") / "cl")
         if not exists(include_path):
-            raise OSError("unable to find pyopencl include path")
+            raise OSError("Unable to find PyOpenCL include path")
 
     # Quote the path if it contains a space and is not quoted already.
     # See https://github.com/inducer/pyopencl/issues/250 for discussion.
@@ -310,9 +291,6 @@ def _find_pyopencl_include_path():
 def _split_options_if_necessary(options):
     if isinstance(options, str):
         import shlex
-        # shlex.split takes unicode (py3 str) on py3
-        if isinstance(options, bytes):
-            options = options.decode("utf-8")
 
         options = shlex.split(options)
 
@@ -362,7 +340,10 @@ def _options_to_bytestring(options):
 
 # {{{ Program (wrapper around _Program, adds caching support)
 
-_PYOPENCL_NO_CACHE: bool = "PYOPENCL_NO_CACHE" in os.environ
+from pytools import strtobool
+
+
+_PYOPENCL_NO_CACHE = strtobool(os.environ.get("PYOPENCL_NO_CACHE", "false"))
 
 _DEFAULT_BUILD_OPTIONS: List[str] = []
 _DEFAULT_INCLUDE_OPTIONS: List[str] = ["-I", _find_pyopencl_include_path()]
@@ -554,7 +535,7 @@ class Program:
     def _build_and_catch_errors(self, build_func, options_bytes, source=None):
         try:
             return build_func()
-        except _cl.RuntimeError as e:
+        except RuntimeError as e:
             msg = str(e)
             if options_bytes:
                 msg = msg + "\n(options: %s)" % options_bytes.decode("utf-8")
@@ -572,7 +553,7 @@ class Program:
             code = e.code
             routine = e.routine
 
-            err = _cl.RuntimeError(
+            err = RuntimeError(
                     _cl._ErrorRecord(
                         msg=msg,
                         code=code,
@@ -854,7 +835,7 @@ def _add_functionality():
         # }}}
 
         from pyopencl.invoker import generate_enqueue_and_set_args
-        enqueue, my_set_args = \
+        self._enqueue, self.set_args = \
                 generate_enqueue_and_set_args(
                         self.function_name,
                         len(arg_types), self.num_args,
@@ -863,20 +844,6 @@ def _add_functionality():
                         work_around_arg_count_bug=work_around_arg_count_bug,
                         devs=self.context.devices)
 
-        # Make ourselves a kernel-specific class, so that we're able to override
-        # __call__. Inspired by https://stackoverflow.com/a/38541437
-        class KernelWithCustomEnqueue(type(self)):
-            __call__ = enqueue
-            set_args = my_set_args
-
-        try:
-            self.__class__ = KernelWithCustomEnqueue
-        except TypeError:
-            # __class__ assignment may not work in all cases, due to differing
-            # object layouts. Fall back to bouncing through kernel_call below.
-            self._enqueue = enqueue
-            self.set_args = my_set_args
-
     def kernel_get_work_group_info(self, param, device):
         cache_key = (param, device.int_ptr)
         try:
@@ -1555,7 +1522,22 @@ if get_cl_header_version() >= (2, 0):
 
 # {{{ create_some_context
 
-def create_some_context(interactive=None, answers=None):
+def choose_devices(interactive: Optional[bool] = None,
+                   answers: Optional[List[str]] = None) -> List[Device]:
+    """
+    Choose :class:`Device` instances 'somehow'.
+
+    :arg interactive: If multiple choices for platform and/or device exist,
+        *interactive* is ``True`` (or ``None`` and ``sys.stdin.isatty()``
+        returns ``True``), then the user is queried about which device should be
+        chosen. Otherwise, a device is chosen in an implementation-defined
+        manner.
+    :arg answers: A sequence of strings that will be used to answer the
+        platform/device selection questions.
+
+    :returns: a list of :class:`Device` instances.
+    """
+
     if answers is None:
         if "PYOPENCL_CTX" in os.environ:
             ctx_spec = os.environ["PYOPENCL_CTX"]
@@ -1565,7 +1547,7 @@ def create_some_context(interactive=None, answers=None):
             from pyopencl.tools import get_test_platforms_and_devices
             for _plat, devs in get_test_platforms_and_devices():
                 for dev in devs:
-                    return Context([dev])
+                    return [dev]
 
     if answers is not None:
         pre_provided_answers = answers
@@ -1677,7 +1659,27 @@ def create_some_context(interactive=None, answers=None):
 
     if answers:
         raise RuntimeError("not all provided choices were used by "
-                "create_some_context. (left over: '%s')" % ":".join(answers))
+                "choose_device. (left over: '%s')" % ":".join(answers))
+
+    return devices
+
+
+def create_some_context(interactive: Optional[bool] = None,
+                        answers: Optional[List[str]] = None) -> Context:
+    """
+    Create a :class:`Context` 'somehow'.
+
+    :arg interactive: If multiple choices for platform and/or device exist,
+        *interactive* is ``True`` (or ``None`` and ``sys.stdin.isatty()``
+        returns ``True``), then the user is queried about which device should be
+        chosen. Otherwise, a device is chosen in an implementation-defined
+        manner.
+    :arg answers: A sequence of strings that will be used to answer the
+        platform/device selection questions.
+
+    :returns: an instance of :class:`Context`.
+    """
+    devices = choose_devices(interactive, answers)
 
     return Context(devices)
 

pyopencl/algorithm.py

@@ -33,24 +33,22 @@ from dataclasses import dataclass
 from typing import Optional
 
 import numpy as np
+from mako.template import Template
+from pytools import memoize, memoize_method
 
 import pyopencl as cl
 import pyopencl.array
-
 from pyopencl.elementwise import ElementwiseKernel
-from pyopencl.scan import ScanTemplate, GenericScanKernel
+from pyopencl.scan import GenericScanKernel, ScanTemplate
 from pyopencl.tools import dtype_to_ctype, get_arg_offset_adjuster_code
 
-from pytools import memoize, memoize_method
-from mako.template import Template
-
 
 # {{{ "extra args" handling utility
 
 def _extract_extra_args_types_values(extra_args):
     if extra_args is None:
         extra_args = []
-    from pyopencl.tools import VectorArg, ScalarArg
+    from pyopencl.tools import ScalarArg, VectorArg
 
     extra_args_types = []
     extra_args_values = []
@@ -469,7 +467,7 @@ class RadixSort:
         scan_ctype, scan_dtype, scan_t_cdecl = \
                 _make_sort_scan_type(context.devices[0], self.bits, self.index_dtype)
 
-        from pyopencl.tools import VectorArg, ScalarArg
+        from pyopencl.tools import ScalarArg, VectorArg
         scan_arguments = (
                 list(self.arguments)
                 + [VectorArg(arg.dtype, "sorted_"+arg.name) for arg in self.arguments
@@ -927,7 +925,7 @@ class ListOfListsBuilder:
     @memoize_method
     def get_count_kernel(self, index_dtype):
         index_ctype = dtype_to_ctype(index_dtype)
-        from pyopencl.tools import VectorArg, OtherArg
+        from pyopencl.tools import OtherArg, VectorArg
         kernel_list_args = [
                 VectorArg(index_dtype, "plb_%s_count" % name)
                 for name, dtype in self.list_names_and_dtypes
@@ -986,7 +984,7 @@ class ListOfListsBuilder:
     @memoize_method
     def get_write_kernel(self, index_dtype):
         index_ctype = dtype_to_ctype(index_dtype)
-        from pyopencl.tools import VectorArg, OtherArg
+        from pyopencl.tools import OtherArg, VectorArg
         kernel_list_args = []
         kernel_list_arg_values = ""
         user_list_args = []
@@ -1369,7 +1367,7 @@ class KeyValueSorter:
 
     @memoize_method
     def get_kernels(self, key_dtype, value_dtype, starts_dtype):
-        from pyopencl.tools import VectorArg, ScalarArg
+        from pyopencl.tools import ScalarArg, VectorArg
 
         by_target_sorter = RadixSort(
                 self.context, [

pyopencl/array.py

@@ -30,23 +30,22 @@ OTHER DEALINGS IN THE SOFTWARE.
 
 import builtins
 from dataclasses import dataclass
-from warnings import warn
-from numbers import Number
 from functools import reduce
+from numbers import Number
 from typing import Any, Dict, Hashable, List, Optional, Tuple, Union
+from warnings import warn
 
 import numpy as np
-import pyopencl.elementwise as elementwise
 
 import pyopencl as cl
-from pyopencl.compyte.array import (
-        as_strided as _as_strided,
-        f_contiguous_strides as _f_contiguous_strides,
-        c_contiguous_strides as _c_contiguous_strides,
-        equal_strides as _equal_strides,
-        ArrayFlags as _ArrayFlags)
-from pyopencl.characterize import has_double_support
+import pyopencl.elementwise as elementwise
 from pyopencl import cltypes
+from pyopencl.characterize import has_double_support
+from pyopencl.compyte.array import (
+    ArrayFlags as _ArrayFlags, as_strided as _as_strided,
+    c_contiguous_strides as _c_contiguous_strides, equal_strides as _equal_strides,
+    f_contiguous_strides as _f_contiguous_strides)
+
 
 SCALAR_CLASSES = (Number, np.bool_, bool)
 
@@ -56,6 +55,9 @@ else:
     _SVMPointer_or_nothing = ()
 
 
+_NUMPY_PRE_2 = np.__version__.startswith("1.")
+
+
 # {{{ _get_common_dtype
 
 _COMMON_DTYPE_CACHE: Dict[Tuple[Hashable, ...], np.dtype] = {}
@@ -123,7 +125,9 @@ def _get_common_dtype(obj1, obj2, queue):
     # Note that np.find_common_type, while appealing, won't be able to tell
     # the full story.
 
-    if not (o1_is_array and o2_is_array) and o1_is_integral and o2_is_integral:
+    if (_NUMPY_PRE_2
+            and not (o1_is_array and o2_is_array)
+            and o1_is_integral and o2_is_integral):
         if o1_is_array:
             obj1 = np.zeros(1, dtype=o1_dtype)
         if o2_is_array:
@@ -1413,7 +1417,7 @@ class Array:
     def __itruediv__(self, other):
         # raise an error if the result cannot be cast to self
         common_dtype = _get_truedivide_dtype(self, other, self.queue)
-        if not np.can_cast(common_dtype, self.dtype.type):
+        if not np.can_cast(common_dtype, self.dtype.type, "same_kind"):
             raise TypeError(
                 "Cannot cast {!r} to {!r}".format(self.dtype, common_dtype))
 

pyopencl/bitonic_sort.py

@@ -33,14 +33,15 @@ LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 """
 
-import pyopencl as cl
-from pyopencl.tools import dtype_to_ctype
-from operator import mul
 from functools import reduce
-from pytools import memoize_method
+from operator import mul
+
 from mako.template import Template
+from pytools import memoize_method
 
+import pyopencl as cl
 import pyopencl.bitonic_sort_templates as _tmpl
+from pyopencl.tools import dtype_to_ctype
 
 
 def _is_power_of_2(n):

pyopencl/cache.py

@@ -23,24 +23,27 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 """
 
-import re
+import logging
 import os
+import re
 import sys
 from dataclasses import dataclass
 from typing import List, Optional, Tuple
 
 import pyopencl._cl as _cl
 
-import logging
+
 logger = logging.getLogger(__name__)
 
 
 import hashlib
+
+
 new_hash = hashlib.md5
 
 
 def _erase_dir(dir):
-    from os import listdir, unlink, rmdir
+    from os import listdir, rmdir, unlink
     from os.path import join
     for name in listdir(dir):
         unlink(join(dir, name))
@@ -168,7 +171,7 @@ C_INCLUDE_RE = re.compile(r'^\s*\#\s*include\s+[<"](.+)[">]\s*$',
 def get_dependencies(src, include_path):
     result = {}
 
-    from os.path import realpath, join
+    from os.path import join, realpath
 
     def _inner(src):
         for match in C_INCLUDE_RE.finditer(src):
@@ -189,7 +192,7 @@ def get_dependencies(src, include_path):
                     finally:
                         src_file.close()
 
-                    # jrevent infinite recursion if some header file appears to
+                    # prevent infinite recursion if some header file appears to
                     # include itself
                     result[included_file_name] = None
 
@@ -266,7 +269,7 @@ def retrieve_from_cache(cache_dir, cache_key):
     class _InvalidInfoFile(RuntimeError):
         pass
 
-    from os.path import join, isdir
+    from os.path import isdir, join
     module_cache_dir = join(cache_dir, cache_key)
     if not isdir(module_cache_dir):
         return None
@@ -343,25 +346,22 @@ def _create_built_program_from_source_cached(ctx, src, options_bytes,
     from os.path import join
 
     if cache_dir is None:
-        try:
-            import platformdirs as appdirs
-        except ImportError:
-            import appdirs
+        import platformdirs
+
+        # Determine the cache directory in the same way as pytools.PersistentDict,
+        # which PyOpenCL uses for invoker caches.
+        if sys.platform == "darwin" and os.getenv("XDG_CACHE_HOME") is not None:
+            # platformdirs does not handle XDG_CACHE_HOME on macOS
+            # https://github.com/platformdirs/platformdirs/issues/269
+            cache_dir = join(os.getenv("XDG_CACHE_HOME"), "pyopencl")
+        else:
+            cache_dir = platformdirs.user_cache_dir("pyopencl", "pyopencl")
 
-        cache_dir = join(appdirs.user_cache_dir("pyopencl", "pyopencl"),
+        cache_dir = join(cache_dir,
                 "pyopencl-compiler-cache-v2-py{}".format(
                     ".".join(str(i) for i in sys.version_info)))
 
-    # {{{ ensure cache directory exists
-
-    try:
-        os.makedirs(cache_dir)
-    except OSError as e:
-        from errno import EEXIST
-        if e.errno != EEXIST:
-            raise
-
-    # }}}
+    os.makedirs(cache_dir, exist_ok=True)
 
     if devices is None:
         devices = ctx.devices
@@ -513,8 +513,8 @@ def create_built_program_from_source_cached(ctx, src, options_bytes, devices=Non
             raise
 
         if not build_program_failure:
-            from warnings import warn
             from traceback import format_exc
+            from warnings import warn
             warn(
                 "PyOpenCL compiler caching failed with an exception:\n"
                 f"[begin exception]\n{format_exc()}[end exception]",

pyopencl/capture_call.py

@@ -21,9 +21,10 @@ THE SOFTWARE.
 """
 
 
-import pyopencl as cl
 import numpy as np
-from pytools.py_codegen import PythonCodeGenerator, Indentation
+from pytools.py_codegen import Indentation, PythonCodeGenerator
+
+import pyopencl as cl
 
 
 def capture_kernel_call(kernel, output_file, queue, g_size, l_size, *args, **kwargs):
@@ -138,8 +139,8 @@ def capture_kernel_call(kernel, output_file, queue, g_size, l_size, *args, **kwa
 
     # {{{ data
 
-    from zlib import compress
     from base64 import b64encode
+    from zlib import compress
     cg("")
     line_len = 70
 

pyopencl/characterize/__init__.py

@@ -20,10 +20,12 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 """
 
-import pyopencl as cl
-from pytools import memoize
 from typing import Dict, Optional, Tuple
 
+from pytools import memoize
+
+import pyopencl as cl
+
 
 class CLCharacterizationWarning(UserWarning):
     pass

pyopencl/characterize/performance.py

@@ -20,9 +20,10 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 """
 
-import pyopencl as cl
 import numpy as np
 
+import pyopencl as cl
+
 
 # {{{ timing helpers
 

pyopencl/clmath.py

@@ -22,10 +22,11 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 """
 
+import numpy as np
+
 import pyopencl.array as cl_array
 import pyopencl.elementwise as elementwise
 from pyopencl.array import _get_common_dtype
-import numpy as np
 
 
 def _make_unary_array_func(name):