expose Report & Fix multi-run

Author: yellowbean

absbox/__init__.py

@@ -17,6 +17,8 @@
 from absbox.local.cf import readBondsCf,readToCf,readFeesCf,readAccsCf,readPoolsCf,readFlowsByScenarios,readMultiFlowsByScenarios,readFieldsByScenarios
 from absbox.local.cf import readInspect
 
+from absbox.report import toHtml,OutputType
+
 import absbox.examples as examples
 
-__version__ = version("absbox")
+__version__ = version("absbox")

absbox/client.py

@@ -375,6 +375,7 @@ def run(self, deal,
         if result is None or 'error' in result or 'Left' in result:
             leftVal = result.get("Left","")
             raise AbsboxError(f"❌{MsgColor.Error.value}Failed to get response from run: {leftVal}")
+        print(result)
         result = result['Right']
         rawWarnMsg = map( lambda x:f"{MsgColor.Warning.value}{x['contents']}", filter_by_tags(result[RunResp.LogResp.value], enumVals(ValidationMsg)))
         if rawWarnMsg and showWarning:
@@ -420,10 +421,11 @@ def runByScenarios(self, deal,
         else:
             result = self._send_req(req, url, timeout=30)
 
-        if result is None or 'error' in result or 'Left' in result:
+        if result is None or 'error' in result or "Left" in set(tz.concat([ _.keys() for _ in result.values()])):
             leftVal = result.get("Left","")
             raise AbsboxError(f"❌{MsgColor.Error.value}Failed to get response from run: {leftVal}")
-        result = result['Right']
+        
+        result = tz.valmap(lambda x:x['Right'] ,result)
 
         rawWarnMsgByScen = {k: [f"{MsgColor.Warning.value}{_['contents']}" for _ in filter_by_tags(v[RunResp.LogResp.value], enumVals(ValidationMsg))] for k, v in result.items()}
         rawWarnMsg = list(tz.concat(rawWarnMsgByScen.values()))
@@ -474,10 +476,11 @@ def runPoolByScenarios(self, pool, poolAssump, rateAssump=None, read=True, debug
 
         result = self._send_req(req, url)
 
-        if result is None or 'error' in result or 'Left' in result:
+        if result is None or 'error' in result or "Left" in set(tz.concat([ _.keys() for _ in result.values()])):
             leftVal = result.get("Left","")
             raise AbsboxError(f"❌{MsgColor.Error.value}Failed to get response from run: {leftVal}")
-        result = result['Right']
+        
+        result = tz.valmap(lambda x:x['Right'] ,result)
 
         if read:
             return result & lens.Values().Values().modify(self.read_single)
@@ -555,10 +558,11 @@ def runStructs(self, deals, poolAssump=None, nonPoolAssump=None, runAssump=None,
             return req
         result = self._send_req(req, url)
 
-        if result is None or 'error' in result or 'Left' in result:
+        if result is None or 'error' in result or "Left" in set(tz.concat([ _.keys() for _ in result.values()])):
             leftVal = result.get("Left","")
             raise AbsboxError(f"❌{MsgColor.Error.value}Failed to get response from run: {leftVal}")
-        result = result['Right']
+
+        result = tz.valmap(lambda x:x['Right'] ,result)
 
         if read:
             return {k: deals[k].read(v) for k, v in result.items()}    
@@ -597,10 +601,11 @@ def runByDealScenarios(self, deal,
 
         result = self._send_req(req, url, timeout=30)
 
-        if result is None or 'error' in result or 'Left' in result:
-            leftVal = result.get("Left","")
+        if result is None or 'error' in result or "Left" in set(tz.concat([ _.keys() for _ in result.values()])):
+
             raise AbsboxError(f"❌{MsgColor.Error.value}Failed to get response from run: {leftVal}")
-        result = result['Right']
+
+        result = tz.valmap(lambda x:x['Right'] ,result)
 
         rawWarnMsgByScen = {k: [f"{MsgColor.Warning.value}{_['contents']}" for _ in filter_by_tags(v[RunResp.LogResp.value], enumVals(ValidationMsg))] for k, v in result.items()}
         rawWarnMsg = list(tz.concat(rawWarnMsgByScen.values()))
@@ -649,10 +654,11 @@ def runByCombo(self,
 
         result = self._send_req(req, url, timeout=30)
 
-        if result is None or 'error' in result or 'Left' in result:
+        if result is None or 'error' in result or "Left" in set(tz.concat([ _.keys() for _ in result.values()])):
             leftVal = result.get("Left","")
             raise AbsboxError(f"❌{MsgColor.Error.value}Failed to get response from run: {leftVal}")
-        result = result['Right']
+
+        result = tz.valmap(lambda x:x['Right'] ,result)
 
         assert isinstance(result, dict), f"Result should be a dict but got {type(result)}, {result}"
 

absbox/local/component.py

@@ -1044,6 +1044,8 @@ def mkMod(y: dict) -> tuple:
         ## Inspect
         case ["查看", comment, *ds] | ["inspect", comment, *ds]:
             return mkTag(("WatchVal", [comment, lmap(mkDs, ds)]))
+        case []:
+            return mkTag(("Placeholder",[]))
         case _:
             raise RuntimeError(f"Failed to match :{x}:mkAction")
 

absbox/report.py

@@ -0,0 +1,87 @@
+import toolz as tz
+from lenses import lens
+import pandas as pd
+import json, enum, os, pathlib, re
+from htpy import body, h1, head, html, li, title, ul, div, span, h3, h2, a
+from markupsafe import Markup
+from absbox import readInspect
+from absbox import readBondsCf,readFeesCf,readAccsCf
+
+
+class OutputType(int, enum.Enum):
+    """Internal
+    """
+    Plain = 0 # print cashflow to html tables 
+    Anchor = 1 # print cashflow with book mark
+    Tabbed = 2 # TBD
+
+
+def singleToMap(x,defaultName = "Consol")->dict:
+    if isinstance(x, dict):
+        return x
+    else:
+        return {defaultName: x}
+
+def mapToList(m:dict,anchor=False):
+    m2 = {}
+    if not anchor:
+        m2 = {h3[k]:div[Markup(v.to_html())]
+                for k,v in m.items() }
+    else:
+        m2 = {h3(id=f"anchor-{anchor}-{k}")[k]:div[Markup(v.to_html())]
+                for k,v in m.items() }
+
+    return list(m2.items())
+
+def toHtml(r:dict, p:str, style=OutputType.Plain, debug=False):
+    """
+    r : must be a result from "read=True"
+    """
+    dealName = r['_deal']['contents']['name']
+
+    poolDf = singleToMap(r['pool']['flow'])
+    accDf = r['accounts']
+    feeDf = r['fees']
+    bondDf = r['bonds']
+
+    section1 = [ div[ h2(id=f"anchor-{_t}")[_t],mapToList(x,anchor=_t) ]
+                for (_t,x) in [("Pool",poolDf),("Fee",feeDf),("Bond",bondDf),("Accounts",accDf)]
+                ]
+
+    section2 = [ div[ h2(id=f"anchor-{_t}")[_t],Markup(x.to_html()) ]
+                for (_t,x) in [("Status",r['result']['status'])
+                               ,("Pricing",r['pricing'])
+                               ,("Bond Summary",r['result']['bonds'])
+                               ,("Log",r['result']['logs'])
+                               ,("Waterfall",r['result']['waterfall'])
+                               ,("Inspect",readInspect(r['result']))]
+                if x is not None]
+
+    section3 = [ div[ h2(id=f"anchor-{_t}")[_t],mapToList(x) ]
+                for (_t,x) in [("Finanical Reports",r['result']['report'])]]
+    
+    # read joint cashflows 
+    seciont4 = [ div[ h2(id=f"anchor-{_t}")[_t],Markup(x.to_html()) ]
+                for (_t,x) in [("MultiFee",readFeesCf(feeDf)),("MultiBond",readBondsCf(bondDf,popColumns=[])),("MultiAccounts",readAccsCf(accDf))]
+            ]
+
+    c = html[
+        head[ title[dealName]],
+        body[ section1 ,section2 ,section3, seciont4 ],
+    ]
+
+    if debug:
+        return c
+
+    if style == OutputType.Anchor:
+        links = c & lens._children[1]._children.Each().Each()._children[0]._attrs.Regex(r'(?<=id=").*(?=")').collect()
+        c &= lens._children[1]._children.Each().Each()._children[0]._children.modify(lambda x:[x,a(href="#toc")["  ^Top"] ])
+        
+        linksStr = [ l.lstrip("anchor-")  for l in links ]
+        hrefs = ul[ [li[a(href=f"#{l}")[f" < {lstr} > "]] for (lstr,l) in zip(linksStr,links) ]]
+
+
+        c &= lens._children[1]._children.modify(lambda xs: tuple([div(id="toc")[div["Table Of Content"],hrefs]])+xs)
+
+    with open(p, 'wb') as f:
+        f.write(c.encode())

docs/source/analytics.rst

@@ -1353,6 +1353,7 @@ A `result` is returned by a `run()` call which has two components:
 
 * :ref:`Cashflow Results`
 * :ref:`Non-Cashflow Results`
+* :ref:`All-In-One HTML report`
 
 
 
@@ -1599,6 +1600,31 @@ There are two types of validation message
   r['result']['logs']
 
 
+All-In-One HTML report
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. versionadded:: 0.40.2
+
+In a single deal cashflow run, if user get a result object via a `read=True`, then there is a candy function `toHtml()` will help to dump all cashflow and summaries to a single HTML file.
+
+With a simple table of content , user can easily navigate to components of interset to inspect with.
+
+
+.. code-block:: python
+   
+  from absbox import toHtml,OutputType
+
+  toHtml(r,"testOutHtml.html")
+  
+  toHtml(r,"testOutHtml.html",style=OutputType.Anchor)
+
+
+If user are running with multi-scenario , just supply with a key 
+
+
+.. code-block:: python
+   
+  toHtml(r['scen01'],"testOutHtml.html",style=OutputType.Anchor)
+
 
 Sensitivity Analysis
 ----------------------