Skip to content

Truncate uid

truncate_uid #

Functions:

Name Description
truncate_uid

Truncate the UID to the last n characters (including periods and underscores).

truncate_uid #

truncate_uid(uid: str, last_digits: int = 5) -> str

Truncate the UID to the last n characters (including periods and underscores).

If the UID is shorter than last_digits, the entire UID is returned.

Parameters:

Name Type Description Default

uid #

 str

The UID string to truncate.

 required

last_digits #

 int

The number of characters to keep at the end of the UID (default is 5).

 5

Returns:

Type Description
str

The truncated UID string.

Examples:

>>> truncate_uid(
...     "1.2.840.10008.1.2.1",
...     last_digits=5,
... )
'.1.2.1'
>>> truncate_uid(
...     "12345",
...     last_digits=10,
... )
'12345'
Source code in src/imgtools/utils/truncate_uid.py 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def truncate_uid(uid: str, last_digits: int = 5) -> str:
    """
    Truncate the UID to the last n characters (including periods and underscores).

    If the UID is shorter than `last_digits`, the entire UID is returned.

    Parameters
    ----------
    uid : str
        The UID string to truncate.
    last_digits : int, optional
        The number of characters to keep at the end of the UID (default is 5).

    Returns
    -------
    str
        The truncated UID string.

    Examples
    --------
    >>> truncate_uid(
    ...     "1.2.840.10008.1.2.1",
    ...     last_digits=5,
    ... )
    '.1.2.1'
    >>> truncate_uid(
    ...     "12345",
    ...     last_digits=10,
    ... )
    '12345'
    """
    assert uid is not None
    assert isinstance(uid, str)
    assert isinstance(last_digits, int)
    if last_digits >= len(uid) or last_digits <= 0:
        return uid

    return uid[-last_digits:]