numbox 0.1.2__py3-none-any.whl → 0.1.3__py3-none-any.whl

numbox/core/proxy.py

@@ -0,0 +1,87 @@
+import inspect
+from llvmlite import ir  # noqa: F401
+from numba import njit
+from numba.core import cgutils  # noqa: F401
+from numba.core.typing.templates import Signature
+from numba.extending import intrinsic  # noqa: F401
+from types import FunctionType as PyFunctionType
+from typing import List, Optional, Tuple
+
+
+def make_proxy_name(name):
+    return f'__{name}'
+
+
+def make_params_strings(func):
+    func_params = inspect.signature(func).parameters
+    func_params_str = ', '.join(
+        [k if v.default == inspect._empty else f'{k}={v.default}' for k, v in func_params.items()]
+    )
+    func_names_params_str = ', '.join(func_params.keys())
+    return func_params_str, func_names_params_str
+
+
+def proxy(sig, jit_options: Optional[dict] = None):
+    """ Create a proxy for the decorated function `func` with the given signature(s) `sig`.
+
+    The original function `func` will be eagerly JIT-compiled with the given signature(s).
+    A proxy with the name `func_proxy_name` will be created to call `func` in the LLVM scope.
+    The original function's variable will be bound to the proxy, i.e., calling the decorated
+    function will call the proxy.
+
+    The proxy is a JIT-compiled wrap that invokes the intrinsic that *declares* the `func`
+    and calls it with the original arguments. Declaration instructions are relatively cheap
+    to statically link into (potential) caller's LLVM code, which is the main motivation behind
+    this decorator.
+
+    Machine code for `func` can be cached when so specified in `jit_options`, in which case its
+    JIT-compilation will load the `func` into the LLVM scope. Caching option is the other major
+    motivation for this decorator, without the need to cache one can avoid static linking
+    of the callee's LLVM code into the caller's by simply ignoring the former.
+
+    In case when more than one signature is provided as the `sig` parameter, it is assumed
+    that the first signature is the 'main' one while the other ones are supplied to
+    allow for the `Omitted` types with default values for (some of) the parameters.
+
+    See tests for some examples of the use cases.
+    """
+    main_sig = isinstance(sig, Signature) and sig or isinstance(sig, (List, Tuple)) and sig[0]
+    jit_options = isinstance(jit_options, dict) and jit_options or {}
+    jit_opts = jit_options.copy()
+    jit_opts.update(jit_opts, inline='always')
+
+    def wrap(func):
+        assert isinstance(func, PyFunctionType)
+        func_jit = njit(sig, **jit_options)(func)
+        llvm_cfunc_wrapper_name = func_jit.get_compile_result(main_sig).fndesc.llvm_cfunc_wrapper_name
+        func_args_str, func_names_args_str = make_params_strings(func)
+        func_proxy_name = make_proxy_name(func.__name__)
+        code_txt = f"""
+@intrinsic
+def _{func_proxy_name}(typingctx, {func_names_args_str}):
+    def codegen(context, builder, signature, args):
+        func_ty_ll = ir.FunctionType(
+            context.get_data_type(main_sig.return_type),
+            [context.get_data_type(arg) for arg in main_sig.args]
+        )
+        f = cgutils.get_or_insert_function(builder.module, func_ty_ll, "{llvm_cfunc_wrapper_name}")
+        return builder.call(f, args)
+    return main_sig, codegen
+
+@njit(sig, **jit_opts)
+def {func_proxy_name}({func_args_str}):
+    return _{func_proxy_name}({func_names_args_str})
+"""
+        ns = {
+            **inspect.getmodule(func).__dict__,
+            **{
+                'cgutils': cgutils, 'intrinsic': intrinsic, 'ir': ir, 'jit_opts': jit_opts, 'njit': njit,
+                'sig': sig, 'main_sig': main_sig
+            }
+        }
+        if ns.get(func_proxy_name) is not None:
+            raise ValueError(f"Name {func_proxy_name} in module {inspect.getmodule(func)} is reserved")
+        code = compile(code_txt, inspect.getfile(func), mode='exec')
+        exec(code, ns)
+        return ns[func_proxy_name]
+    return wrap

