FoSpy 0.0.1__py3-none-any.whl

FoSpy/__init__.py

@@ -0,0 +1,50 @@
+def inherit_docstring(parent, label="Parent"):
+    def decorator(func):
+        parent_doc = getattr(parent, func.__name__).__doc__
+        if parent_doc:
+            func.__doc__ = (func.__doc__ or "") + f"\n\n{label} doc: `{parent.__name__}.{func.__name__}`\n" + parent_doc
+        return func
+    return decorator
+
+def attach_doc(source, label="Related"):
+    """
+    Attach the docstring from `source` to the decorated function or class.
+
+    `source` may be:
+        • a function
+        • a class
+        • any object with a __doc__ attribute
+        • a literal string (treated as a docstring)
+    """
+    # Resolve the docstring
+    if isinstance(source, str):
+        source_doc = source
+        source_name = None
+    else:
+        source_doc = getattr(source, "__doc__", None)
+        source_name = getattr(source, "__qualname__", None)
+
+    def decorator(obj):
+        if source_doc:
+            header = f"\n\n{label} doc"
+            if source_name:
+                header += f": `{source_name}`"
+            header += "\n"
+
+            obj.__doc__ = (obj.__doc__ or "") + header + source_doc
+        return obj
+
+    return decorator
+
+
+def inherit_class_doc(parent):
+    def decorator(cls):
+        parent_doc = parent.__doc__
+        if parent_doc:
+            cls.__doc__ = (cls.__doc__ or "") + f"\n\nParent doc: `{parent.__name__}`\n" + parent_doc
+        return cls
+    return decorator
+
+
+from FoSpy.blocks import *
+from FoSpy.parsing import *

FoSpy/_debug.py

@@ -0,0 +1,72 @@
+from pprint import pprint
+import sys
+import inspect
+import io
+
+DEBUG_WIDTH = 120
+
+class Debug:
+    def __init__(self):
+        self.on = False
+
+        frame = inspect.currentframe().f_back
+        self.module_name = frame.f_globals.get("__name__", "<unknown>")
+        self.label = f"|(Debug message from {self.module_name})"
+        self.label_width = len(self.label)
+
+    def msg(self,msg):
+        self.pmsg(str(msg))
+
+    def pmsg(self,msg,**kwargs):
+        if self.on:
+            text_width = DEBUG_WIDTH - self.label_width
+
+            buf = io.StringIO()
+            pprint(msg,stream=buf, width=text_width,**kwargs)
+            txt = buf.getvalue()
+            for line in txt.splitlines():
+                print(f'{line:<{text_width}}{self.label:>{self.label_width}}')
+
+def _find_debugs():
+    results = []
+    for name, module in sys.modules.items():
+        # Some entries in sys.modules are None (partially imported modules)
+        if module is None:
+            continue
+
+        if hasattr(module, "_debug"):
+            results.append((name, module._debug))
+    return results
+
+def debug_status():
+    results = []
+    for module, debug_obj in _find_debugs():
+        if hasattr(debug_obj,"on"):
+            results.append((module, 'ON' if debug_obj.on else "OFF"))
+    return results
+
+
+def all_debugs_on(soundoff=True):
+    for module, debug_obj in _find_debugs():
+        if hasattr(debug_obj,"on"):
+            debug_obj.on = True
+            if soundoff:
+                debug_obj.msg("Turning Debug On")
+
+def all_debugs_off(soundoff=True):
+    all_debugs_on(soundoff=False)
+    for module, debug_obj in _find_debugs():
+        if hasattr(debug_obj,"on"):
+            if soundoff:
+                debug_obj.msg("Turning Debug Off")
+            debug_obj.on = False         
+    
+
+if __name__ == "__main__":
+    from pprint import pp
+    from FoSpy import *
+    pp(debug_status())
+
+
+
+

FoSpy/blocks/__init__.py

@@ -0,0 +1,30 @@
+"""Classes for representing blocks of information in a FOS file.
+
+Synthesis objects are constructed as a FileBlock subclass, which contain
+attributes specified by headers in the file. Each FileBlock attribute
+is a subclass object of another block class (either SingleBlock or ListBlock)
+ListBlocks wrap a list of SingleBlock objects.
+SingleBlock attributes can be assigned to simple values or other blocks.
+
+Typical usage:
+```
+mySyn = Synthesis.fromFile("C:\\my.fos")
+
+# mySyn.reaction is a SingleBlock object
+# mySyn.reaction.nominal_mass is a Decimal value
+nom_mass = mySyn.reaction.nominal_mass
+
+# mySyn.materials is a ListBlock object containing SingleBlock Material objects.
+zinc = mySyn.materials[0]
+print(zinc.formula)
+"""
+
+
+from .blocks import * 
+from .embedded import *
+from .template import *
+from .synthesis import *   
+from .materials import *
+from .metadata import *
+from .treatments import *
+