lkj 0.1.41__py3-none-any.whl → 0.1.43__py3-none-any.whl

lkj/__init__.py

@@ -40,7 +40,12 @@ from lkj.loggers import (
     wrapped_print,  # Prints a string or list ensuring the total line width does not exceed `max_width`.
     CallOnError,  # Context manager that calls a function on error (subclass of suppress)
 )
-from lkj.importing import import_object, register_namespace_forwarding
+from lkj.importing import (
+    parent_dir_of_module,  # Get the parent directory of a module
+    import_from_path,  # Import a module from a specified path
+    import_object,  # Import an object from a module by its name
+    register_namespace_forwarding,  # Register a namespace forwarding for a module
+)
 from lkj.chunking import chunk_iterable, chunker
 from lkj.misc import identity, value_in_interval
 

lkj/dicts.py

@@ -224,6 +224,10 @@ Comparison = Any
 Comparator = Callable[[dict, dict], Comparison]
 
 
+def _common_keys_list(dict1, dict2):
+    return [k for k in dict1.keys() if k in dict2.keys()]
+
+
 def compare_field_values(
     dict1,
     dict2,
@@ -232,7 +236,8 @@ def compare_field_values(
     default_comparator: Comparator = operator.eq,
     aggregator: Callable[
         [Dict[KT, Comparison]], Any
-    ] = lambda d: d,  # lambda d: np.mean(list(d.values()))
+    ] = lambda d: d,  # lambda d: np.mean(list(d.values())),
+    get_comparison_fields: Callable[[dict], Iterable[KT]] = _common_keys_list,
 ):
     """
     Compare two dictionaries' values field by field
@@ -266,7 +271,7 @@ def compare_field_values(
     0.5
 
     """
-    common_keys = [k for k in dict1.keys() if k in dict2.keys()]
+    common_keys = get_comparison_fields(dict1, dict2)
 
     comparisons = {}
     for key in common_keys:

lkj/importing.py

@@ -1,6 +1,88 @@
 """Tools for importing"""
 
 
