ready for 0.50.2

Author: yellowbean

absbox/client.py

@@ -516,7 +516,7 @@ def runPool(self, pool, poolAssump=None, rateAssump=None, read=True, debug=False
         else:
             return result
 
-    def runStructs(self, deals, poolAssump=None, nonPoolAssump=None, runAssump=None, read=True, debug=False) -> dict:
+    def runStructs(self, deals, poolAssump=None, nonPoolAssump=None, runAssump=None, rtn=[], read=True, debug=False) -> dict:
         """run multiple deals with same assumption
 
         :param deals: a dict of deals
@@ -540,7 +540,8 @@ def runStructs(self, deals, poolAssump=None, nonPoolAssump=None, runAssump=None,
         _poolAssump = mkAssumpType(poolAssump) if poolAssump else None 
         _nonPerfAssump = mkNonPerfAssumps({}, mapNone(nonPoolAssump,[]) + mapNone(runAssump,[]))
         req = json.dumps(mkTag(("MultiDealRunReq"
-                                 ,[ tz.valmap(lambda x:x.json, deals)
+                                 ,[rtn
+                                   ,tz.valmap(lambda x:x.json, deals)
                                    ,_poolAssump
                                    ,_nonPerfAssump]))
                          ,ensure_ascii=False)

absbox/local/component.py

@@ -1619,35 +1619,37 @@ def mkAsset(x):
                 vInt(remainTerms),
                 mkAssetStatus(status)]))
         case ["租赁", {"租金": rental, "初始期限": originTerm, "起始日": startDate, "调整":sut}
-                    ,{"当前余额":bal,"状态": status, "剩余期限": remainTerms}] \
+                    ,{"状态": status, "剩余期限": remainTerms}] \
                 | ["Lease", {"rental": rental, "stepUp":sut, "originTerm": originTerm, "originDate": startDate}
-                    ,{"currentBalance":bal, "status": status, "remainTerm": remainTerms}]:
+                    ,{"status": status, "remainTerm": remainTerms}]:
             obligorInfo = getValWithKs(x[1],["obligor","借款人"], mapping=mkObligor)
             _stepUpType = mkLeaseStepUp(sut)
+            mCurBalance = getValWithKs(x[2],["currentBalance","当前余额"], defaultReturn=0)
             return mkTag(("StepUpLease"
                         , [{"originTerm": originTerm, "startDate": startDate, "originRental": mkLeaseCalc(rental), "obligor": obligorInfo} | mkTag("LeaseInfo")
                         , _stepUpType
-                        , vNum(bal)
+                        , vNum(mCurBalance)
                         , vInt(remainTerms)
                         , mkAssetStatus(status)]))
 
         case ["租赁", {"租金": rental, "初始期限": originTerm, "起始日": startDate}
-                    ,{"当前余额": bal, "剩余期限": remainTerms,"状态": status}] \
+                    ,{"剩余期限": remainTerms,"状态": status}] \
                 | ["Lease", {"rental": rental, "originTerm": originTerm, "originDate": startDate}
-                , {"currentBalance": bal,"status": status, "remainTerm": remainTerms}]:
+                , {"status": status, "remainTerm": remainTerms}]:
             obligorInfo = getValWithKs(x[1],["obligor","借款人"], mapping=mkObligor)
+            mCurBalance = getValWithKs(x[2],["currentBalance","当前余额"], defaultReturn=0)
             return mkTag(("RegularLease"
                             , [{"originTerm": originTerm, "startDate": startDate, "originRental": mkLeaseCalc(rental)
                                 ,"obligor": obligorInfo} | mkTag("LeaseInfo")
-                                , vNum(bal)
+                                , vNum(mCurBalance)
                                 , vInt(remainTerms)
                                 , mkAssetStatus(status)]))
 
         case ["固定资产",{"起始日":sd,"初始余额":ob,"初始期限":ot,"残值":rb,"周期":p,"摊销":ar,"产能":cap}
-                      ,{"剩余期限":rt,"余额":bal}] \
+                      ,{"剩余期限":rt,"当前余额":bal}] \
              |["FixedAsset",{"start":sd,"originBalance":ob,"originTerm":ot,"residual":rb,"period":p,"amortize":ar
                                 ,"capacity":cap}
-                            ,{"remainTerm":rt,"balance":bal}]:
+                            ,{"remainTerm":rt,"currentBalance":bal}]:
             return mkTag(("FixedAsset",[{"startDate":vDate(sd),"originBalance":vNum(ob),"originTerm":vInt(ot),"residualBalance":vNum(rb)
                                             ,"period":freqMap[p],"accRule":mkAccRule(ar)
                                             ,"capacity":mkCapacity(cap)} | mkTag("FixedAssetInfo")

docs/requirements.txt

@@ -1,11 +1,12 @@
 sphinx==5.3.0
 sphinx_rtd_theme==1.1.1
+sphinx-autobuild
+standard-imghdr
 readthedocs-sphinx-search==0.3.2
 sphinxemoji
 notebook
 myst-nb
 absbox
-pyxirr
 toolz
 lenses
 dateparser
@@ -14,4 +15,4 @@ pandas
 python-dateutil
 sphinx_changelog
 pytest-notebook
-sphinxcontrib-googleanalytics
+sphinxcontrib-googleanalytics

docs/source/analytics.rst

@@ -845,16 +845,19 @@ cashflow projection will stop at the date specified.
 
 .. versionadded:: 0.46.5 
 
-After 0.46.5, the stop run can be specified by a :ref:`Condition` which will be evaluated on each distribution date described by :ref:`DatePattern`.
+After 0.46.5, the stop run can be specified by a :ref:`Condition` which will be evaluated on each distribution date described by :ref:`DatePattern`. Any condition met will stop the projection.
 
 .. code-block:: python
 
   ("stop", <DatePattern>, *<Condition>)
 
 .. code-block:: python
 
-  # on each month end, the engine will evaluate two conditions, stop projection when ALL of them are met
-  ("stop", "MonthEnd", [">=","2022-01-01"], [("bondBalance","A1"),"<=",200])
+  # on each month end, the engine will evaluate two conditions
+  # , stop projection when ALL of them are met
+
+  ("stop", "MonthEnd"
+         , [">=","2022-01-01"], [("bondBalance","A1"),"<=",200])
 
 
 Project Expense
@@ -1451,6 +1454,9 @@ params:
    * ``showWarning``: if `False`, client won't show warning messages, defualt is `True`
    * ``read`` : if `True` , will try it best to parse the result into `DataFrame`
 
+   .. versionadded:: 0.50.0
+   * ``rtn`` : defaults to [], to get asset level cashflow pass ``["AssetLevelFlow"]``
+
 returns:
    * a map with keys of components like:
   
@@ -1463,6 +1469,8 @@ returns:
      * ``_deal``
      * ``ledgers``
      * ``agg_accounts``
+     .. versionadded:: 0.50.0
+     * ``pool_outstanding``
 
 .. image:: img/deal_cycle_flow.png
   :width: 600
@@ -1692,6 +1700,12 @@ Cashflow Results
    * - ``Ledger flow``
      - if modeled
      - r['ledgers']
+   * - ``Uncollected Pool flow``
+     - if any (after 0.50.0)
+     - r['pool_outstanding']
+   * - ``Asset Level flow``
+     - if any (after 0.50.0) and toggle on
+     - r['pool']['breakdown']
 
 
 * the `run()` function will return a dict which with keys of components like `bonds` `fees` `accounts` `pool`
@@ -1787,6 +1801,8 @@ User have the option to view multiple accounts cashflow in a single dataframe,wi
 Pool Cashflow 
 """"""""""""""""
 
+Pool cashflow collected into SPV.
+
 .. code-block:: python
 
    r['pool']['flow'] # pool cashflow 
@@ -1802,6 +1818,64 @@ The ``readPoolsCf`` function can be used to view multiple pool cashflow.
   readPoolsCf(r['pool']['flow'])
 
 
+Pool cashflow un-collected.
+
+.. versionadded:: 0.50.0
+
+.. code-block:: python
+
+   r['pool_outstanding']['flow'] # pool cashflow to be collected 
+
+Asset level cashflow
+
+.. versionadded:: 0.50.0
+
+.. code-block:: python
+
+   r = api.run(..., rtn=["AssetLevelFlow"], read=True)
+
+   r['pool']['breakdown'] # cashflow list with breakdown
+   r['pool_outstanding']['breakdown'] # cashflow list with breakdown
+
+
+
+Non-Cashflow Results 
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+``r['result']`` save the run result other than cashflow.
+
+.. list-table:: Non Cashflow Results
+   :header-rows: 1
+
+   * - Response Component
+     - Condition
+     - Path
+   * - ``Deal Status flow``
+     - /
+     - r['result']['status']
+   * - ``Bond Summary``
+     - /
+     - r['result']['bonds']
+   * - ``Bond Pricing``
+     - if `pricing` in deal assumption
+     - r['pricing']
+   * - ``Variable Inspect``
+     - if `inspect` in deal assumption
+     - r['result']['inspect']
+   * - ``Variable Inspect``
+     - if `inspect` in deal waterfall
+     - r['result']['waterfallInspect']
+   * - ``Deal Run Logs``
+     - /
+     - r['result']['logs']
+   * - ``Waterfall Run``
+     - /
+     - r['result']['waterfall']
+   * - ``Financial Reports``
+     - if `reports` in deal assumption
+     - r['result']['report']
+
+Bond Pricing 
 Non-Cashflow Results 
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -2276,19 +2350,28 @@ Stress Default
   syntax
     ``stressDefault``
 
+    .. versionadded:: 0.50.1
+    ``("stressDefault", <min factor:float>, <max factor:float>)``
+
 Stress Prepayment
   It will stress the prepayment component in the pool performance assumption.
 
   syntax
     ``stressPrepayment``
 
+    .. versionadded:: 0.50.1
+    ``("stressPrepayment", <min factor:float>, <max factor:float>)``
+
 
 Max Spread
   It will increase the spread of bond.
   
   syntax
     ``("maxSpread", <bondName>)``
 
+    .. versionadded:: 0.50.1
+    ``("maxSpread", <min factor:float>, <max factor:float>)``
+
 Split Balance
   It will adjust balance distribution of two bonds. 
 

docs/source/conf.py

@@ -9,8 +9,8 @@
 copyright = '2025, Xiaoyu Zhang'
 author = 'Xiaoyu Zhang'
 
-release = "0.44.0"
-release = "0.44.0"
+release = "0.50.1"
+release = "0.50.1"
 
 # -- General configuration