modelflowib 2.76__tar.gz → 2.77__tar.gz

{modelflowib-2.76 → modelflowib-2.77}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modelflowib
-Version: 2.76
+Version: 2.77
 Summary: A tool to solve and manage dynamic economic and financial models
 Author-email: Ib Hansen <Ib.Hansen.Iv@gmail.com>
 License-Expression: MIT

{modelflowib-2.76 → modelflowib-2.77}/modelclass.py

@@ -3188,7 +3188,7 @@ class Modify_Mixin():
         newnormalisation = [l.split() for l in lines]
         vars_before_normalization = {beforeendo.upper() for  beforeendo,afterendo in newnormalisation  }
         frml_normalize_strip = {(beforeendo.upper(),afterendo.upper()) : self.allvar[beforeendo]['frml'].replace('$','').split(' ',2)   for beforeendo,afterendo in newnormalisation }
-        frml_normalize_gross = {(beforeendo,afterendo) : (fname ,normal(expression,the_endo = afterendo,endo_lhs=False,add_factor=False))  for (beforeendo,afterendo),(frml,fname,expression)  in frml_normalize_strip.items() }
+        frml_normalize_gross = {(beforeendo,afterendo) : (fname ,normal(expression,the_endo = afterendo,endo_lhs=False,add_add_factor=False))  for (beforeendo,afterendo),(frml,fname,expression)  in frml_normalize_strip.items() }
         frmldict_normalized = {afterendo : f'FRML {fname} {nexpression.normalized}$'
                                for (beforeendo,afterendo),(fname,nexpression)  in frml_normalize_gross.items() }
 #        breakpoint() 
@@ -3282,8 +3282,10 @@ class Modify_Mixin():
 
         Parameters
         ----------
-        updateeq : TYPE
-            new equations seperated by newline . 
+        updateeq : str or Makemodel
+            new equations seperated by newline, or a Makemodel instance whose
+            normalized equations (including per-equation add factors and
+            fitted equations, when present) are used as the update.
         newfunks : TYPE, optional
             Additional userspecified functions. The default is [].
         calc_add : bool, optional
