add ID inference based on variable assignment

Author: yoelcortes

thermosteam/_multi_stream.py

@@ -8,6 +8,7 @@
 """
 """
 from __future__ import annotations
+import thermosteam as tmo
 from ._thermo import Thermo
 from ._stream import Stream
 from ._thermal_condition import ThermalCondition
@@ -248,6 +249,9 @@ def __init__(self,
             if total_flow: self._imol.data *= total_flow / self.F_mol
         self._sink = self._source = None
         self.reset_cache()
+        
+        if tmo.preferences.ID_inference and ID == '': ID = tmo.utils.infer_variable_assignment(self.__class__)
+        
         self._register(ID)
         if vlle: self.vlle(T=T, P=P)
 

thermosteam/_preferences.py

@@ -42,6 +42,7 @@ class DisplayPreferences:
     tooltips_full_results: False
     graphviz_html_height: {'big-system': ('600px', '900px'), 'huge-system': ('800px', '1200px'), 'system': ('400px', '600px'), 'unit': ('225px', '400px')}
     show_all_streams: True
+    ID_inference: False
     flow: 'kmol/hr:.3g'
     T: 'K:.5g'
     P: 'Pa:.6g'
@@ -55,7 +56,7 @@ class DisplayPreferences:
                  'label_color', 'label_color', 'depth_colors', 'stream_width',
                  'unit_color', 'unit_label_color', 'unit_periphery_color',
                  'fill_cluster', 'graphviz_format', 'tooltips_full_results',
-                 'graphviz_html_height', 'show_all_streams')
+                 'graphviz_html_height', 'show_all_streams', 'ID_inference')
 
     def __init__(self):
         #: Whether to label the ID of streams with sources and sinks in process 
@@ -80,16 +81,16 @@ def __init__(self):
         self.raise_exception: bool = False
 
         #: Background color in graphviz diagrams.
-        self.background_color: str = 'transparent'
+        self.background_color: str = '#000000'
 
         #: Color of streams in graphviz diagrams.
-        self.stream_color: str = '#90918e'
+        self.stream_color: str = '#98a2ad'
 
         #: Color of stream labels in graphviz diagrams.
-        self.label_color: str = '#90918e'
+        self.label_color: str = '#e5e5e5'
 
         #: Color of subsystem clusters in BioSTEAM graphviz diagrams.
-        self.depth_colors: list[str] = ['#f98f609f']
+        self.depth_colors: list[str] = ['#5172512f', '#1111112f']
 
         #: Property to scale stream widths in BioSTEAM graphviz diagrams.
         self.stream_width: str = 'F_mass'
@@ -101,7 +102,7 @@ def __init__(self):
         self.unit_label_color: str = 'white'
 
         #: Unit node periphery color in BioSTEAM graphviz diagrams.
-        self.unit_periphery_color: str = '#90918e'
+        self.unit_periphery_color: str = 'none'
 
         #: Whether to fill subsystem boxes in BioSTEAM 'cluster' diagrams.
         self.fill_cluster: bool = False
@@ -123,6 +124,9 @@ def __init__(self):
         #: Whether to show all streams, including empty feeds and products.
         self.show_all_streams = True
 
+        #: Whether to infer ID of unit operations, streams, and systems by variable name.
+        self.ID_inference = True
+        
     def temporary(self):
         """Return a TemporaryPreferences object that will revert back to original
         preferences after context management."""
