pyufunc.find_util_func_by_keyword

pyufunc.find_util_func_by_keyword(keyword=None, verbose=True)

Find all available utility functions in pyufunc by keyword.

Parameters:

• keyword (str | None) –

  the keyword in the utility function. if keyword is empty, it will return total number of utility functions in pyufunc.

  • Recommended keyword include:

    • cvt: convert or conversion

    • fmt: format or formatting

    • is: check if something is something else, e.g., is_digit

    • calc: calculate or calculation

    • get: get or obtain something

    • show: show or display something

    • generate: generate or creation

    • create: create or construction

    • find: find or search something

    • run: run or execute something

    • group: group or clustering something

    • check: check or validation something

    • validate: validate or verification something

    • list: list or enumeration something

    • img: image processing related functions

    • split: split or segmentation something

    • proj: projection related functions

    • github: functions related to github

    • pypi: functions related to pypi

    • error: functions related to error handling

    • algo: functions related to algorithms

    • gmns: functions related to General Modeling Network Specification

    • pytest: functions related pytest usage

• verbose (bool) – whether to print string information. Defaults to True.

Returns:

if verbose is True, print the result string; otherwise return the result list.

Return type:

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
   ...