From: Scott Gasch <scott@gasch.org>
Date: Mon, 7 Feb 2022 02:34:05 +0000 (-0800)
Subject: Add a doctest to type_utils.py.
X-Git-Url: https://wannabe.guru.org/gitweb/?a=commitdiff_plain;h=413d28443c7308414e8d283b9c5b9037463274f3;p=python_utils.git

Add a doctest to type_utils.py.
---

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()