add find_func_by_keyword

pyufunc/__init__.py

@@ -67,7 +67,9 @@
     "util_pathio"         : __util_pathio.__all__,
     "util_test"           : __util_test.__all__,
     "util_vis"            : __util_vis.__all__,
-    "pkg_utils"           : __pkg_utils.__all__ + ["show_util_func_by_category", "show_util_func_by_keyword"],
+    "pkg_utils"           : __pkg_utils.__all__ + ["show_util_func_by_category",
+                                                   "show_util_func_by_keyword",
+                                                   "find_func_by_keyword"],
 }
 
 
@@ -165,4 +167,42 @@ def show_util_func_by_keyword(verbose: bool = True) -> None:
         return None
     return res_str
 
+
+def find_func_by_keyword(keyword: str, verbose: bool = True) -> list:
+    """find all available utility functions in pyufunc by keyword.
+
+    Args:
+        keyword (str): the keyword
+        verbose (bool, optional): whether to print string information. Defaults to True.
+
+    Returns:
+        list: if verbose is True, print the result string; otherwise return the result list.
+
+    Examples:
+        >>> import pyufunc as uf
+        >>> uf.find_func_by_keyword("show")
+        Available functions by keyword: show
+           - show_numpy_docstring_style
+           - show_available_utility_func
+           ...
+    """
+
+    res_str_by_keyword = ""
+    res_str_lst = []
+    ufunc_count = 0
+
+    for func_str in list(chain.from_iterable(ufunc_category.values())):
+        if keyword.lower() in func_str.lower():
+            res_str_by_keyword += f"  \n{ufunc_count + 1}. {func_str}\n"
+            res_str_lst.append(func_str)
+            ufunc_count += 1
+
+    if verbose:
+        res_str_head = f"Available functions by keyword: {keyword}"
+        res_str = res_str_head + f" ({ufunc_count}):\n" + res_str_by_keyword
+
+        print(res_str)
+        return ""
+    return res_str_lst
+
 __all__ = list(chain(*ufunc_category.values()))

pyufunc/util_img/__init__.py

@@ -5,5 +5,18 @@
 # Author/Copyright: Mr. Xiangyong Luo
 ##############################################################
 
+from ._img_cvt import (
+    cvt_img_to_bytes,
+    cvt_PIL_img_to_bytes,
+    cvt_img_bytes_to_PIL_img,
+)
 
-__all__ = []
+__all__ = [
+    # _img_cvt
+    "cvt_img_to_bytes",
+    "cvt_PIL_img_to_bytes",
+    "cvt_img_bytes_to_PIL_img",
+
+    # _img_rotate
+
+]

pyufunc/util_img/_img_cvt.py

@@ -4,11 +4,16 @@
 # Contact Info: [email protected]
 # Author/Copyright: Mr. Xiangyong Luo
 ##############################################################
-
-
-from PIL import Image
+from __future__ import annotations
+from typing import TYPE_CHECKING
 import io
 
+# https://stackoverflow.com/questions/61384752/how-to-type-hint-with-an-optional-import
+if TYPE_CHECKING:
+    # check the support version of python
+    # https://pillow.readthedocs.io/en/stable/installation.html
+    from PIL import Image
+
 
 def cvt_img_to_bytes(img_path: str) -> bytes:
     """Convert image to bytes

requirements_dev.txt

@@ -12,4 +12,7 @@ Shapely>=2.0.3
 sphinx_multiproject>=1.0.0rc1
 urllib3>=2.2.1
 tqdm
-pyufunc
+pyufunc
+
+pillow
+opencv-python