refactor(pakbase): generate heading from base class (#1196)

flopy/mbase.py

@@ -1183,13 +1183,8 @@ def set_version(self, version):
         # set heading for each package
         for p in self.get_package_list():
             pak = self.get_package(p)
-            heading = (
-                "# {} package for ".format(pak.name[0])
-                + "{}, ".format(self.version_types[self.version])
-                + "generated by Flopy version {}.".format(__version__)
-            )
-
-            pak.heading = heading
+            if hasattr(pak, "heading"):
+                pak._generate_heading()
 
         return None
 

flopy/modflow/mfag.py

@@ -226,9 +226,7 @@ def __init__(
         )
 
         # set up class
-        self.heading = "# {} package for {}, generated by flopy\n".format(
-            self.name[0], model.version_types[model.version]
-        )
+        self._generate_heading()
         self.url = "ag.htm"
 
         # options
@@ -336,7 +334,7 @@ def write_file(self, check=False):
         ws = self.parent.model_ws
         name = self.file_name[0]
         with open(os.path.join(ws, name), "w") as foo:
-            foo.write(self.heading)
+            foo.write(f"{self.heading}\n")
 
             # update options
             self.options.update_from_package(self)

flopy/modflow/mfbas.py

@@ -155,11 +155,7 @@ def __init__(
             name="strt",
             locat=self.unit_number[0],
         )
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.options = ""
         self.ixsec = ixsec
         self.ichflg = ichflg

flopy/modflow/mfchd.py

@@ -143,11 +143,7 @@ def __init__(
         )
 
         self.url = "chd.htm"
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
 
         if dtype is not None:
             self.dtype = dtype

flopy/modflow/mfde4.py

@@ -169,11 +169,7 @@ def __init__(
             )
             raise Exception(err)
 
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.url = "de4.htm"
 
         self.itmx = itmx

flopy/modflow/mfdis.py

@@ -188,11 +188,7 @@ def __init__(
                 botm = np.linspace(top, botm, nlay)
 
         # Set values of all parameters
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.laycbd = Util2d(
             model, (self.nlay,), np.int32, laycbd, name="laycbd"
         )

flopy/modflow/mfdisu.py

@@ -263,11 +263,7 @@ def __init__(
 
         # Set values of all parameters
         self.url = "dis.htm"
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
 
         self.nodes = nodes
         self.nlay = nlay

flopy/modflow/mfdrn.py

@@ -170,11 +170,7 @@ def __init__(
             filenames=fname,
         )
 
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.url = "drn.htm"
 
         self.ipakcb = ipakcb

flopy/modflow/mfdrt.py

@@ -168,11 +168,7 @@ def __init__(
             filenames=fname,
         )
 
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.url = "drt.htm"
 
         self.ipakcb = ipakcb

flopy/modflow/mfevt.py

@@ -142,11 +142,7 @@ def __init__(
         )
 
         nrow, ncol, nlay, nper = self.parent.nrow_ncol_nlay_nper
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.url = "evt.htm"
         self.nevtop = nevtop
         self.ipakcb = ipakcb

flopy/modflow/mffhb.py

@@ -198,11 +198,7 @@ def __init__(
             filenames=fname,
         )
 
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.url = "flow_and_head_boundary_packag2.htm"
 
         self.nbdtim = nbdtim

flopy/modflow/mfgage.py

@@ -203,11 +203,7 @@ def __init__(
             filenames=fname,
         )
 
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        # no heading for this format
         self.url = "gage.htm"
 
         self.numgage = numgage
@@ -262,11 +258,7 @@ def write_file(self):
         """
         f = open(self.fn_path, "w")
 
-        # # dataset 0
-        # vn = self.parent.version_types[self.parent.version]
-        # self.heading = '# {} package for '.format(self.name[0]) + \
-        #                '{}, generated by Flopy.'.format(vn)
-        # f.write('{0}\n'.format(self.heading))
+        # no heading for this format
 
         # dataset 1
         f.write(write_fixed_var([self.numgage], free=True))
@@ -335,15 +327,12 @@ def load(cls, f, model, nper=None, ext_unit_dict=None):
             filename = f
             f = open(filename, "r", errors="replace")
 
-        # dataset 0 -- header
-        while True:
-            line = f.readline().rstrip()
-            if line[0] != "#":
-                break
+        # no heading for this format
 
         # read dataset 1
         if model.verbose:
             print("   reading gage dataset 1")
+        line = f.readline().rstrip()
         t = read_fixed_var(line, free=True)
         numgage = int(t[0])
 

flopy/modflow/mfghb.py

@@ -163,11 +163,7 @@ def __init__(
             filenames=fname,
         )
 
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.url = "ghb.htm"
 
         self.ipakcb = ipakcb

flopy/modflow/mfgmg.py

@@ -263,11 +263,7 @@ def __init__(
             )
             raise Exception(err)
 
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.url = "gmg.htm"
 
         self.mxiter = mxiter

flopy/modflow/mfhfb.py

@@ -143,11 +143,7 @@ def __init__(
             filenames=fname,
         )
 
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.url = "hfb6.htm"
 
         self.nphfb = nphfb

flopy/modflow/mfhob.py

@@ -149,11 +149,7 @@ def __init__(
         )
 
         self.url = "hob.htm"
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
 
         self.iuhobsv = iuhobsv
         self.hobdry = hobdry

flopy/modflow/mfhyd.py

@@ -173,11 +173,7 @@ def __init__(
         )
 
         nrow, ncol, nlay, nper = self.parent.nrow_ncol_nlay_nper
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.url = "hyd.htm"
 
         self.nhyd = nhyd

flopy/modflow/mflak.py

@@ -279,7 +279,7 @@ def __init__(
         filenames=None,
         options=None,
         lwrt=0,
-        **kwargs
+        **kwargs,
     ):
         """
         Package constructor.
@@ -365,11 +365,7 @@ def __init__(
             filenames=fname,
         )
 
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.url = "lak.htm"
 
         if options is None:
@@ -511,10 +507,8 @@ def write_file(self):
         """
         f = open(self.fn_path, "w")
         # dataset 0
-        self.heading = "# {} package for ".format(
-            self.name[0]
-        ) + "{}, generated by Flopy.".format(self.parent.version)
-        f.write("{0}\n".format(self.heading))
+        if self.parent.version != "mf2k":
+            f.write(f"{self.heading}\n")
 
         # dataset 1a
         if len(self.options) > 0:

flopy/modflow/mflmt.py

@@ -116,11 +116,7 @@ def __init__(
             filenames=fname,
         )
 
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.url = "lmt.htm"
         self.output_file_name = output_file_name
         self.output_file_unit = output_file_unit

flopy/modflow/mflpf.py

@@ -255,11 +255,7 @@ def __init__(
             filenames=fname,
         )
 
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.url = "lpf.htm"
         nrow, ncol, nlay, nper = self.parent.nrow_ncol_nlay_nper
 

flopy/modflow/mfmlt.py

@@ -99,11 +99,7 @@ def __init__(
             filenames=fname,
         )
 
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.url = "mult.htm"
 
         self.nml = 0

flopy/modflow/mfmnw1.py

@@ -132,11 +132,7 @@ def __init__(
 
         self.url = "mnw1.htm"
         self.nper = self.parent.nrow_ncol_nlay_nper[-1]
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.mxmnw = (
             mxmnw  # -maximum number of multi-node wells to be simulated
         )

flopy/modflow/mfmnw2.py

@@ -1064,11 +1064,7 @@ def __init__(
         self.structured = self.parent.structured
 
         # Dataset 0
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         # Dataset 1
         # maximum number of multi-node wells to be simulated
         self.mnwmax = int(mnwmax)

flopy/modflow/mfmnwi.py

@@ -162,11 +162,7 @@ def __init__(
         )
 
         self.url = "mnwi.htm"
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         # integer flag indicating output to be written for each MNW node at
         # the end of each stress period
         self.wel1flag = wel1flag

flopy/modflow/mfnwt.py

@@ -272,11 +272,7 @@ def __init__(
             filenames=fname,
         )
 
-        self.heading = (
-            "# {} package for ".format(self.name[0])
-            + " {}, ".format(model.version_types[model.version])
-            + "generated by Flopy."
-        )
+        self._generate_heading()
         self.url = "nwt_newton_solver.htm"
         self.headtol = headtol
         self.fluxtol = fluxtol