ubelt 1.2.2

路径

Ubelt通过添加几个新的（通常是可链接的）方法扩展了pathlib.Path 。即，扩充、删除、扩展、确保目录、收缩用户。它还将触摸行为修改为可链接的。（1.0.0 中的新功能）

>>> # Ubelt extends pathlib functionality
>>> import ubelt as ub
>>> dpath = ub.Path('~/.cache/ubelt/demo_path').expand().ensuredir()
>>> fpath = dpath / 'text_file.txt'
>>> aug_fpath = fpath.augment(suffix='.aux', ext='.jpg').touch()
>>> aug_dpath = dpath.augment('demo_path2')
>>> assert aug_fpath.read_text() == ''
>>> fpath.write_text('text data')
>>> assert aug_fpath.exists()
>>> assert not aug_fpath.delete().exists()
>>> assert dpath.exists()
>>> assert not dpath.delete().exists()
>>> print(f'{fpath.shrinkuser()}')
>>> print(f'{dpath.shrinkuser()}')
>>> print(f'{aug_fpath.shrinkuser()}')
>>> print(f'{aug_dpath.shrinkuser()}')
~/.cache/ubelt/demo_path/text_file.txt
~/.cache/ubelt/demo_path
~/.cache/ubelt/demo_path/text_file.aux.jpg
~/.cache/ubelt/demo_pathdemo_path2

散列

ub.hash_data为常见的 Python 嵌套数据结构构造散列。可以注册允许它散列自定义类型的扩展。默认情况下，它处理列表、字典、集合、切片、uuid 和 numpy 数组。

>>> import ubelt as ub
>>> data = [('arg1', 5), ('lr', .01), ('augmenters', ['flip', 'translate'])]
>>> ub.hash_data(data, hasher='sha256')
0d95771ff684756d7be7895b5594b8f8484adecef03b46002f97ebeb1155fb15

还包括对火炬张量和熊猫数据帧的支持，但需要明确启用。还存在一个非公共插件架构来将此功能扩展到任意类型。虽然没有官方支持，但它是可用的，并且将来会更好地集成。有关详细信息，请参阅 ubelt/util_hash.py。

缓存

缓存来自脚本内代码块的中间结果，只需最少的样板或对原始代码的修改。

对于数据的直接缓存，请使用Cacher类。默认情况下，结果将被写入 ubelt 的 appdir 缓存，但可以通过dpath或appname参数指定确切的位置。此外，可以通过depends参数指定进程依赖关系，这允许隐式缓存失效。据我所知，这是使用现有 Python 语法（截至 2022 年 6 月 3 日）缓存代码块的最简洁方法（4 行样板代码）。

>>> import ubelt as ub
>>> depends = ['config', {'of': 'params'}, 'that-uniquely-determine-the-process']
>>> cacher = ub.Cacher('test_process', depends=depends, appname='myapp')
>>> # start fresh
>>> cacher.clear()
>>> for _ in range(2):
>>>     data = cacher.tryload()
>>>     if data is None:
>>>         myvar1 = 'result of expensive process'
>>>         myvar2 = 'another result'
>>>         data = myvar1, myvar2
>>>         cacher.save(data)
>>> myvar1, myvar2 = data

对于间接缓存，请使用CacheStamp类。这只是写一个“标记”文件，标记一个进程已经完成。此外，您可以指定标记何时到期的标准。如果您让CacheStamp 知道预期的“产品”，如果该文件已更改，它将使标记过期，这在缓存可能损坏或需要失效的情况下很有用。

>>> import ubelt as ub
>>> dpath = ub.Path.appdir('ubelt/demo/cache').delete().ensuredir()
>>> params = {'params1': 1, 'param2': 2}
>>> expected_fpath = dpath / 'file.txt'
>>> stamp = ub.CacheStamp('name', dpath=dpath, depends=params,
>>>                      hasher='sha256', product=expected_fpath,
>>>                      expires='2101-01-01T000000Z', verbose=3)
>>> # Start fresh
>>> stamp.clear()
>>>
>>> for _ in range(2):
>>>     if stamp.expired():
>>>         expected_fpath.write_text('expensive process')
>>>         stamp.renew()

有关Cacher和CacheStamp的更多详细信息，请参阅https://ubelt.readthedocs.io/en/latest/ubelt.util_cache.html。

循环进度

ProgIter是一个无线程附加的进度表，它写入标准输出。它是tqdm的主要替代品。 ProgIter 的优点是它不使用任何 python 线程，因此使用大量使用多处理的代码可以更安全。

注意：ProgIter也在独立模块中定义：pip install progiter）

>>> import ubelt as ub
>>> def is_prime(n):
...     return n >= 2 and not any(n % i == 0 for i in range(2, n))
>>> for n in ub.ProgIter(range(1000), verbose=2):
>>>     # do some work
>>>     is_prime(n)
    0/1000... rate=0.00 Hz, eta=?, total=0:00:00, wall=14:05 EST
    1/1000... rate=82241.25 Hz, eta=0:00:00, total=0:00:00, wall=14:05 EST
  257/1000... rate=177204.69 Hz, eta=0:00:00, total=0:00:00, wall=14:05 EST
  642/1000... rate=94099.22 Hz, eta=0:00:00, total=0:00:00, wall=14:05 EST
 1000/1000... rate=71886.74 Hz, eta=0:00:00, total=0:00:00, wall=14:05 EST

命令行交互

内置的 Python subprocess.Popen模块很棒，但有时它可能有点笨拙。os.system命令使用方便，但灵活性不高。ub.cmd函数旨在解决这个问题。它与os.system一样简单运行，但它返回一个字典，其中包含返回码、标准输出、标准错误和后台使用的 Popen对象。

此实用程序旨在提供跨不同平台的尽可能一致的行为。我们的目标是支持 Windows、Linux 和 OSX。

>>> import ubelt as ub
>>> info = ub.cmd('gcc --version')
>>> print(ub.repr2(info))
{
    'command': 'gcc --version',
    'err': '',
    'out': 'gcc (Ubuntu 5.4.0-6ubuntu1~16.04.9) 5.4.0 20160609\nCopyright (C) 2015 Free Software Foundation, Inc.\nThis is free software; see the source for copying conditions.  There is NO\nwarranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\n',
    'proc': <subprocess.Popen object at 0x7ff98b310390>,
    'ret': 0,
}

还要注意使用ub.repr2来很好地格式化输出字典。

此外，如果您指定verbose=True，ub.cmd将同时捕获标准输出并实时显示它（即它将“ tee ”输出）。

>>> import ubelt as ub
>>> info = ub.cmd(