pythagoras 0.20.6__py3-none-any.whl → 0.20.8__py3-none-any.whl

pythagoras/_010_basic_portals/__init__.py

@@ -11,14 +11,11 @@ provides various supporting services that help manage the application's
 state and behavior.
 
 A Pythagoras-based application can have multiple portals.
-There is usually a current (default) portal, accessible via
-get_current_portal().
+There is usually a current active portal, accessible via
+get_active_portal().
 
-BasicPortal is a base class for all portal objects. It provides foundational
-functionality for managing the portal stack and for accessing the current
-portal. It keeps track of all portals created in the system and manages
-the stack of entered ('active') portals. It also provides a method to
-clear all portals and their state. The class is not intended to be used directly.
+BasicPortal is a base class for all portal objects.
+The class is not intended to be used directly.
 Instead, it should be subclassed to provide additional functionality.
 
 BasicPortal's subclasses are expected to provide access to

pythagoras/_010_basic_portals/basic_portal_core_classes.py

@@ -1,3 +1,10 @@
+"""This modukle provides foundational functionality for wotk with portals,
+specifically for managing the portal stack and for accessing the current
+portal. It keeps track of all portals created in the system and manages
+the stack of entered ('active') portals. It also provides a method to
+clear all portals and their state.
+"""
+
 from __future__ import annotations
 
 import random
@@ -84,7 +91,7 @@ def get_all_known_portals() -> list[BasicPortal]:
 
 
 def get_number_of_portals_in_active_stack() -> int:
-    """Get the number of currently active portals."""
+    """Get the number of portals in a stack."""
     global _active_portals_stack
     return len(set(_active_portals_stack))
 
@@ -124,6 +131,7 @@ def get_active_portal() -> BasicPortal:
 
 
 def get_nonactive_portals() -> list[BasicPortal]:
+    """Get a list of all portals that are not in the active stack."""
     active_portal_str_id = get_active_portal()._str_id
     found_portals = []
     for portal_str_id, portal in _all_known_portals.items():
@@ -160,13 +168,9 @@ class BasicPortal(NotPicklable,ParameterizableClass, metaclass = PostInitMeta):
 
     A Pythagoras-based application can have multiple portals,
     and there is usually a current (default) portal, accessible via
-    get_current_portal().
+    get_active_portal().
 
-    BasicPortal is a base class for all portal objects. It provides foundational
-    functionality for managing the portal stack and for accessing the current
-    portal. It keeps track of all portals created in the system and manages
-    the stack of entered ('active') portals. It also provides a method to
-    clear all portals and their state.
+    BasicPortal is a base class for all portal objects.
 
     The class is not intended to be used directly. Instead, it should
     be subclassed to provide additional functionality.
@@ -175,12 +179,11 @@ class BasicPortal(NotPicklable,ParameterizableClass, metaclass = PostInitMeta):
     _entropy_infuser = random.Random()
 
     _root_dict: PersiDict | None
-    _str_id_cache: PortalStrID | None
+    _str_id_cache: PortalStrID
 
 
     def __init__(self, root_dict:PersiDict|str|None = None):
         ParameterizableClass.__init__(self)
-        self._str_id_cache = None
         if root_dict is None:
             root_dict = get_default_portal_base_dir()
         if not isinstance(root_dict, PersiDict):
@@ -193,6 +196,7 @@ class BasicPortal(NotPicklable,ParameterizableClass, metaclass = PostInitMeta):
 
 
     def _post_init_hook(self) -> None:
+        """This method is always called after all __init__() methods"""
         global _most_recently_created_portal, _all_known_portals
         _all_known_portals[self._str_id] = self
         _most_recently_created_portal = self
@@ -216,7 +220,6 @@ class BasicPortal(NotPicklable,ParameterizableClass, metaclass = PostInitMeta):
 
     def get_linked_objects(self, target_class: type | None = None) -> list[PortalAwareClass]:
         """Get the list of objects, linked to the portal"""
-
         found_linked_objects_ids = self._get_linked_objects_ids(target_class)
         found_linked_objects = []
         for obj_str_id in found_linked_objects_ids:
@@ -243,7 +246,11 @@ class BasicPortal(NotPicklable,ParameterizableClass, metaclass = PostInitMeta):
 
     @property
     def is_active(self) -> bool:
-        """Check if the portal is the current one"""
+        """Check if the portal is the current one.
+
+        The 'active' portal is the innermost portal
+        in the stack of portal's 'with' statements.
+        """
         return (len(_active_portals_stack) > 0
                 and _active_portals_stack[-1]._str_id == self._str_id)
 
@@ -257,28 +264,40 @@ class BasicPortal(NotPicklable,ParameterizableClass, metaclass = PostInitMeta):
 
     @property
     def _ephemeral_param_names(self) -> set[str]:
-        """Get the names of the portal's ephemeral parameters"""
+        """Get the names of the portal's ephemeral parameters.
+
+        Portal's ephemeral parameters are not stored persistently.
+        They affect behaviour of a portal object in an application session,
+        but they do not affect behaviour of the actual portal across multiple runs.
+        """
         return set()
 
 
     @property
     def _str_id(self) -> PortalStrID:
