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.
NOTE: The README on github contains information and examples complementary to these docs.
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).
Function name |
Usefulness |
---|---|
2001 |
|
728 |
|
694 |
|
539 |
|
383 |
|
338 |
|
305 |
|
272 |
|
250 |
|
227 |
|
220 |
|
209 |
|
206 |
|
189 |
|
|
184 |
179 |
|
173 |
|
173 |
|
171 |
|
164 |
|
161 |
|
144 |
|
124 |
|
106 |
|
103 |
|
100 |
|
97 |
|
90 |
|
87 |
|
84 |
|
76 |
|
75 |
|
70 |
|
65 |
|
54 |
|
54 |
|
53 |
|
52 |
|
50 |
|
49 |
|
49 |
|
43 |
|
43 |
|
42 |
|
40 |
|
38 |
|
37 |
|
35 |
|
35 |
|
34 |
|
33 |
|
31 |
|
30 |
|
30 |
|
30 |
|
29 |
|
28 |
|
25 |
|
23 |
|
22 |
|
21 |
|
17 |
|
17 |
|
17 |
|
13 |
|
11 |
|
8 |
|
8 |
|
6 |
|
5 |
|
5 |
|
5 |
|
4 |
|
4 |
|
3 |
|
2 |
|
1 |
|
1 |
|
0 |
|
0 |
|
0 |
|
0 |
|
|
0 |
0 |
|
0 |
|
0 |
|
0 |
|
0 |
|
0 |
|
0 |
|
0 |
|
|
0 |
0 |
|
|
0 |
0 |
|
0 |
|
0 |
|
0 |
|
0 |
|
0 |
usage stats = {
'mean': 54.349514,
'std': 147.71915,
'min': 0.0,
'max': 1426.0,
'med': 19.0,
'sum': 5598,
'shape': (103,),
}
The following is a breakdown of the API by module
ubelt.orderedset
¶
ubelt.progiter
¶
ubelt.timerit
¶
ubelt.util_arg
¶
ubelt.util_cache
¶
ubelt.util_cmd
¶
ubelt.util_colors
¶
<ubelt.NO_COLOR>
<ubelt.highlight_code>
<ubelt.color_text>
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.sorted_keys>
<ubelt.sorted_vals>
<ubelt.odict>
<ubelt.named_product>
<ubelt.varied_values>
ubelt.util_download
¶
ubelt.util_download_manager
¶
ubelt.util_format
¶
ubelt.util_func
¶
ubelt.util_futures
¶
ubelt.util_hash
¶
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_indexable
¶
<ubelt.IndexableWalker>
<ubelt.indexable_allclose>
ubelt.util_io
¶
<ubelt.readfrom>
<ubelt.writeto>
<ubelt.touch>
<ubelt.delete>
ubelt.util_links
¶
ubelt.util_list
¶
<ubelt.allsame>
<ubelt.argmax>
<ubelt.argmin>
<ubelt.argsort>
<ubelt.argunique>
<ubelt.boolmask>
<ubelt.chunks>
<ubelt.compress>
<ubelt.flatten>
<ubelt.iter_window>
<ubelt.iterable>
<ubelt.peek>
<ubelt.take>
<ubelt.unique>
<ubelt.unique_flags>
ubelt.util_memoize
¶
<ubelt.memoize>
<ubelt.memoize_method>
<ubelt.memoize_property>
ubelt.util_mixins
¶
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.find_exe>
<ubelt.find_path>
<ubelt.ensure_app_cache_dir>
<ubelt.ensure_app_config_dir>
<ubelt.ensure_app_data_dir>
<ubelt.get_app_cache_dir>
<ubelt.get_app_config_dir>
<ubelt.get_app_data_dir>
<ubelt.platform_cache_dir>
<ubelt.platform_config_dir>
<ubelt.platform_data_dir>
ubelt.util_str
¶
<ubelt.indent>
<ubelt.codeblock>
<ubelt.paragraph>
<ubelt.hzcat>
<ubelt.ensure_unicode>
ubelt.util_stream
¶
<ubelt.TeeStringIO>
<ubelt.CaptureStdout>
<ubelt.CaptureStream>
ubelt.util_time
¶
- ubelt
- ubelt package
- Submodules
- ubelt.orderedset module
- ubelt.progiter module
- ubelt.timerit 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