typed keystrings

Author: wpbonelli

flopy4/mf6/codec/reader/grammar/__init__.py

@@ -4,7 +4,11 @@
 import jinja2
 from modflow_devtools.dfn import Dfn, get_blocks, get_fields
 
-from flopy4.mf6.codec.reader.grammar.filters import field_type, record_child_type
+from flopy4.mf6.codec.reader.grammar.filters import (
+    field_type,
+    keystring_children,
+    record_child_type,
+)
 
 
 def _get_template_env():
@@ -17,6 +21,7 @@ def _get_template_env():
     )
     env.filters["field_type"] = field_type
     env.filters["record_child_type"] = record_child_type
+    env.filters["keystring_children"] = keystring_children
     return env
 
 

flopy4/mf6/codec/reader/grammar/filters.py

@@ -10,7 +10,7 @@ def field_type(field: Field) -> str:
         case "keyword":
             return ""
         case "keystring":
-            return "record"
+            return ""  # keystrings generate their own union rules
         case _:
             return field["type"]
 
@@ -26,5 +26,14 @@ def record_child_type(field: Field) -> str:
             return "double"
         case "keyword":
             return ""
+        case "keystring":
+            return ""  # keystrings generate their own union rules
         case _:
             return field["type"]
+
+
+def keystring_children(field: Field) -> dict:
+    """Get the children of a keystring field for union generation."""
+    if field["type"] != "keystring":
+        return {}
+    return field.get("children", {})

flopy4/mf6/codec/reader/grammar/generated/chf-cdb.lark

@@ -14,7 +14,7 @@ boundnames: "boundnames"i
 print_input: "print_input"i 
 print_flows: "print_flows"i 
 save_flows: "save_flows"i 
-obs_filerecord: "obs_filerecord"i record
+obs_filerecord: "obs6"i "filein"i string
 maxbound: "maxbound"i integer
 idcxs: "idcxs"i list
 width: "width"i list

flopy4/mf6/codec/reader/grammar/generated/chf-chd.lark

@@ -15,8 +15,8 @@ boundnames: "boundnames"i
 print_input: "print_input"i 
 print_flows: "print_flows"i 
 save_flows: "save_flows"i 
-ts_filerecord: "ts_filerecord"i record
-obs_filerecord: "obs_filerecord"i record
+ts_filerecord: "ts6"i "filein"i string
+obs_filerecord: "obs6"i "filein"i string
 maxbound: "maxbound"i integer
 head: "head"i list
 aux: "aux"i list

flopy4/mf6/codec/reader/grammar/generated/chf-dfw.lark

@@ -13,7 +13,7 @@ time_conversion: "time_conversion"i double precision
 save_flows: "save_flows"i 
 print_flows: "print_flows"i 
 save_velocity: "save_velocity"i 
-obs_filerecord: "obs_filerecord"i record
+obs_filerecord: "obs6"i "filein"i string
 export_array_ascii: "export_array_ascii"i 
 dev_swr_conductance: "dev_swr_conductance"i 
 manningsn: "manningsn"i array

flopy4/mf6/codec/reader/grammar/generated/chf-disv1d.lark

@@ -15,7 +15,7 @@ vertices_fields: (vertices)*
 cell1d_fields: (cell1d)*
 length_units: "length_units"i string
 nogrb: "nogrb"i 
-grb_filerecord: "grb_filerecord"i record
+grb_filerecord: "grb6"i "fileout"i string
 xorigin: "xorigin"i double precision
 yorigin: "yorigin"i double precision
 angrot: "angrot"i double precision

flopy4/mf6/codec/reader/grammar/generated/chf-evp.lark

@@ -15,8 +15,8 @@ boundnames: "boundnames"i
 print_input: "print_input"i 
 print_flows: "print_flows"i 
 save_flows: "save_flows"i 
-ts_filerecord: "ts_filerecord"i record
-obs_filerecord: "obs_filerecord"i record
+ts_filerecord: "ts6"i "filein"i string
+obs_filerecord: "obs6"i "filein"i string
 maxbound: "maxbound"i integer
 evaporation: "evaporation"i list
 aux: "aux"i list

flopy4/mf6/codec/reader/grammar/generated/chf-flw.lark

@@ -15,8 +15,8 @@ boundnames: "boundnames"i
 print_input: "print_input"i 
 print_flows: "print_flows"i 
 save_flows: "save_flows"i 
-ts_filerecord: "ts_filerecord"i record
-obs_filerecord: "obs_filerecord"i record
+ts_filerecord: "ts6"i "filein"i string
+obs_filerecord: "obs6"i "filein"i string
 maxbound: "maxbound"i integer
 q: "q"i list
 aux: "aux"i list

flopy4/mf6/codec/reader/grammar/generated/chf-oc.lark

@@ -7,10 +7,17 @@ options_block: "begin"i "options"i options_fields "end"i "options"i
 period_block: "begin"i "period"i period_fields "end"i "period"i
 options_fields: (budget_filerecord | budgetcsv_filerecord | qoutflow_filerecord | stage_filerecord | qoutflowprintrecord)*
 period_fields: (saverecord | printrecord)*
-budget_filerecord: "budget_filerecord"i record
-budgetcsv_filerecord: "budgetcsv_filerecord"i record
-qoutflow_filerecord: "qoutflow_filerecord"i record
-stage_filerecord: "stage_filerecord"i record
-qoutflowprintrecord: "qoutflowprintrecord"i record
-saverecord: "saverecord"i record
-printrecord: "printrecord"i record
+budget_filerecord: "budget"i "fileout"i string
+budgetcsv_filerecord: "budgetcsv"i "fileout"i string
+qoutflow_filerecord: "qoutflow"i "fileout"i string
+stage_filerecord: "stage"i "fileout"i string
+qoutflowprintrecord: "qoutflow"i "print_format"i
+saverecord: "save"i string ocsetting
+printrecord: "print"i string ocsetting
+ocsetting: ocsetting_all | ocsetting_first | ocsetting_last | ocsetting_frequency | ocsetting_steps
+ocsetting_all: "all"i
+ocsetting_first: "first"i
+ocsetting_last: "last"i
+ocsetting_frequency: "frequency"i integer
+ocsetting_steps: "steps"i integer
+

flopy4/mf6/codec/reader/grammar/generated/chf-pcp.lark

@@ -15,8 +15,8 @@ boundnames: "boundnames"i
 print_input: "print_input"i 
 print_flows: "print_flows"i 
 save_flows: "save_flows"i 
-ts_filerecord: "ts_filerecord"i record
-obs_filerecord: "obs_filerecord"i record
+ts_filerecord: "ts6"i "filein"i string
+obs_filerecord: "obs6"i "filein"i string
 maxbound: "maxbound"i integer
 precipitation: "precipitation"i list
 aux: "aux"i list