-        """Get the portal's persistent hash"""
-        if hasattr(self,"_str_id_cache") and self._str_id_cache is not None:
-            return self._str_id_cache
-        else:
+        """Get the portal's persistent hash.
+
+        It's an internal hash used by Pythagoras and is different from .__hash__()
+        """
+        if not hasattr(self,"_str_id_cache"):
             params = self.get_portable_params()
             ephemeral_names = self._ephemeral_param_names
             nonephemeral_params = {k:params[k] for k in params
                 if k not in ephemeral_names}
             self._str_id_cache = PortalStrID(
                 get_hash_signature(nonephemeral_params))
-            return self._str_id_cache
+        return self._str_id_cache
 
 
     def _invalidate_cache(self) -> None:
-        """Invalidate object's caches"""
-        self._str_id_cache = None
+        """Invalidate the object's attribute cache.
+
+        If the object's attribute named ATTR is cached,
+        its cached value will be stored in an attribute named _ATTR_cache
+        This method should delete all such attributes.
+        """
+        if hasattr(self, "_str_id_cache"):
+            del self._str_id_cache
 
 
     def describe(self) -> pd.DataFrame:
@@ -297,7 +316,7 @@ class BasicPortal(NotPicklable,ParameterizableClass, metaclass = PostInitMeta):
 
 
     def __enter__(self):
-        """Set the portal as the current one"""
+        """Set the portal as the active one and add it to the stack"""
         global _active_portals_stack, _active_portals_counters_stack
         if (len(_active_portals_stack) == 0 or
                 id(_active_portals_stack[-1]) != id(self)):
@@ -309,7 +328,7 @@ class BasicPortal(NotPicklable,ParameterizableClass, metaclass = PostInitMeta):
 
 
     def __exit__(self, exc_type, exc_val, exc_tb):
