Function fixed_width_file_name

src/commoncode/cliutils.py:334–370

Return a fixed width file name of at most `max_length` characters computed from the `path` string and usable for fixed width display. If the `path` file name is longer than `max_length`, the file name is truncated in the middle using three dots "..." as an ellipsis and the ext is ke

(path, max_length=25)

def fixed_width_file_name(path, max_length=25):
    """
    Return a fixed width file name of at most `max_length` characters computed
    from the `path` string and usable for fixed width display. If the `path`
    file name is longer than `max_length`, the file name is truncated in the
    middle using three dots "..." as an ellipsis and the ext is kept.

    For example:
    >>> fwfn = fixed_width_file_name('0123456789012345678901234.c')
    >>> assert fwfn == '0123456789...5678901234.c'
    >>> fwfn = fixed_width_file_name('some/path/0123456789012345678901234.c')
    >>> assert fwfn == '0123456789...5678901234.c'
    >>> fwfn = fixed_width_file_name('some/sort.c')
    >>> assert fwfn == 'sort.c'
    >>> fwfn = fixed_width_file_name('some/123456', max_length=5)
    >>> assert fwfn == ''
    """
    if not path:
        return ""

    # get the path as unicode for display!
    filename = file_name(path)
    if len(filename) <= max_length:
        return filename
    base_name, ext = splitext(filename)
    dots = 3
    len_ext = len(ext)
    remaining_length = max_length - len_ext - dots

    if remaining_length < 5 or remaining_length < (len_ext + dots):
        return ""

    prefix_and_suffix_length = abs(remaining_length // 2)
    prefix = base_name[:prefix_and_suffix_length]
    ellipsis = dots * "."
    suffix = base_name[-prefix_and_suffix_length:]
    return "{prefix}{ellipsis}{suffix}{ext}".format(**locals())


def file_name_max_len(used_width=BAR_WIDTH + 1 + 7 + 1 + 8 + 1):