@@ -3297,32 +3299,50 @@ class Modify_Mixin():
             a dataframe with calculated add factors. Origin is the original models lastdf.
 
         '''
-        
-            
-        updatefunks=list(set(self.funks+newfunks) ) # 
-        
-        newmodelname = newname if newname else self.name+' Updated'      
-    
-        dfvars = set(self.lastdf.columns)    
-    
-        updatemodel = mp.tofrml(updateeq)   # create the moedl with the usual processing of frml's 
-        while '  ' in updatemodel:
-            updatemodel = updatemodel.replace('  ', ' ')
-        frml2   = updatemodel.split('$') 
-        frml2_strip = [mp.split_frml(f+'$') for f in frml2 if len(f)>2]
-        frml2_normal = [[frml,fname, 
-                         normal(expression[:-1],do_preprocess=do_preprocess,add_add_factor=add_add_factor,
-                                make_fixable = pt.kw_frml_name(fname.upper(),'FIXABLE'))]
-                           for allfrml,frml,fname,expression in frml2_strip] 
-        frmldict_update = {nexpression.endo_var: f'{frml} {fname} {nexpression.normalized}$' for 
-                           frml,fname,nexpression in frml2_normal} 
-        
-        
-        if add_add_factor:
-            frmldict_calc_add = {nexpression.endo_var: f'{frml} {fname} {nexpression.calc_add_factor}$' for 
-                    frml,fname,nexpression in frml2_normal if nexpression.endo_var in self.endogene|self.exogene|dfvars } 
-        else: 
-            frmldict_calc_add={}
+        from modelconstruct_estimation import Makemodel   # local to avoid circular import
+
+        updatefunks=list(set(self.funks+newfunks) ) #
+
+        newmodelname = newname if newname else self.name+' Updated'
+
+        dfvars = set(self.lastdf.columns)
+        new_var_description = self.var_description
+
+        if isinstance(updateeq, Makemodel):
+            # the Makemodel has already expanded, optionally estimated and normalized the
+            # equations, and decided add factor/fixable/fitted per equation from its flags
+            updatefunks = list(set(updatefunks + updateeq.funks))
+            new_var_description = {**self.var_description, **updateeq.var_description}
+            frml2_normal = [['FRML', fname, nexpression]
+                            for fname, (parts, nexpression)
+                            in zip(updateeq.normal_output_frmlnames, updateeq.normal)]
+            frmldict_update = {nexpression.endo_var: f'{frml} {fname} {nexpression.normalized}$' for
+                               frml,fname,nexpression in frml2_normal}
+            frmldict_update = {**frmldict_update,
+                               **{f'{nexpression.endo_var}_FITTED': f'FRML <FIT> {nexpression.fitted}$'
+                                  for frml,fname,nexpression in frml2_normal if len(nexpression.fitted)}}
+            frmldict_calc_add = {nexpression.endo_var: f'{frml} <CALC_ADD_FACTOR> {nexpression.calc_add_factor}$' for
+                    frml,fname,nexpression in frml2_normal
+                    if len(nexpression.calc_add_factor) and nexpression.endo_var in self.endogene|self.exogene|dfvars }
+        else:
+            updatemodel = mp.tofrml(updateeq)   # create the moedl with the usual processing of frml's
+            while '  ' in updatemodel:
+                updatemodel = updatemodel.replace('  ', ' ')
+            frml2   = updatemodel.split('$')
+            frml2_strip = [mp.split_frml(f+'$') for f in frml2 if len(f)>2]
+            frml2_normal = [[frml,fname,
+                             normal(expression[:-1],do_preprocess=do_preprocess,add_add_factor=add_add_factor,
+                                    make_fixable = pt.kw_frml_name(fname.upper(),'FIXABLE'))]
+                               for allfrml,frml,fname,expression in frml2_strip]
+            frmldict_update = {nexpression.endo_var: f'{frml} {fname} {nexpression.normalized}$' for
+                               frml,fname,nexpression in frml2_normal}
+
+
+            if add_add_factor:
+                frmldict_calc_add = {nexpression.endo_var: f'{frml} {fname} {nexpression.calc_add_factor}$' for
+                        frml,fname,nexpression in frml2_normal if nexpression.endo_var in self.endogene|self.exogene|dfvars }
+            else:
+                frmldict_calc_add={}
         # breakpoint()
             
         frmldict    = {k: v['frml'] for (k,v) in self.allvar.items() if k in self.endogene } # frml's in the existing model 
@@ -3331,8 +3351,8 @@ class Modify_Mixin():
         newfrml     = '\n'.join([f for f in newfrmldict.values()])
         newmodel    =  self.__class__(newfrml,modelname = f'updated {self.name}',
                                       funks=updatefunks,
-                                 var_description=self.var_description, 
-                                 model_description = self.model_description, 
+                                 var_description=new_var_description,
+                                 model_description = self.model_description,
                                  var_groups = self.var_groups , 
                                  reports = self.reports , 
                                  substitution = self.substitution, 

{modelflowib-2.76 → modelflowib-2.77}/modelconstruct_estimation.py

@@ -982,6 +982,16 @@ from IPython.display import display, Markdown, Math
 import re
 from IPython.display import display, Markdown, Math
 
+class Markdown(Markdown):
+    """IPython Markdown, but with the markdown source as the text/plain fallback.
+
+    The stock class reprs as '<IPython.core.display.Markdown object>', and that
+    string is what latex/pdf exporters show, as they can not render the
+    text/markdown mime type and fall back to text/plain. With the source as
+    repr, exported documents show the model text instead."""
+    def __repr__(self):
+        return str(self.data)
+
 def display_model(cell: str, spec: str = "markdown"):
     """
     Display a model specification.

{modelflowib-2.76 → modelflowib-2.77}/modelflowib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modelflowib
-Version: 2.76
+Version: 2.77
 Summary: A tool to solve and manage dynamic economic and financial models
 Author-email: Ib Hansen <Ib.Hansen.Iv@gmail.com>
 License-Expression: MIT

{modelflowib-2.76 → modelflowib-2.77}/modeljupytermagic.py

@@ -27,6 +27,10 @@ from modelclass import model
 from modelmanipulation import explode
 from model_latex_class import a_latex_model
 from modelconstruct_estimation import Makemodel, display_model
+# Markdown subclass whose text/plain fallback is the markdown source itself,
+# so latex/pdf exports show the model text instead of
+# '<IPython.core.display.Markdown object>'. Shadows the IPython import above.
+from modelconstruct_estimation import Markdown
 from modelhelp import debug_var
 from modelreport import LatexRepo
 
@@ -589,7 +593,7 @@ try:
             if dict_name in user_ns:
                 segs = list(user_ns[dict_name].keys())
                 print(f"Model `{name}` built from segments: {', '.join(segs)}")
-            print(f"✅ Created Mexplode model: {name}")
+            print(f"✅ Created Makemodel: {name}")
             print(emodel)
 
         return emodel

{modelflowib-2.76 → modelflowib-2.77}/modelnormalize.py

@@ -129,8 +129,19 @@ def funk_find_arg(funk_match, streng):
             return streng[:start], match[1:index], match[index + 1:]
     assert 1==2,f'Parantese mismatch in {streng}'
 
+def funk_check_arg(funk,arg,udtryk,udtryk_up):
+    '''Guards against variables named like a function.
+
+    A lagged variable with a function name, fx DIFF(-1), matches DIFF( and would
+    silently be swallowed as a function call. If the argument is a pure signed
+    integer it must be such a lag, so raise an informative error instead.'''
+    if re.fullmatch(r'[+-]?\d+',arg.replace(' ','')):
+        raise Exception(f"A variable can not be named {funk}, as {funk}( is a function in the business language.\n"
+                        f"{funk}({arg}) looks like a lagged variable {funk}. Rename the variable.\n"
+                        f"Original expression: {udtryk}\n"
+                        f"Processed so far   : {udtryk_up}")
+
 
- 
 def preprocess(udtryk,funks=[]):
     '''
     test processing expanding dlog,diff,movavg,pct,logit functions 
@@ -146,16 +157,21 @@ def preprocess(udtryk,funks=[]):
 
     '''
     udtryk_up = udtryk.upper().replace(' ','')
+    udtryk_up = funk_replace('PCT','PCT_GROWTH',udtryk_up)
+
     while  dlog_match := funk_in('DLOG',udtryk_up):
          fordlog,dlogudtryk_up,efterdlog=funk_find_arg(dlog_match,udtryk_up)
-         udtryk_up=fordlog+'DIFF(LOG('+dlogudtryk_up+'))'+efterdlog 
-          
+         funk_check_arg('DLOG',dlogudtryk_up,udtryk,udtryk_up)
+         udtryk_up=fordlog+'DIFF(LOG('+dlogudtryk_up+'))'+efterdlog
+
     while  logit_match := funk_in('LOGIT',udtryk_up):
          forlogit,logitudtryk_up,efterlogit=funk_find_arg(logit_match,udtryk_up)
-         udtryk_up=forlogit+'(LOG('+logitudtryk_up+'/(1.0 -'+logitudtryk_up+')))'+efterlogit 
-         
+         funk_check_arg('LOGIT',logitudtryk_up,udtryk,udtryk_up)
+         udtryk_up=forlogit+'(LOG('+logitudtryk_up+'/(1.0 -'+logitudtryk_up+')))'+efterlogit
+
     while  movavg_match := funk_in('MOVAVG', udtryk_up):
          forkaede,kaedeudtryk,efterkaede=funk_find_arg(movavg_match,udtryk_up)
+         funk_check_arg('MOVAVG',kaedeudtryk,udtryk,udtryk_up)
          arg=kaedeudtryk.split(',',1)
          avg='(('
          term=arg[0]
@@ -168,19 +184,23 @@ def preprocess(udtryk,funks=[]):
      
     while  pct_match := funk_in('PCT_GROWTH',udtryk_up):
         forpc,pcudtryk,efterpc=funk_find_arg(pct_match,udtryk_up)
-        udtryk_up=f'{forpc} (100 * ( ({pcudtryk}) / ({lagone(pcudtryk,funks=funks)}) -1)) {efterpc}'           
+        funk_check_arg('PCT_GROWTH',pcudtryk,udtryk,udtryk_up)
+        udtryk_up=f'{forpc} (100 * ( ({pcudtryk}) / ({lagone(pcudtryk,funks=funks)}) -1)) {efterpc}'
 
     while  pct_match := funk_in('PCY',udtryk_up):
         forpc,pcudtryk,efterpc=funk_find_arg(pct_match,udtryk_up)
-        udtryk_up=f'{forpc} (100 * ( ({pcudtryk}) / ({lagone(pcudtryk,funks=funks,laglead=-4)}) -1)) {efterpc}'           
-         
+        funk_check_arg('PCY',pcudtryk,udtryk,udtryk_up)
+        udtryk_up=f'{forpc} (100 * ( ({pcudtryk}) / ({lagone(pcudtryk,funks=funks,laglead=-4)}) -1)) {efterpc}'
+
     while  diff_match := funk_in('DIFF' , udtryk_up):
         fordif,difudtryk_up,efterdif=funk_find_arg(diff_match,udtryk_up)
-        udtryk_up=fordif+'(('+difudtryk_up+')-('+lagone(difudtryk_up+'',funks=funks)+'))'+efterdif  
-         
+        funk_check_arg('DIFF',difudtryk_up,udtryk,udtryk_up)
+        udtryk_up=fordif+'(('+difudtryk_up+')-('+lagone(difudtryk_up+'',funks=funks)+'))'+efterdif
+
     while  diff_match := funk_in('D' , udtryk_up):
         # print(f'{udtryk_up} on D')
         fordif,difudtryk_up,efterdif=funk_find_arg(diff_match,udtryk_up)
+        funk_check_arg('D',difudtryk_up,udtryk,udtryk_up)
         difudtryk_up = difudtryk_up.replace(' ','').replace(',0,1','') if difudtryk_up.endswith(',0,1')  else difudtryk_up
         udtryk_up=fordif+'(('+difudtryk_up+')-('+lagone(difudtryk_up+'',funks=funks)+'))'+efterdif  
          
@@ -407,7 +427,7 @@ if __name__ == '__main__':
     normal('a+b = c',add_add_factor=1,make_fitted=1).fprint
     normal('PCT_growth(a) = n(-1)',add_add_factor=0).fprint
     normal('a = movavg(pct(b),2)',add_add_factor=0).fprint
-    normal('pct_growth(c) = pct_growth(d)',add_add_factor=0).fprint
+    normal('pct_growth(c) = pct_growth(dd)',add_add_factor=0).fprint
     normal('pct_growth(c) = z+pct(b) + pct(e)').fprint
     normal('pct_growth(c) = z+pct(b) + pct(e)').fprint
     normal('a = pct_growth(b)',add_add_factor=0).fprint