summaryrefslogtreecommitdiff
path: root/type_utils.py
blob: c2f432a2306fee2a828eaf8b9d0de41c224d3380 (plain)
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
#!/usr/bin/env python3

"""Utility functions for dealing with typing."""

import logging
from typing import Any, Optional

logger = logging.getLogger(__name__)


def unwrap_optional(x: Optional[Any]) -> Any:
    """Unwrap an Optional[Type] argument returning a Type value back.
    If the Optional[Type] argument is None, however, raise an exception.
    Use this to satisfy most type checkers that a value that could
    be None isn't so as to drop the Optional typing hint.

    >>> x: Optional[bool] = True
    >>> unwrap_optional(x)
    True

    >>> y: Optional[str] = None
    >>> unwrap_optional(y)
    Traceback (most recent call last):
    ...
    AssertionError: Argument to unwrap_optional was unexpectedly None

    """
    if x is None:
        msg = 'Argument to unwrap_optional was unexpectedly None'
        logger.critical(msg)
        raise AssertionError(msg)
    return x


if __name__ == '__main__':
    import doctest

    doctest.testmod()