lkj 0.1.37__tar.gz → 0.1.39__tar.gz

{lkj-0.1.37 → lkj-0.1.39}/PKG-INFO

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

{lkj-0.1.37 → lkj-0.1.39}/lkj/__init__.py

@@ -30,13 +30,14 @@ from lkj.strings import (
     truncate_string_with_marker,  # Deprecated: Backcompatibility alias
 )
 from lkj.loggers import (
-    print_with_timestamp,
-    print_progress,
-    log_calls,
-    clog,
+    print_with_timestamp,  # Prints with a timestamp and optional refresh.
+    print_progress,  # an alias often used for print_with_timestamp
+    log_calls,  # Decorator that adds logging before and after the function's call.
+    clog,  # Conditional logger
     ErrorInfo,
-    return_error_info_on_error,
-    wrapped_print,
+    return_error_info_on_error,  # Decorator that returns traceback and local variables on error.
+    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.chunking import chunk_iterable, chunker

{lkj-0.1.37 → lkj-0.1.39}/lkj/loggers.py

@@ -414,3 +414,34 @@ def return_error_info_on_error(
             return error_info_processor(error_info)
 
     return wrapper
+
+
+from contextlib import suppress
+
+
+class CallOnError(suppress):
+    """
+    An extension of the suppress context manager that enables the user to issue a warning
+    message when an import error occurs.
+
+    >>> warn_about_import_errors = CallOnError(ImportError, on_error=lambda err: print(f"Warning: {err}"))
+    >>> with warn_about_import_errors:
+    ...     import this_package_surely_does_not_exist
+    Warning: No module named 'this_package_surely_does_not_exist'
+    >>> with warn_about_import_errors:
+    ...     from os.this_module_does_not_exist import this_function_does_not_exist
+    Warning: No module named 'os.this_module_does_not_exist'; 'os' is not a package
+    """
+
+    def __init__(
+        self,
+        *exceptions,
+        on_error: Callable = print,
+    ):
+        self.on_error = on_error
+        super().__init__(*exceptions)
+
+    def __exit__(self, exctype, excinst, exctb):
+        if exctype is not None:
+            self.on_error(excinst)
+        return super().__exit__(exctype, excinst, exctb)

{lkj-0.1.37 → lkj-0.1.39}/lkj.egg-info/PKG-INFO

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

{lkj-0.1.37 → lkj-0.1.39}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = lkj
-version = 0.1.37
+version = 0.1.39
 url = https://github.com/thorwhalen/lkj
 platforms = any
 description_file = README.md