From 413d28443c7308414e8d283b9c5b9037463274f3 Mon Sep 17 00:00:00 2001 From: Scott Gasch Date: Sun, 6 Feb 2022 18:34:05 -0800 Subject: [PATCH] Add a doctest to type_utils.py. --- type_utils.py | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/type_utils.py b/type_utils.py index ee52444..1584597 100644 --- a/type_utils.py +++ b/type_utils.py @@ -10,10 +10,27 @@ 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. + 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() -- 2.45.2