@@ -217,22 +221,7 @@ def _set_mode(self, stream, label, bg, cluster, unit_color,
         self.fill_cluster = fill_cluster
         if save: self.save()
 
-    def classic_mode(self, 
-                     stream='#90918e', 
-                     label='#90918e', 
-                     bg='transparent',
-                     cluster=('#f98f609f',),
-                     unit_color='#555f69',
-                     unit_label_color='white',
-                     unit_periphery_color='none',
-                     fill_cluster=False,
-                     save=False):
-        """Set diagram display colors to classic mode."""
-        self._set_mode(stream, label, bg, cluster, unit_color, 
-                       unit_label_color, unit_periphery_color,
-                       fill_cluster, save)
-    
-    def dark_mode(self, stream='#98a2ad', label='#e5e5e5', bg='transparent',
+    def dark_mode(self, stream='#98a2ad', label='#e5e5e5', bg='#000000',
                   cluster=['#5172512f', '#1111112f'], unit_color='#555f69', 
                   unit_label_color='white', unit_periphery_color='none',
                   fill_cluster=True, save=False):
@@ -268,7 +257,6 @@ def to_dict(self):
         dct['composition'] = self.composition
         dct['N'] = self.N
         dct['sort'] = self.sort
-        
         return dct
 
     def save(self):

thermosteam/_stream.py

@@ -400,6 +400,8 @@ def __init__(self, ID: Optional[str] = '',
                 mol *= total_flow / mol.sum()
         self._sink = self._source = None
         self.reset_cache()
+        
+        if tmo.preferences.ID_inference and ID == '': ID = tmo.utils.infer_variable_assignment(self.__class__)
         self._register(ID)
         if vlle:
             self.vlle(T=T, P=P)

thermosteam/network.py

@@ -298,24 +298,33 @@ def __init__(self, size, streams, thermo, fixed_size, stacklevel):
         dock = self._dock
         redock = self._redock
         if streams == ():
-            self._streams = [dock(Stream(thermo=thermo)) for i in range(size)]
+            self._streams = [dock(Stream('-', thermo=thermo)) for i in range(size)]
         else:
             isa = isinstance
             if fixed_size:
                 self._initialize_missing_streams()
                 if streams is not None:
                     if isa(streams, str):
-                        self._streams[0] = dock(Stream(streams, thermo=thermo))
+                        self._streams[0] = dock(Stream(streams or '-', thermo=thermo))
                     elif isa(streams, stream_types):
                         self._streams[0] = redock(streams, stacklevel)
                     else:
                         N = len(streams)
                         n_missing(size, N) # Make sure size is not too big
-                        self._streams[:N] = [redock(i, stacklevel+1) if isa(i, Stream)
-                                             else dock(Stream(i, thermo=thermo)) for i in streams]
+                        loaded_streams = []
+                        for i in streams:
+                            if isa(i, Stream):
+                                s = redock(i, stacklevel)
+                            elif i is None:
+                                s = self._create_missing_stream()
+                            else:
+                                s = Stream(i or '-', thermo=thermo)
+                                dock(s)
+                            loaded_streams.append(s)
+                        self._streams[:N] = loaded_streams
             elif streams is not None:
                 if isa(streams, str):
-                    self._streams = [dock(Stream(streams, thermo=thermo))]
+                    self._streams = [dock(Stream(streams or '-', thermo=thermo))]
                 elif isinstance(streams, stream_types):
                     self._streams = [redock(streams, stacklevel)]
                 else:
@@ -326,7 +335,7 @@ def __init__(self, size, streams, thermo, fixed_size, stacklevel):
                         elif i is None:
                             s = self._create_missing_stream()
                         else:
-                            s = Stream(i, thermo=thermo)
+                            s = Stream(i or '-', thermo=thermo)
                             dock(s)
                         loaded_streams.append(s)
             else:

thermosteam/preferences.yaml

@@ -1,8 +1,9 @@
+ID_inference: true
 N: 7
 P: Pa:.6g
 T: K:.5g
 autodisplay: true
-background_color: transparent
+background_color: '#000000'
 composition: false
 depth_colors:
 - '#5172512f'

thermosteam/utils/__init__.py

@@ -17,6 +17,7 @@
 from . import plots
 from . import stream_filters
 from . import abstract_method
+from . import variable_assignment_inference
 
 __all__ = (*pickle.__all__,
            *representation.__all__,
@@ -28,6 +29,7 @@
            *plots.__all__,
            *stream_filters.__all__,
            *abstract_method.__all__,
+           *variable_assignment_inference.__all__,
 )
 
 from .pickle import *
@@ -39,4 +41,5 @@
 from .colors import *
 from .plots import *
 from .stream_filters import *
-from .abstract_method import *
+from .abstract_method import *
+from .variable_assignment_inference import *

thermosteam/utils/decorators/registered.py

@@ -53,7 +53,7 @@ def _register(self, ID):
         if '.' in ID:
             if hasattr(self, '_ID') and data.get(ID_old:=self._ID) is self: del data[ID_old]
             self._ID = ID.lstrip('.')
-        elif ID:
+        elif ID and ID != '-':
             registry.register_safely(ID, self) 
         elif self.autonumber:
             ID = self._take_ticket()

thermosteam/utils/variable_assignment_inference.py

@@ -0,0 +1,110 @@
+# -*- coding: utf-8 -*-
+# BioSTEAM: The Biorefinery Simulation and Techno-Economic Analysis Modules
+# Copyright (C) 2020, Yoel Cortes-Pena <yoelcortes@gmail.com>
+# 
+# This module is under the UIUC open-source license. See 
+# github.com/BioSTEAMDevelopmentGroup/biosteam/blob/master/LICENSE.txt
+# for license details.
+"""
+"""
+import inspect
+import os
+import sys
+import tokenize
+import linecache
+
+__all__ = (
+    'infer_variable_assignment',
+)
+
+cache = {}
+max_filecache = 50
+def infer_variable_assignment(caller):
+    # Get frame where item is assigned. 
+    # Stacklevel default to 2, assuming this method is used within `__init__`
+    frame = inspect.currentframe().f_back.f_back
+    filename = frame.f_code.co_filename
+    
+    # This means no variable assignment.
+    # Registered BioSTEAM objects will know how to handle this.
+    default = '-'
+    
+    # Get current line from frame file
+    try:
+        lines, variable_cache, crossout = cache[filename]
+    except:
+        # If the file fails to load, lines will be None and this is cached.
+        lines = None
+        # If using native cache, we replace the lines that failed with None
+        # to save space and improve speed.
+        crossout = True
+        if filename in linecache.cache:
+            try: 
+                # Must be ipython or notebook session
+                lines = linecache.cache[filename][2]
+                crossout = False
+            except: 
+                lines = None
+        if lines is None:
+            if os.path.isabs(filename):
+                fullname = filename
+            else:
+                # Try looking through the module search path, which is only useful
+                # when handling a relative filename.
+                for dirname in sys.path:
+                    try: fullname = os.path.join(dirname, filename)
+                    except (TypeError, AttributeError): continue
+                    else: break
+            try:
+                with tokenize.open(fullname) as fp: lines = fp.readlines()
+            except:
+                pass
+        # We use variable_cache to cache the lines that we already tried 
+        # and not attempt them again; this improves speed.
+        variable_cache = None if lines is None else {}
+        cache[filename] = lines, variable_cache, crossout
+        if cache.__len__() > max_filecache:
+            cache.popitem(cache.__iter__().__next__())
+    if lines is None: return default
+    n = frame.f_lineno - 1
+    if n in variable_cache:
+        return variable_cache[n]
+    else:
+        line = lines[n]
+    
+    # Attempt to infer name
+    try: 
+        line = line.strip()
+        if line.startswith('with '): # Context management
+            callside, nameside = line.split(' as ', 1)
+            callside = callside[5:].strip() # remove 'with ' and trailing spaces
+            variable_name = nameside.split(':', 1)[0].strip() # remove ':' and trailing spaces
+            valid_variable_name = variable_name.isidentifier()
+        else: # Ordinary variable assignment
+            nameside, callside = line.split('=', 1)
+            names = nameside.strip().split('.')
+            variable_name = names[-1]
+            valid_variable_name = all([i.isidentifier() for i in names])
+        if valid_variable_name:
+            # Make sure not a nested call
+            callside = callside.strip()
+            name = callside.split('(', 1)[0]
+            key, *other = name.split('.')
+            if key in frame.f_locals:
+                obj = frame.f_locals[key]
+            elif key in frame.f_globals:
+                obj = frame.f_globals[key]
+            else:
+                if crossout: lines[n] = None
+                variable_cache[n] = default
+                return default # NameError by user
+            for key in other: obj = getattr(obj, key)
+            if obj != caller: variable_name = default # No assignment
+        else:
+            variable_name = default # No assignment
+        variable_cache[n] = variable_name
+        return variable_name
+    except:
+        if crossout: lines[n] = None
+        variable_cache[n] = default
+        return default # Could not infer name