-        """Remove the portal from the current context"""
+        """Pop the portal from the stack of active ones"""
         global _active_portals_stack, _active_portals_counters_stack
         assert _active_portals_stack[-1] == self, (
             "Inconsistent state of the portal stack. "
@@ -324,10 +343,9 @@ class BasicPortal(NotPicklable,ParameterizableClass, metaclass = PostInitMeta):
 
     def _clear(self) -> None:
         """Clear and invalidate the portal's state"""
+        self._invalidate_cache()
         self._root_dict = None
-        self._str_id_cache = None
         self._entropy_infuser = None
-        # self._linked_objects = None
 
 
 _all_activated_portal_aware_objects: dict[PObjectStrID, PortalAwareClass] = dict()
@@ -342,36 +360,25 @@ def get_number_of_linked_portal_aware_objects() -> int:
 class PortalAwareClass(metaclass = PostInitMeta):
     """A base class for objects that need to access a portal.
 
-    The class enables functionality for saving and loading its objects.
-    When a portal-aware object is saved (pickled), the portal data is not saved,
-    and the object is pickled as if it were a regular object.
-    After the object is unpickled, the portal is restored to the current portal.
-
-    The "current" portal is the innermost portal
-    in the stack of portal "with" statements. It means that
-    a portal-aware object can only be unpickled from within a portal context.
-
-    A portal-aware object accepts a portal as an input parameter
-    for its constructor. It also supports late portal binding: it
-    can be created with `portal=None`, and its portal will be set later
-    to the current portal.
+    These objects either always work with a currently active portal,
+    or they have a preferred (linked) portal which they activate every
+    time their methods are called.
     """
 
     # _linked_portal: BasicPortal | None
     _linked_portal_at_init: BasicPortal|None
-    _hash_id_cache: PObjectStrID | None
+    _hash_id_cache: PObjectStrID
     _visited_portals: set[str] | None
 
     def __init__(self, portal:BasicPortal|None=None):
         assert portal is None or isinstance(portal, BasicPortal)
-        # self._linked_portal = portal
         self._linked_portal_at_init = portal
-        self._hash_id_cache = None
+        # self._hash_id_cache = None
         self._visited_portals = set()
 
 
     def _post_init_hook(self):
-        """ This method is called after the object is fully initialized."""
+        """ This method is called after all object's .__init__() methods."""
         global _all_links_from_objects_to_portals
         global _all_activated_portal_aware_objects
         if self._linked_portal_at_init is not None:
@@ -382,8 +389,19 @@ class PortalAwareClass(metaclass = PostInitMeta):
 
     @property
     def _linked_portal(self) -> BasicPortal | None:
+        """Get the portal's preferred (linked) portal.
+
+        If the linked portal is not None, the object will activate
+        this portal every time the object's methods are called.
+        If it's None, the object will never try to change the active portal.
+        """
         global _all_links_from_objects_to_portals, _all_known_portals
         portal = None
+        if self._linked_portal_at_init is not None and len(self._visited_portals)==0:
+            _all_links_from_objects_to_portals[self._str_id
+                ] = self._linked_portal_at_init._str_id
+            self._first_visit_to_portal(self._linked_portal_at_init)
+            portal = self._linked_portal_at_init
         if self._str_id in _all_links_from_objects_to_portals:
             portal_str_id = _all_links_from_objects_to_portals[self._str_id]
             assert isinstance(portal_str_id, str)
@@ -393,8 +411,11 @@ class PortalAwareClass(metaclass = PostInitMeta):
 
     @property
     def portal(self) -> BasicPortal:
-        # if self._linked_portal is None:
-        #     self._try_to_find_linked_portal_and_register_there()
+        """Get the portal which the object's methods will be using.
+
+        It's either the object's linked portal or
+        (if the linked portal is None) the currently active portal.
+        """
         global _all_links_from_objects_to_portals, _all_known_portals
         portal_to_use = self._linked_portal
         if portal_to_use is None:
@@ -405,30 +426,21 @@ class PortalAwareClass(metaclass = PostInitMeta):
         return portal_to_use
 
     def _first_visit_to_portal(self, portal: BasicPortal) -> None:
+        """Register an object in a portal that the object has not seen before."""
         global _all_activated_portal_aware_objects
         _all_activated_portal_aware_objects[self._str_id] = self
         self._visited_portals.add(portal._str_id)
 
 
-    # @portal.setter
-    # def portal(self, new_portal: BasicPortal|None) -> None:
-    #     """Set the portal to the given one."""
-    #     assert new_portal is not None
-    #     assert not hasattr(self, "_linked_portal") or self._linked_portal is None
-    #     self._linked_portal = new_portal
-    #     self._try_to_find_linked_portal_and_register_there()
-    #     if new_portal._str_id not in self._visited_portals:
-    #         self._first_visit_to_portal(new_portal)
-
-
     @property
     def _str_id(self) -> PObjectStrID:
-        """Return the hash ID of the portal-aware object."""
-        if hasattr(self, "_str_id_cache") and self._hash_id_cache is not None:
-            return self._hash_id_cache
-        else:
+        """Return the hash ID of the portal-aware object.
+
+        It's an internal hash used by Pythagoras and is different from .__hash__()
+        """
+        if not hasattr(self, "_str_id_cache"):
             self._hash_id_cache = PObjectStrID(get_hash_signature(self))
-            return self._hash_id_cache
+        return self._hash_id_cache
 
 
     @abstractmethod
@@ -445,19 +457,26 @@ class PortalAwareClass(metaclass = PostInitMeta):
 
     @abstractmethod
     def __setstate__(self, state):
-        """This method is called when the object is unpickled.
-
-        """
+        """This method is called when the object is unpickled."""
         self._invalidate_cache()
         self._visited_portals = set()
+        self._linked_portal_at_init = None
 
 
     def _invalidate_cache(self):
-        self._hash_id_cache = None
+        """Invalidate the object's attribute cache.
+
+        If the object's attribute named ATTR is cached,
+        its cached value will be stored in an attribute named _ATTR_cache
+        This method should delete all such attributes.
+        """
+        if hasattr(self, "_hash_id_cache"):
+            del self._hash_id_cache
 
 
     @property
     def is_activated(self) -> bool:
+        """Return True if the object has been registered in at least one of the portals."""
         global _all_activated_portal_aware_objects
         if len(self._visited_portals) >=1:
             assert self._str_id in _all_activated_portal_aware_objects
@@ -466,6 +485,10 @@ class PortalAwareClass(metaclass = PostInitMeta):
 
 
     def _deactivate(self):
+        """Mark the object as not activated.
+
+        Empty the list of portals it has been registered into.
+        """
         global _all_activated_portal_aware_objects
         assert self.is_activated
         del _all_activated_portal_aware_objects[self._str_id]
@@ -473,8 +496,6 @@ class PortalAwareClass(metaclass = PostInitMeta):
         self._visited_portals = set()
 
 
-
-
 def _clear_all_portals() -> None:
     """Remove all information about all the portals from the system."""
     global _all_known_portals, _active_portals_stack

pythagoras/_010_basic_portals/not_picklable_class.py

@@ -1,6 +1,8 @@
 class NotPicklable:
     def __getstate__(self):
+        """This method is called when the object is pickled."""
         raise TypeError(f"{type(self).__name__} cannot be pickled")
 
     def __setstate__(self, state):
+        """This method is called when the object is unpickled."""
         raise TypeError(f"{type(self).__name__} cannot be unpickled")

pythagoras/_020_ordinary_code_portals/ordinary_decorator.py

@@ -24,8 +24,10 @@ class ordinary:
 
 
     def __getstate__(self):
+        """This method is called when the object is pickled."""
         raise TypeError("Decorators cannot be pickled.")
 
 
     def __setstate__(self, state):
+        """This method is called when the object is unpickled."""
         raise TypeError("Decorators cannot be pickled.")

pythagoras/_020_ordinary_code_portals/ordinary_portal_core_classes.py

@@ -122,22 +122,23 @@ class OrdinaryFn(PortalAwareClass):
 
     @property
     def portal(self) -> OrdinaryCodePortal:
-        return PortalAwareClass.portal.__get__(self)
+        """Get the portal which the function's methods will be using.
 
+        It's either the function's linked portal or
+        (if the linked portal is None) the currently active portal.
+        """
+        return super().portal
 
-    # @portal.setter
-    # def portal(self, new_portal: OrdinaryCodePortal) -> None:
-    #     if not isinstance(new_portal, OrdinaryCodePortal):
-    #         raise TypeError("portal must be a OrdinaryCodePortal instance")
-    #     PortalAwareClass.portal.__set__(self, new_portal)
 
     @property
     def source_code(self) -> str:
+        """Get the source code of the function."""
         return self._source_code
 
 
     @property
     def name(self) -> str:
+        """Get the name of the function."""
         if not hasattr(self, "_name_cache") or self._name_cache is None:
             self._name_cache = get_function_name_from_source(self.source_code)
         return self._name_cache
@@ -145,7 +146,8 @@ class OrdinaryFn(PortalAwareClass):
 
     @property
     def hash_signature(self):
-        if not hasattr(self, "_hash_signature_cache") or self._hash_signature_cache is None:
+        """Get the hash signature of the function."""
+        if not hasattr(self, "_hash_signature_cache"):
             self._hash_signature_cache = get_hash_signature(self)
         return self._hash_signature_cache
 
@@ -196,6 +198,12 @@ class OrdinaryFn(PortalAwareClass):
 
 
     def _invalidate_cache(self):
+        """Invalidate the object's attribute cache.
+
+        If the object's attribute named ATTR is cached,
+        its cached value will be stored in an attribute named _ATTR_cache
+        This method should delete all such attributes.
+        """
         if hasattr(self, "_compiled_code_cache"):
             del self._compiled_code_cache
         if hasattr(self, "_tmp_fn_name_cache"):
@@ -245,11 +253,13 @@ class OrdinaryFn(PortalAwareClass):
 
 
     def __getstate__(self):
+        """This method is called when the object is pickled."""
         state = dict(source_code=self._source_code)
         return state
 
 
     def __setstate__(self, state):
+        """This method is called when the object is unpickled."""
         PortalAwareClass.__setstate__(self, state)
         self._source_code = state["source_code"]
 

pythagoras/_030_data_portals/data_portal_core_classes.py

@@ -249,24 +249,32 @@ class StorableFn(OrdinaryFn):
 
     @property
     def addr(self) -> ValueAddr:
-        with self.portal:
-            if not hasattr(self, "_addr_cache") or self._addr_cache is None:
+        if not hasattr(self, "_addr_cache"):
+            with self.portal:
                 self._addr_cache = ValueAddr(self)
-            return self._addr_cache
+        return self._addr_cache
 
 
     def _invalidate_cache(self):
+        """Invalidate the object's attribute cache.
+
+        If the object's attribute named ATTR is cached,
+        its cached value will be stored in an attribute named _ATTR_cache
+        This method should delete all such attributes.
+        """
         if hasattr(self, "_addr_cache"):
             del self._addr_cache
         super()._invalidate_cache()
 
 
     def __setstate__(self, state):
+        """This method is called when the object is unpickled."""
         super().__setstate__(state)
         self._ephemeral_config_params_at_init = dict()
 
 
     def __getstate__(self):
+        """This method is called when the object is pickled."""
         return super().__getstate__()
 
 
@@ -382,6 +390,12 @@ class HashAddr(SafeStrTuple):
 
 
     def _invalidate_cache(self):
+        """Invalidate the object's attribute cache.
+
+        If the object's attribute named ATTR is cached,
+        its cached value will be stored in an attribute named _ATTR_cache
+        This method should delete all such attributes.
+        """
         pass
 
 
@@ -397,10 +411,11 @@ class ValueAddr(HashAddr):
     It makes it easier for humans to interpret an address,
     and further decreases collision risk.
     """
-    _containing_portals_cache: set[str]
+    _containing_portals: set[str]
     _value_cache: Any
 
     def __init__(self, data: Any, store: bool = True):
+        self._containing_portals = set()
 
         if hasattr(data, "get_ValueAddr"):
             data_value_addr = data.get_ValueAddr()
@@ -422,20 +437,24 @@ class ValueAddr(HashAddr):
             , hash_signature=hash_signature)
 
         self._value_cache = data
-        self._containing_portals_cache = set()
 
         if store:
             portal = get_active_data_portal()
             portal._value_store[self] = data
-            self._containing_portals_cache.add(portal._str_id)
+            self._containing_portals.add(portal._str_id)
 
 
     def _invalidate_cache(self):
-        super()._invalidate_cache()
+        """Invalidate the object's attribute cache.
+
+        If the object's attribute named ATTR is cached,
+        its cached value will be stored in an attribute named _ATTR_cache
+        This method should delete all such attributes.
+        """
         if hasattr(self, "_value_cache"):
             del self._value_cache
-        if hasattr(self, "_containing_portals_cache"):
-            del self._containing_portals_cache
+        self._containing_portals = set()
+        super()._invalidate_cache()
 
 
     def get_ValueAddr(self):
@@ -446,11 +465,11 @@ class ValueAddr(HashAddr):
     def _ready_in_active_portal(self) -> bool:
         portal = get_active_data_portal()
         portal_id = portal._str_id
-        if portal_id in self._containing_portals_cache:
+        if portal_id in self._containing_portals:
             return True
         result = self in portal._value_store
         if result:
-            self._containing_portals_cache.add(portal_id)
+            self._containing_portals.add(portal_id)
         return result
 
 
@@ -461,7 +480,7 @@ class ValueAddr(HashAddr):
                 value = portal._value_store[self]
                 get_active_data_portal()._value_store[self] = value
                 new_ids = {portal._str_id, get_active_portal()._str_id}
-                self._containing_portals_cache |= new_ids
+                self._containing_portals |= new_ids
                 self._value_cache = value
                 return True
         return False
@@ -470,9 +489,6 @@ class ValueAddr(HashAddr):
     @property
     def ready(self) -> bool:
         """Check if address points to a value that is ready to be retrieved."""
-        if not hasattr(self, "_containing_portals_cache"):
-            self._containing_portals_cache = set()
-
         if self._ready_in_active_portal:
             return True
         if self._ready_in_nonactive_portals:
@@ -484,16 +500,16 @@ class ValueAddr(HashAddr):
         """Retrieve value, referenced by the address, from the current portal"""
 
         if hasattr(self, "_value_cache"):
-            if get_active_portal()._str_id in self._containing_portals_cache:
+            if get_active_portal()._str_id in self._containing_portals:
                 return self._value_cache
             else:
                 get_active_data_portal()._value_store[self] = self._value_cache
-                self._containing_portals_cache |= {get_active_portal()._str_id}
+                self._containing_portals |= {get_active_portal()._str_id}
                 return self._value_cache
 
         value = get_active_data_portal()._value_store[self]
         self._value_cache = value
-        self._containing_portals_cache |= {get_active_portal()._str_id}
+        self._containing_portals |= {get_active_portal()._str_id}
         return value
 
 
@@ -506,7 +522,7 @@ class ValueAddr(HashAddr):
                 get_active_data_portal()._value_store[self] = value
                 self._value_cache = value
                 new_ids = {portal._str_id, get_active_portal()._str_id}
-                self._containing_portals_cache |= new_ids
+                self._containing_portals |= new_ids
                 return value
             except:
                 continue
@@ -520,9 +536,6 @@ class ValueAddr(HashAddr):
             ) -> T:
         """Retrieve value, referenced by the address from any available portal"""
 
-        if not hasattr(self, "_containing_portals_cache"):
-            self._containing_portals_cache = set()
-
         try:
             result = self._get_from_active_portal()
         except:
@@ -536,10 +549,29 @@ class ValueAddr(HashAddr):
 
 
     def __getstate__(self):
+        """This method is called when the object is pickled."""
         state = dict(strings=self.strings)
         return state
 
 
     def __setstate__(self, state):
+        """This method is called when the object is unpickled."""
         self._invalidate_cache()
-        self.strings = state["strings"]
+        self.strings = state["strings"]
+        self._containing_portals = set()
+
+
+    @classmethod
+    def from_strings(cls, *
+                     , prefix: str
+                     , hash_signature: str
+                     , assert_readiness: bool = True
+                     ) -> HashAddr:
+        """(Re)construct address from text representations of prefix and hash"""
+
+        address = super().from_strings(prefix=prefix, hash_signature=hash_signature, assert_readiness=False)
+        address._containing_portals = set()
+        if assert_readiness:
+            if not address.ready:
+                raise ValueError("Address is not ready for retrieving data")
+        return address

pythagoras/_040_logging_code_portals/logging_portal_core_classes.py

@@ -111,6 +111,7 @@ class LoggingFnCallSignature:
 
 
     def __getstate__(self):
+        """This method is called when the object is pickled."""
         state = dict(
             _fn_addr=self._fn_addr
             , _kwargs_addr=self._kwargs_addr)
@@ -118,12 +119,19 @@ class LoggingFnCallSignature:
 
 
     def __setstate__(self, state):
+        """This method is called when the object is unpickled."""
         self._invalidate_cache()
         self._fn_addr = state["_fn_addr"]
         self._kwargs_addr = state["_kwargs_addr"]
 
 
     def _invalidate_cache(self):
+        """Invalidate the object's attribute cache.
+
+        If the object's attribute named ATTR is cached,
+        its cached value will be stored in an attribute named _ATTR_cache
+        This method should delete all such attributes.
+        """
         if hasattr(self, "_fn_cache"):
             del self._fn_cache
         if hasattr(self, "_fn_name_cache"):

pythagoras/_050_safe_code_portals/safe_portal_core_classes.py

@@ -34,11 +34,13 @@ class SafeFn(LoggingFn):
 
 
     def __getstate__(self):
+        """This method is called when the object is pickled."""
         state = super().__getstate__()
         return state
 
 
     def __setstate__(self, state):
+        """This method is called when the object is unpickled."""
         super().__setstate__(state)
 
 

pythagoras/_060_autonomous_code_portals/autonomous_portal_core_classes.py

@@ -104,11 +104,13 @@ class AutonomousFn(SafeFn):
 
 
     def __getstate__(self):
+        """This method is called when the object is pickled."""
         state = super().__getstate__()
         state["_fixed_kwargs"] = self._fixed_kwargs
         return state
 
     def __setstate__(self, state):
+        """This method is called when the object is unpickled."""
         super().__setstate__(state)
         self._fixed_kwargs = state["_fixed_kwargs"]
 

pythagoras/_070_protected_code_portals/protected_portal_core_classes.py

@@ -66,6 +66,7 @@ class ProtectedFn(AutonomousFn):
 
 
     def __getstate__(self):
+        """This method is called when the object is pickled."""
         state = super().__getstate__()
         state["guards_addrs"] = self._guards_addrs
         state["validators_addrs"] = self._validators_addrs
@@ -73,6 +74,7 @@ class ProtectedFn(AutonomousFn):
 
 
     def __setstate__(self, state):
+        """This method is called when the object is unpickled."""
         self._invalidate_cache()
         super().__setstate__(state)
         self._guards_addrs = state["guards_addrs"]

pythagoras/_080_pure_code_portals/pure_core_classes.py

@@ -271,6 +271,12 @@ class PureFnExecutionResultAddr(HashAddr):
 
 
     def _invalidate_cache(self):
+        """Invalidate the object's attribute cache.
+
+        If the object's attribute named ATTR is cached,
+        its cached value will be stored in an attribute named _ATTR_cache
+        This method should delete all such attributes.
+        """
         if hasattr(self, "_ready_cache"):
             del self._ready_cache
         if hasattr(self, "_result_cache"):
@@ -317,12 +323,14 @@ class PureFnExecutionResultAddr(HashAddr):
         return self._kwargs_cache
 
 
-    def __setstate__(self, state): #*#*#
+    def __setstate__(self, state):
+        """This method is called when the object is unpickled."""
         self._invalidate_cache()
         self.strings = state["strings"]
 
 
-    def __getstate__(self): #*#*#
+    def __getstate__(self):
+        """This method is called when the object is pickled."""
         state = dict(strings=self.strings)
         return state
 

pythagoras/_090_swarming_portals/swarming_portals.py

@@ -14,7 +14,7 @@ from .._010_basic_portals import get_number_of_known_portals, get_all_known_port
 from .._010_basic_portals import BasicPortal
 from .system_utils import (
     get_current_process_id, process_is_active,
-    get_process_start_time, get_current_process_start_time)
+    get_process_start_time, get_current_process_start_time, get_available_cpu_cores, get_available_ram_mb)
 from .._040_logging_code_portals.logging_portal_core_classes import build_execution_environment_summary
 from .._010_basic_portals.basic_portal_core_classes import _describe_runtime_characteristic
 from .._800_signatures_and_converters.random_signatures import get_random_signature
@@ -179,6 +179,8 @@ parameterizable.register_parameterizable_class(SwarmingPortal)
 def _launch_many_background_workers(**portal_init_params) -> None:
     """Launch many background worker processes."""
     n_workers_to_launch = portal_init_params["max_n_workers"]
+    n_workers_to_launch = min(n_workers_to_launch, get_available_cpu_cores())
+    n_workers_to_launch = min(n_workers_to_launch, get_available_ram_mb()/500)
     portal_init_params["max_n_workers"] = 0
     current_process_id = get_current_process_id()
     portal_init_params["parent_process_id"] = current_process_id
@@ -194,6 +196,7 @@ def _launch_many_background_workers(**portal_init_params) -> None:
 
     list_of_all_workers = []
 
+    n_workers_to_launch = int(n_workers_to_launch)
     with portal:
         for i in range(n_workers_to_launch):
             portal._randomly_delay_execution(p=1)

{pythagoras-0.20.6.dist-info → pythagoras-0.20.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pythagoras
-Version: 0.20.6
+Version: 0.20.8
 Summary: Planet-scale distributed computing in Python.
 Keywords: cloud,ML,AI,serverless,distributed,parallel,machine-learning,deep-learning,pythagoras
 Author: Volodymyr (Vlad) Pavlov

{pythagoras-0.20.6.dist-info → pythagoras-0.20.8.dist-info}/RECORD

@@ -1,17 +1,18 @@
-pythagoras/_010_basic_portals/__init__.py,sha256=07fc891782185c5be5e3d5d405de42bb4789bbfc49b06e4e7b3089af9592623a,1983
-pythagoras/_010_basic_portals/basic_portal_core_classes.py,sha256=86da2d29f7d6c43d17de6defe6cdc9a1cc5461cc0baf927a283b828f1b3d6068,18017
+pythagoras/.DS_Store,sha256=40d35c2d6b7fca6728a8be89c610686ceb83b21e32d6fe0ddedcf1b3f58bfdaf,6148
+pythagoras/_010_basic_portals/__init__.py,sha256=111d2457fb61ee16dae275d78e83fe8e837e72a9143281f889148280a50fef96,1703
+pythagoras/_010_basic_portals/basic_portal_core_classes.py,sha256=1cc8fc86d8be58283a93b7707a63e27228b012f07601916f5eb851bc66d4db26,18995
 pythagoras/_010_basic_portals/exceptions.py,sha256=a15bab585769159db1bedf123bc92e920695f14faa3ad1f4ab0f863b7742b391,237
 pythagoras/_010_basic_portals/long_infoname.py,sha256=9742b2bf023389704c88628a8ed81d1c82ad6eb15a0a27c9cddadbfae1e9cf2d,650
-pythagoras/_010_basic_portals/not_picklable_class.py,sha256=6c9374e4e54c7b7532b6f9b95f47773a898064a73340839dc50ef3ddf7b1a0c7,222
+pythagoras/_010_basic_portals/not_picklable_class.py,sha256=2f7405a32c530a68fae64c5e06731b69c44dea1fc0611e72284d5b13dffd77c0,352
 pythagoras/_010_basic_portals/portal_tester.py,sha256=cefdbf60bfc7697934ef8fd653303ac5295014884af780351baf84d859ec6de0,1817
 pythagoras/_010_basic_portals/post_init_metaclass.py,sha256=6dbe6856e4e46627bc0ae64d4220274b1147d4d2a74f6440f2454f8a93485c7e,583
 pythagoras/_020_ordinary_code_portals/__init__.py,sha256=a77912a9a4188f4c65864f41c29b45800d5449d4db7c790007943d307f80348d,1295
 pythagoras/_020_ordinary_code_portals/code_normalizer.py,sha256=2e2e4273add19a526273756ec8d8d0f33ea8aa0ef2cd15e0ce8c4c2b0d15f928,4869
 pythagoras/_020_ordinary_code_portals/function_processing.py,sha256=ae5841d1da5a533b6fe92336c2551d6947444dc576a55508098b9f56b40245c7,3623
-pythagoras/_020_ordinary_code_portals/ordinary_decorator.py,sha256=078c2e6e194ffab6bc8477b15b72198ccb34b57a935813ba2318ccf2d5c01a28,898
-pythagoras/_020_ordinary_code_portals/ordinary_portal_core_classes.py,sha256=bfe25e1911c9859c369a6dfeea8c8126c2b04058ad7b711994a99532e5c11b54,9182
+pythagoras/_020_ordinary_code_portals/ordinary_decorator.py,sha256=278ab1d37344120a585af8380fc52400bd0f76d02ddac43230dd68a7a2cc16c0,1028
+pythagoras/_020_ordinary_code_portals/ordinary_portal_core_classes.py,sha256=77b41aaeaa6f0de8bfa3fff503f426c632de3844cc16a6f6b5cc89e8e420fec5,9568
 pythagoras/_030_data_portals/__init__.py,sha256=8edbde910ded4fa56091492d7f8443d0980adedcab25f4b9308cfed05074c7f2,1237
-pythagoras/_030_data_portals/data_portal_core_classes.py,sha256=50bcbd71705be6287573ba7b2f12a1523bc97976608537d71da31befe27196aa,18492
+pythagoras/_030_data_portals/data_portal_core_classes.py,sha256=4b156f7a3d958236e0d912799846b0afbb855891c64b1c0dffbf591e951330e1,19780
 pythagoras/_030_data_portals/ready_and_get.py,sha256=d87d16a6747239f4ed6c30c2be95eab9ae58bc5b2742f0fd924fd2a3ace71382,1571
 pythagoras/_030_data_portals/storable_decorator.py,sha256=97c5b71a156622c7208e80931aaded99d7a12860cb2159c56d333e196fb51b88,578
 pythagoras/_040_logging_code_portals/__init__.py,sha256=62ff68021e955c0a96ddd89168a3db25a8f20b3384d5e1ca10df7d9a24c96837,1251
@@ -19,16 +20,16 @@ pythagoras/_040_logging_code_portals/exception_processing_tracking.py,sha256=cb2
 pythagoras/_040_logging_code_portals/execution_environment_summary.py,sha256=853bd36da75802d8ac6781fcaeafa7fe1b0a3c24b7f23b12cfc970fc0d4322a6,2268
 pythagoras/_040_logging_code_portals/kw_args.py,sha256=096d299e99f33dea880e4c2b7ff9cef1081f0b9d3b4a6d649df6464a2a87db94,2435
 pythagoras/_040_logging_code_portals/logging_decorator.py,sha256=d3bf70dbf6791e15c52eb8325d07a48ee39bcbd09d5201541916d14f9969ba35,891
-pythagoras/_040_logging_code_portals/logging_portal_core_classes.py,sha256=6e637908139eb2b07e8bc88c27506bc1baf32a9cb043f1f034c605b3dbe41497,21585
+pythagoras/_040_logging_code_portals/logging_portal_core_classes.py,sha256=2b87e89ee1f9ff1495dc81bedf9b7d9b9a85372c7e197a276fdc9a93a68ea11b,21965
 pythagoras/_040_logging_code_portals/notebook_checker.py,sha256=e654090c80f38512114a65f54fcf2701110c10ca030c57f438829cbd3a678739,541
 pythagoras/_040_logging_code_portals/output_capturer.py,sha256=a210a9eaaab12fb22e2467e716e088823e4e7381e60bc73bb99184feecd69199,4216
 pythagoras/_040_logging_code_portals/uncaught_exceptions.py,sha256=0776cfbd7e679c9271e098cb486765d715ce054da9aa8dc23fe32898901f5da1,3121
 pythagoras/_050_safe_code_portals/__init__.py,sha256=d514c7aa066848a9b99c32fa7f8d5d8e5aef6e826f2a5fb1ff8a0bf338753c98,69
 pythagoras/_050_safe_code_portals/safe_decorator.py,sha256=085bb05724d02a3ff4f51708802c2463c4184654b5d008724f7f2b2d0922519c,805
-pythagoras/_050_safe_code_portals/safe_portal_core_classes.py,sha256=517b5252c55433681433fceec6a2141486b0bc453797119bedf2fc37e408ae30,1678
+pythagoras/_050_safe_code_portals/safe_portal_core_classes.py,sha256=bb37bd2515f7982829308265951e4576aed11517b1c8c76de75ef726f96c3ea4,1808
 pythagoras/_060_autonomous_code_portals/__init__.py,sha256=6c19fffb24a93aef9587f0abe9ef24732ef5971c94e9a0fa2c36f4d7a3664e35,2232
 pythagoras/_060_autonomous_code_portals/autonomous_decorators.py,sha256=c315b37cbc30e3929f18e29bda409aad39b6d5d840dcdb8b70c737817d346af6,3947
-pythagoras/_060_autonomous_code_portals/autonomous_portal_core_classes.py,sha256=f0ba893c6bbc9a5557ff9f5d204a5c8e88ff499d2e8edb51daab4302bae7ea14,4406
+pythagoras/_060_autonomous_code_portals/autonomous_portal_core_classes.py,sha256=99544fb312a5be004e4bfea4f4c53b577d6659a7cff9e95a906609dedf0c6cfb,4536
 pythagoras/_060_autonomous_code_portals/names_usage_analyzer.py,sha256=1e0e84854ac630b204878fecde48a16739fd2663709fcee2ec0a8844f4fd4f13,7470
 pythagoras/_070_protected_code_portals/GPU_guards.py,sha256=75a11da44c802486bc6f65640aa48a730f0f684c5c07a42ba3cd1735eb3fb070,2
 pythagoras/_070_protected_code_portals/OK_const.py,sha256=17ea314496f44b422f9936585c3bb3749c960bc779b4f74962ec04e3fa4d2494,186
@@ -38,14 +39,14 @@ pythagoras/_070_protected_code_portals/fn_arg_names_checker.py,sha256=2000ba3cab
 pythagoras/_070_protected_code_portals/list_flattener.py,sha256=9a54b512ad9dc201db348e7908f5ca5f36d171ae3da433511d38023a6ba8d4b5,331
 pythagoras/_070_protected_code_portals/package_manager.py,sha256=30adf8d75f55b9b2c587dc95f4aa1c2154fa9354d668af6f0d586bb42f0d5b17,2008
 pythagoras/_070_protected_code_portals/protected_decorators.py,sha256=9cede3734b0235e15a9534fcf393454f9107073f90cf9bd5a532696d277e35da,1412
-pythagoras/_070_protected_code_portals/protected_portal_core_classes.py,sha256=58e66f14598a23d6d4bfa4dd3d510971ce272a11ea73a22d11b72487df112968,6616
+pythagoras/_070_protected_code_portals/protected_portal_core_classes.py,sha256=9bd9edf3dfa45edb355f70332be77a4290d023b78d4b9804d67a0561d296a8ac,6746
 pythagoras/_070_protected_code_portals/python_packages_guards.py,sha256=a4ff97c250cbc94ad379edcab510fe10d4d590de9733bbff437bed71c025cecb,1025
 pythagoras/_080_pure_code_portals/__init__.py,sha256=8ed33435bb03d96675537fc6a696625332f971698d56c6b22b5ca1bc9d1b4274,1856
-pythagoras/_080_pure_code_portals/pure_core_classes.py,sha256=82617b2118b49c5fa95e7061396021b3851fdc47197aa00f43c98d05cb738145,18538
+pythagoras/_080_pure_code_portals/pure_core_classes.py,sha256=73167f9aab4c91f5a07d6ac047e72ed81f81fe00ca3b96ca8b2085d4a0c40f9b,18906
 pythagoras/_080_pure_code_portals/pure_decorator.py,sha256=d908ad5eae50e59eeab32f738f784605708e00de71dd53dcbf25efecb83d110d,1168
 pythagoras/_090_swarming_portals/__init__.py,sha256=7041578f84ffa291f2752c7a2168007b9113f99482f0173f3729171b3bff551a,32
 pythagoras/_090_swarming_portals/output_suppressor.py,sha256=83e6cc9bcc62a226babb1165912ef5095ea948499ce5136a7516ac8b54522607,626
-pythagoras/_090_swarming_portals/swarming_portals.py,sha256=4616f309e169e7d0cc874f2659db085d3b4ca4acb9b788502cbda3fd6712782c,11378
+pythagoras/_090_swarming_portals/swarming_portals.py,sha256=cb5240d0a070571a1b58d66fe3013c5d3123886ce4b266aeb35e95cc28d033fa,11633
 pythagoras/_090_swarming_portals/system_utils.py,sha256=d125a0b705b9f8477712179c49441daaf2cd2b0b0d4494b6ac977b2df87b50b5,1370
 pythagoras/_100_top_level_API/__init__.py,sha256=edac726311978503953fe4c37c475c7d616708236880f393b63894b9ab6251e5,95
 pythagoras/_100_top_level_API/default_local_portal.py,sha256=cfbe20499fed2f038b507b44fb58bb4cb6ea2fbe2fe93a3ab5ad7f3ac655005f,215
@@ -60,6 +61,6 @@ pythagoras/_900_project_stats_collector/__init__.py,sha256=e3b0c44298fc1c149afbf
 pythagoras/_900_project_stats_collector/project_analyzer.py,sha256=d06e9d7b516cb7424ef777e70abe9d5220e09b0b19476326b8974b4dc3917f89,3506
 pythagoras/__init__.py,sha256=94303c01a7bde4078fdbd90c0b142807a023fa352c473c3a544a2180b7254ae9,1062
 pythagoras/core/__init__.py,sha256=26640880921763e8801b74da28fccf1cd47ac0ba0d40ee8fcaf7d748410406bf,189
-pythagoras-0.20.6.dist-info/WHEEL,sha256=7de84e261f5edc1201bd668234a371ec3eb94db037d1f75c0139430c1319ab31,79
-pythagoras-0.20.6.dist-info/METADATA,sha256=21a2c9e6d12a3e19cd688aa123d03ffaa01942b485415e0a64149f33a25aaa43,4177
-pythagoras-0.20.6.dist-info/RECORD,,
+pythagoras-0.20.8.dist-info/WHEEL,sha256=1f21b63a61110964f543b6041e8b7da078f20c09d500a32cb79eee5c3d655f54,79
+pythagoras-0.20.8.dist-info/METADATA,sha256=da94d8c4b1a7c7173f25b935fb1f941baf58b6c9cbbc500add1e91854fba1b24,4177
+pythagoras-0.20.8.dist-info/RECORD,,

{pythagoras-0.20.6.dist-info → pythagoras-0.20.8.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.7.16
+Generator: uv 0.7.17
 Root-Is-Purelib: true
 Tag: py3-none-any