{numbox-0.1.2.dist-info → numbox-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: numbox
-Version: 0.1.2
+Version: 0.1.3
 Author: Mikhail Goykhman
 License: MIT License (with Citation Clause)
         
@@ -36,4 +36,15 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 
 # numbox
-A toolbox of low-level utilities for work with numba
+
+A toolbox of low-level utilities for working with [numba](https://numba.pydata.org/).
+
+## Tools
+
+- **Any**: A lightweight structure that wraps any value into the same type leveraging a variant of the type erasure technique.
+- **proxy**: Create a proxy for a decorated function with specified signatures, enabling efficient JIT compilation and caching.
+
+## Installation
+
+```bash
+pip install numbox

numbox-0.1.3.dist-info/RECORD

@@ -0,0 +1,14 @@
+numbox/__init__.py,sha256=uZsygMXMKRw-7qhWojAjnpm8GFPXU92xW6XA8O5GwFY,22
+numbox/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+numbox/core/any_type.py,sha256=CvEwFk7EcuFwg5VqDJrYQYmWp_t3Kil92wC7gUOEl-Y,1711
+numbox/core/declare_func.py,sha256=zjlou3avyybHvpqNfp9D1_1kaOxLiGSxXtxiXlLsSPQ,150876
+numbox/core/meminfo.py,sha256=-b7wlCRyqOZjvKjEuwNwzqE4XvnEWxu3I2k4DEP3Cqk,1755
+numbox/core/proxy.py,sha256=kGYlEdLK40lxxu56e_S32s9YuQ6AuQnFegt5uQrUw5w,3889
+numbox/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+numbox/utils/highlevel.py,sha256=hAmF2y2ayPJT0qpwHrGDt09R4-6Ts9sTkCTh-8FTIUU,319
+numbox/utils/lowlevel.py,sha256=6CRfFbMeBZGM7hqPAQzyClzU_e_IsNpqONJknFWGzJM,1405
+numbox-0.1.3.dist-info/LICENSE,sha256=YYgNvjH_p6-1NsdrIqGJnr1GUbZzA_8DxsP6vVfM6nY,1446
+numbox-0.1.3.dist-info/METADATA,sha256=VOYJC8CJ4qWajTGPcv7LkzoefGEqWHY13rjvtQM354I,2271
+numbox-0.1.3.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+numbox-0.1.3.dist-info/top_level.txt,sha256=A67jOkfqidCSYYm6ifjN_WZyIiR1B27fjxv6nNbPvjc,7
+numbox-0.1.3.dist-info/RECORD,,

numbox-0.1.2.dist-info/RECORD

@@ -1,12 +0,0 @@
-numbox/__init__.py,sha256=mdp2CftfqYbdKtP-eWv1z7rAUycYv6X1ntXSMUf8Kss,22
-numbox/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-numbox/core/any_type.py,sha256=CvEwFk7EcuFwg5VqDJrYQYmWp_t3Kil92wC7gUOEl-Y,1711
-numbox/core/meminfo.py,sha256=-b7wlCRyqOZjvKjEuwNwzqE4XvnEWxu3I2k4DEP3Cqk,1755
-numbox/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-numbox/utils/highlevel.py,sha256=hAmF2y2ayPJT0qpwHrGDt09R4-6Ts9sTkCTh-8FTIUU,319
-numbox/utils/lowlevel.py,sha256=6CRfFbMeBZGM7hqPAQzyClzU_e_IsNpqONJknFWGzJM,1405
-numbox-0.1.2.dist-info/LICENSE,sha256=YYgNvjH_p6-1NsdrIqGJnr1GUbZzA_8DxsP6vVfM6nY,1446
-numbox-0.1.2.dist-info/METADATA,sha256=-xVLPSJg3MLfTBO61O1pEzpgA8wa9fPIxGp0abcpVEs,1926
-numbox-0.1.2.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-numbox-0.1.2.dist-info/top_level.txt,sha256=A67jOkfqidCSYYm6ifjN_WZyIiR1B27fjxv6nNbPvjc,7
-numbox-0.1.2.dist-info/RECORD,,