UBelt documentation¶
UBelt is a “utility belt” of commonly needed utility and helper functions. It is a currated collection of top-level utilities with functionality that falls into a mixture of categories.
The source code is available at https://github.com/Erotemic/ubelt. We also have Jupyter notebook demos.
The ubelt API is organized by submodules containing related functionality. Each submodule contains top level overview documentation, and each function contains a docstring with at least one example.
The API by usefulness¶
Perhaps the most useful way to learn this API is to sort by “usefulness”. I measure usefulness as the number of times I’ve used a particular function in my own code (excluding ubelt itself).
The API by submodule¶
Alternatively you might prefer a module-based approach where functions are grouped based on similar functionality.
ubelt.util_const
¶
ubelt.NoParam()
ubelt.util_dict
¶
ubelt.AutoDict()
ubelt.AutoOrderedDict()
ubelt.dzip()
ubelt.ddict()
ubelt.dict_hist()
ubelt.dict_subset()
ubelt.dict_union()
ubelt.dict_isect()
ubelt.dict_diff()
ubelt.find_duplicates()
ubelt.group_items()
ubelt.invert_dict()
ubelt.map_keys()
ubelt.map_vals()
ubelt.odict()
ubelt.util_import
¶
ubelt.split_modpath()
ubelt.modname_to_modpath()
ubelt.modpath_to_modname()
ubelt.import_module_from_name()
ubelt.import_module_from_path()
ubelt.util_list
¶
ubelt.chunks()
ubelt.iterable()
ubelt.take()
ubelt.compress()
ubelt.flatten()
ubelt.unique()
ubelt.argunique()
ubelt.unique_flags()
ubelt.boolmask()
ubelt.iter_window()
ubelt.allsame()
ubelt.argsort()
ubelt.argmax()
ubelt.argmin()
ubelt.peek()
ubelt.util_path
¶
ubelt.TempDir()
ubelt.augpath()
ubelt.shrinkuser()
ubelt.userhome()
ubelt.ensuredir()
ubelt.expandpath()
ubelt.util_platform
¶
ubelt.WIN32()
ubelt.LINUX()
ubelt.DARWIN()
ubelt.POSIX()
ubelt.platform_data_dir()
ubelt.platform_config_dir()
ubelt.platform_cache_dir()
ubelt.get_app_data_dir()
ubelt.ensure_app_data_dir()
ubelt.get_app_config_dir()
ubelt.ensure_app_config_dir()
ubelt.get_app_cache_dir()
ubelt.ensure_app_cache_dir()
ubelt.find_exe()
ubelt.find_path()
ubelt.util_str
¶
ubelt.indent()
ubelt.codeblock()
ubelt.paragraph()
ubelt.hzcat()
ubelt.ensure_unicode()
ubelt.util_time
¶
ubelt.Timer()
ubelt.Timerit()
ubelt.timestamp()
- ubelt
- ubelt package
- Submodules
- ubelt.orderedset module
- ubelt.progiter module
- ubelt.util_arg module
- ubelt.util_cache module
- ubelt.util_cmd module
- ubelt.util_colors module
- ubelt.util_const module
- ubelt.util_dict module
- ubelt.util_download module
- ubelt.util_format module
- ubelt.util_func module
- ubelt.util_hash module
- ubelt.util_import module
- ubelt.util_io module
- ubelt.util_links module
- ubelt.util_list module
- ubelt.util_memoize module
- ubelt.util_mixins module
- ubelt.util_path module
- ubelt.util_platform module
- ubelt.util_str module
- ubelt.util_stream module
- ubelt.util_time module
- Module contents
- Submodules
- ubelt package