+def parent_dir_of_module(module_obj, *, parent_levels: int = 0):
+    """
+    Get the parent directory of a given module object.
+    :param module_obj: The module object for which to find the parent directory.
+    :return: The parent directory of the module as a string.
+
+    >>> import os  # a standard library module
+    >>> parent_dir_of_module(os)  # doctest: +ELLIPSIS
+    '...python...'
+    >>> import lkj # a third-party module
+    >>> parent_dir_of_module(lkj)  # doctest: +ELLIPSIS
+    '.../lkj'
+    """
+    import os
+    import inspect
+
+    # Get the file path of the module
+    module_file = inspect.getfile(module_obj)
+
+    # Get the parent directory
+    parent_dir = os.path.dirname(module_file)
+
+    if parent_levels > 0:
+        for _ in range(parent_levels):
+            parent_dir = os.path.dirname(parent_dir)
+
+    return parent_dir
+
+
+def import_from_path(
+    pkg_path: str = None, *, rootdir: str = "", insert_in_globals: bool = False
+):
+    """
+    Import a package from a specified path.
+
+    :param pkg_path: The path to the package to import. If None, returns a partial function.
+    :param rootdir: The root directory from which to resolve the package path.
+    :param insert_in_globals: If True, insert the imported package into the global namespace.
+    :return: The imported package or a partial function for deferred import.
+    :rtype: module or functools.partial
+    :raises ImportError: If the package cannot be found or imported.
+
+    >>> import os, inspect  # standard library modules (that are surely installed)
+    >>> rootdir = parent_dir_of_module(os)  # get the parent directory of os module
+    >>> os_module = import_from_path('os', rootdir=rootdir)  # doctest: +ELLIPSIS
+    >>> os_module == os
+    True
+
+    >>> import lkj  # a third-party module (that is surely installed)
+    >>> parent_dir_of_lkj = parent_dir_of_module(lkj, parent_levels=2)  # get the great-grandma directory of lkj module
+
+    Make a partial function to import lkj from its parent directory:
+
+    >>> my_import_from_path = import_from_path(rootdir=parent_dir_of_lkj, insert_in_globals=True)
+    >>> lkj_module = my_import_from_path('lkj')
+    >>> assert 'lkj' in globals(), "Module 'lkj' should be imported into globals"
+    >>> lkj_module == lkj
+    True
+    """
+    import sys
+    import os
+    from functools import partial
+
+    if pkg_path is None:
+        return partial(
+            import_from_path, rootdir=rootdir, insert_in_globals=insert_in_globals
+        )
+
+    pkg_rootdir = os.path.join(rootdir, pkg_path)
+    pkg_rootdir = os.path.abspath(pkg_rootdir)
+
+    # Add the directory to sys.path
+    if pkg_rootdir not in sys.path:
+        sys.path.insert(0, pkg_rootdir)  # Use insert(0, ...) to give it high priority
+
+    pkg = __import__(pkg_path)
+
+    if insert_in_globals:
+        globals()[pkg_path] = pkg
+    return pkg
+
+
 def import_object(dot_path: str):
     """Imports and returns an object from a dot string path.
 
@@ -102,10 +184,11 @@ def register_namespace_forwarding(source_base, target_base):
 
     Usage:
 
-        # if you put this code in the imbed.mdat package (say, containing a hcp module),
+        If you put this code in the imbed.mdat package (say, containing a hcp module),
+
         >>> register_namespace_forwarding('imbed.mdat', 'imbed_data_prep')  # doctest: +SKIP
 
-        # Then when you do
+        Then when you do
 
         >>> import imbed.mdat.hcp  # doctest: +SKIP
 

{lkj-0.1.41.dist-info → lkj-0.1.43.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lkj
-Version: 0.1.41
+Version: 0.1.43
 Summary: A dump of homeless useful utils
 Home-page: https://github.com/thorwhalen/lkj
 Author: Thor Whalen

{lkj-0.1.41.dist-info → lkj-0.1.43.dist-info}/RECORD

@@ -1,15 +1,15 @@
-lkj/__init__.py,sha256=Vceal0uY2jW1y0sQHOk1WHXc9aTAEXXOJ9vgyOmnrNk,6868
+lkj/__init__.py,sha256=cGy0S6ZYacRlKA981i_lkqEJzDYSDuNx6LiQfBXvd5k,7104
 lkj/chunking.py,sha256=RpNdx5jEuO4mFg2qoTkD47iL35neBneuZ5xgQ_cBkiM,3755
-lkj/dicts.py,sha256=vmdOXgGVWe3LTz40dHamj7-c8ob4B5SxL3zPJcylf40,10216
+lkj/dicts.py,sha256=z2o7njvLNJkh1ZgSH-SLtz13SdW_YfUsTA1yTY-kVLE,10382
 lkj/filesys.py,sha256=NbWDuc848h8O42gwX7d9yNJkrWBgzSFnkoEdSRgvBAg,8883
 lkj/funcs.py,sha256=LXJlj3gMMsbD0t2gn2NZZ6mOqmW5bxM-94uGoYgrhzI,8930
-lkj/importing.py,sha256=_BFBmdaKCBnk5broltWDeAPeEKG1dEkS8DhIdv6UhSI,3809
+lkj/importing.py,sha256=TcW3qUDmw7jqswpxXnksjlHkkbOJq70NbUk1ZyaafT0,6658
 lkj/iterables.py,sha256=9jeO36w-IGiZryge7JKgXZOGZAgehUvhwKV3nHPcZWk,2801
 lkj/loggers.py,sha256=ImmBdacz89Lvb3dg_xI5jOct_44rSRv0hNI_CVehy60,13706
 lkj/misc.py,sha256=IZf05tkl0cgiMgBwCMH5cLSC59fRXwnemPRo8G0OxQg,1436
 lkj/strings.py,sha256=3YjlxOWUfzWqwu51uq_pv9XZReLqRFvziGtRsdzEtw8,24662
-lkj-0.1.41.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-lkj-0.1.41.dist-info/METADATA,sha256=Tc9RoFOGPs137L9Mw1--sGkVEtmc455ZLx2lHRMqUDc,4684
-lkj-0.1.41.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-lkj-0.1.41.dist-info/top_level.txt,sha256=3DZOUwYmyurJFBXQCvCmEIVm8z2b42O5Sx3RDQyePfg,4
-lkj-0.1.41.dist-info/RECORD,,
+lkj-0.1.43.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+lkj-0.1.43.dist-info/METADATA,sha256=3aKQoeulKxTjgrPcjUzrY6qMbxjHeAAaFlqL__29zgA,4684
+lkj-0.1.43.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+lkj-0.1.43.dist-info/top_level.txt,sha256=3DZOUwYmyurJFBXQCvCmEIVm8z2b42O5Sx3RDQyePfg,4
+lkj-0.1.43.dist-info/RECORD,,