X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=type_utils.py;h=ee52444e7828c1d2b7920749a800dbf77e653983;hb=ed8fa2b10b0177b15b7423263bdd390efde2f0c8;hp=7b79af08f934f0b93153c5c14065a3a884de9a91;hpb=497fb9e21f45ec08e1486abaee6dfa7b20b8a691;p=python_utils.git

diff --git a/type_utils.py b/type_utils.py
index 7b79af0..ee52444 100644
--- a/type_utils.py
+++ b/type_utils.py
@@ -7,6 +7,11 @@ 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.
+    """
     if x is None:
         msg = 'Argument to unwrap_optional was unexpectedly None'
         logger.critical(msg)