Easier and more self documenting patterns for loading/saving Persistent

[python_utils.git] / deferred_operand.py

diff --git a/deferred_operand.py b/deferred_operand.py
index f2af66c4cc3ee908767af2b024a37bba096ff5d9..9edbb9e8072b451ffc13f447235e3da5505bcff6 100644 (file)
--- a/deferred_operand.py
+++ b/deferred_operand.py
@@ -1,18 +1,30 @@
 #!/usr/bin/env python3
 
+# © Copyright 2021-2022, Scott Gasch
+
+"""This is a helper class that tries to define every __dunder__ method
+so as to defer that evaluation of an object as long as possible.  It
+is used by smart_future.py as a base class.
+
+"""
+
 from abc import ABC, abstractmethod
 from typing import Any, Generic, TypeVar
 
+# This module is commonly used by others in here and should avoid
+# taking any unnecessary dependencies back on them.
+
 T = TypeVar('T')
 
 
 class DeferredOperand(ABC, Generic[T]):
     """A wrapper around an operand whose value is deferred until it is
-    needed.  See subclass SmartFuture for an example usage.
+    needed (i.e. accessed).  See the subclass :class:`SmartFuture` for
+    an example usage and/or a more useful patten.
     """
 
     @abstractmethod
-    def _resolve(self) -> T:
+    def _resolve(self, timeout=None) -> T:
         pass
 
     @staticmethod
@@ -146,7 +158,6 @@ class DeferredOperand(ABC, Generic[T]):
 
     def __getattr__(self, method_name):
         def method(*args, **kwargs):
-            return getattr(DeferredOperand.resolve(self), method_name)(
-                *args, **kwargs
-            )
+            return getattr(DeferredOperand.resolve(self), method_name)(*args, **kwargs)
+
         return method