3 # © Copyright 2021-2022, Scott Gasch
5 """This is the base class of
6 :class:`pyutils.parallelize.smart_future.SmartFuture`, which is a
7 piece of the simple parallelization framework.
9 This base class is essentially tries to have every Python `__dunder__`
10 method defined with a reasonabe default implementation so that, when
11 it is used in a manner that requires the value to be known, it calls
12 :meth:`DeferredOperand.resolve` and either gets the requisite value or
13 blocks until the data necessary to resolve the value is ready. This
14 is meant to enable more transparent :class:`Future` objects that can
15 be just used directly.
17 See :class:`pyutils.parallelize.smart_future.SmartFuture` for more
22 from abc import ABC, abstractmethod
23 from typing import Any, Generic, Set, TypeVar
25 # This module is commonly used by others in here and should avoid
26 # taking any unnecessary dependencies back on them.
31 class DeferredOperand(ABC, Generic[T]):
32 """A wrapper around an operand whose value is deferred until it is
33 needed (i.e. accessed). See the subclass
34 :class:`pyutils.parallelize.smart_future.SmartFuture` for an
35 example usage and/or a more useful patten.
38 def __init__(self, local_attributes: Set[str] = None):
39 self.__dict__['local_attributes'] = local_attributes
42 def _resolve(self, timeout=None) -> T:
46 def resolve(x: Any) -> Any:
48 When this object is used in a manner that requires it to know
49 its value, this method is called to either return the value or
50 block until it can do so.
53 x: the object whose value is required
56 The value of x... immediately if possible, eventually if
59 while isinstance(x, DeferredOperand):
63 def __lt__(self, other: Any) -> bool:
64 return DeferredOperand.resolve(self) < DeferredOperand.resolve(other)
66 def __le__(self, other: Any) -> bool:
67 return DeferredOperand.resolve(self) <= DeferredOperand.resolve(other)
69 def __eq__(self, other: Any) -> bool:
70 return DeferredOperand.resolve(self) == DeferredOperand.resolve(other)
72 def __ne__(self, other: Any) -> bool:
73 return DeferredOperand.resolve(self) != DeferredOperand.resolve(other)
75 def __gt__(self, other: Any) -> bool:
76 return DeferredOperand.resolve(self) > DeferredOperand.resolve(other)
78 def __ge__(self, other: Any) -> bool:
79 return DeferredOperand.resolve(self) >= DeferredOperand.resolve(other)
81 def __not__(self) -> bool:
82 return not DeferredOperand.resolve(self)
84 def bool(self) -> bool:
85 return DeferredOperand.resolve(self)
87 def __add__(self, other: Any) -> T:
88 return DeferredOperand.resolve(self) + DeferredOperand.resolve(other)
90 def __iadd__(self, other: Any) -> T:
91 return DeferredOperand.resolve(self) + DeferredOperand.resolve(other)
93 def __radd__(self, other: Any) -> T:
94 return DeferredOperand.resolve(self) + DeferredOperand.resolve(other)
96 def __sub__(self, other: Any) -> T:
97 return DeferredOperand.resolve(self) - DeferredOperand.resolve(other)
99 def __mul__(self, other: Any) -> T:
100 return DeferredOperand.resolve(self) * DeferredOperand.resolve(other)
102 def __pow__(self, other: Any) -> T:
103 return DeferredOperand.resolve(self) ** DeferredOperand.resolve(other)
105 def __truediv__(self, other: Any) -> Any:
106 return DeferredOperand.resolve(self) / DeferredOperand.resolve(other)
108 def __floordiv__(self, other: Any) -> T:
109 return DeferredOperand.resolve(self) // DeferredOperand.resolve(other)
111 def __contains__(self, other):
112 return DeferredOperand.resolve(other) in DeferredOperand.resolve(self)
114 def and_(self, other):
115 return DeferredOperand.resolve(self) & DeferredOperand.resolve(other)
117 def or_(self, other):
118 return DeferredOperand.resolve(self) & DeferredOperand.resolve(other)
120 def xor(self, other):
121 return DeferredOperand.resolve(self) & DeferredOperand.resolve(other)
124 return ~(DeferredOperand.resolve(self))
126 def is_(self, other):
127 return DeferredOperand.resolve(self) is DeferredOperand.resolve(other)
129 def is_not(self, other):
130 return DeferredOperand.resolve(self) is not DeferredOperand.resolve(other)
133 return abs(DeferredOperand.resolve(self))
135 def setitem(self, k, v):
136 DeferredOperand.resolve(self)[DeferredOperand.resolve(k)] = v
138 def delitem(self, k):
139 del DeferredOperand.resolve(self)[DeferredOperand.resolve(k)]
141 def getitem(self, k):
142 return DeferredOperand.resolve(self)[DeferredOperand.resolve(k)]
144 def lshift(self, other):
145 return DeferredOperand.resolve(self) << DeferredOperand.resolve(other)
147 def rshift(self, other):
148 return DeferredOperand.resolve(self) >> DeferredOperand.resolve(other)
150 def mod(self, other):
151 return DeferredOperand.resolve(self) % DeferredOperand.resolve(other)
153 def matmul(self, other):
154 return DeferredOperand.resolve(self) @ DeferredOperand.resolve(other)
157 return -(DeferredOperand.resolve(self))
160 return +(DeferredOperand.resolve(self))
163 return DeferredOperand.resolve(self)
166 return DeferredOperand.resolve(self).__hash__()
169 return DeferredOperand.resolve(self)()
172 return DeferredOperand.resolve(self).__iter__()
174 def __repr__(self) -> str:
175 return DeferredOperand.resolve(self).__repr__()
177 def __bytes__(self) -> bytes:
178 return DeferredOperand.resolve(self).__bytes__()
180 def __int__(self) -> int:
181 return int(DeferredOperand.resolve(self))
183 def __float__(self) -> float:
184 return float(DeferredOperand.resolve(self))
186 def __getattr__(self, name):
187 return getattr(DeferredOperand.resolve(self), name)
189 def __setattr__(self, name, value):
190 # subclass setting its own properties
191 if name in self.local_attributes:
192 object.__setattr__(self, name, value)
195 # otherwise operate on the wrapped result
196 DeferredOperand.resolve(self).__setattr__(name, value)
198 def __delattr__(self, name):
199 return delattr(DeferredOperand.resolve(self), name)
202 return dir(DeferredOperand.resolve(self))