Determine filename in plates before iterating

This eliminates the need for the awkward InchoateFiles context
manager.

Author: amorison

stagpy/misc.py

@@ -1,9 +1,6 @@
 """Miscellaneous definitions."""
 
 from inspect import getdoc
-import pathlib
-import shutil
-import tempfile
 
 import matplotlib.pyplot as plt
 
@@ -152,82 +149,3 @@ def __get__(self, instance, _):
     def __set__(self, instance, _):
         raise AttributeError(
             f'Cannot set {self._name} property of {instance!r}')
-
-
-class InchoateFiles:
-    """Context manager handling files whose names are not known yet.
-
-    Example:
-        InchoateFiles is used here to manage three files::
-
-            with InchoateFiles(3) as incho:
-                # for convenience, incho[x] is the same as incho.fids[x]
-                incho[0].write('First file')
-                incho[1].write('Second file')
-                incho[2].write('Third file')
-
-                # the three files will be named 'tata', 'titi' and 'toto'
-                incho.fnames = ['tata', 'titi', 'toto']
-
-    Args:
-        nfiles (int): number of files. Defaults to 1.
-        tmp_prefix (str): prefix name of temporary files. Use this
-            parameter if you want to easily track down the temporary files
-            created by the manager.
-    """
-
-    def __init__(self, nfiles=1, tmp_prefix=None):
-        self._fnames = [f'inchoate{i}' for i in range(nfiles)]
-        self._tmpprefix = tmp_prefix
-        self._fids = []
-
-    @property
-    def fids(self):
-        """List of files id.
-
-        Use this to perform operations on files when the context manager is
-        used. :meth:`InchoateFiles.__getitem__` is implemented in order to
-        provide direct access to this property content (``self[x]`` is the
-        same as ``self.fids[x]``).
-        """
-        return self._fids
-
-    @property
-    def fnames(self):
-        """List of filenames.
-
-        Set this to the list of final filenames before exiting the context
-        manager. If this list is not set by the user, the produced files will
-        be named ``'inchoateN'`` with ``N`` the index of the file. If the list
-        of names you set is too long, it will be truncated. If it is too short,
-        extra files will be named ``'inchoateN'``.
-        """
-        return self._fnames
-
-    @fnames.setter
-    def fnames(self, names):
-        """Ensure constant size of fnames."""
-        names = list(names[:len(self._fnames)])
-        self._fnames = names + self._fnames[len(names):]
-
-    def __getitem__(self, idx):
-        return self._fids[idx]
-
-    def __enter__(self):
-        """Create temporary files."""
-        for fname in self.fnames:
-            pfx = fname if self._tmpprefix is None else self._tmpprefix
-            self._fids.append(
-                tempfile.NamedTemporaryFile(
-                    mode='w', prefix=pfx, delete=False))
-        return self
-
-    def __exit__(self, *exc_info):
-        """Give temporary files their final names."""
-        for tmp in self._fids:
-            tmp.close()
-        if exc_info[0] is None:
-            for fname, tmp in zip(self.fnames, self._fids):
-                shutil.copyfile(tmp.name, fname)
-        for tmp in self._fids:
-            pathlib.Path(tmp.name).unlink()

stagpy/plates.py

@@ -1,6 +1,6 @@
 """Plate analysis."""
 
-import pathlib
+from contextlib import ExitStack
 
 import matplotlib.pyplot as plt
 import numpy as np
@@ -611,19 +611,19 @@ def main_plates(sdat):
         isurf = -1
         vrms_surface = uprof_averaged.iloc[isurf]
 
-    with misc.InchoateFiles(8, 'plates') as fids:
-        fids.fnames = ['plate_velocity', 'distance_subd', 'continents',
-                       'flux', 'topography', 'age', 'velderiv', 'velocity']
+    # determine names of files
+    fnames = ['plate_velocity', 'distance_subd', 'continents',
+              'flux', 'topography', 'age', 'velderiv', 'velocity']
+    fnames = [f'plates_{stem}_{sdat.walk.stepstr}' for stem in fnames]
+    with ExitStack() as stack:
+        fids = [stack.enter_context(open(fname)) for fname in fnames]
         fids[0].write('#  it  time  ph_trench vel_trench age_trench\n')
         fids[1].write('#  it      time   time [My]   distance     '
                       'ph_trench     ph_cont  age_trench [My]\n')
 
-        istart, iend = None, None
         for step in sdat.walk.filter(fields=['T']):
             # could check other fields too
             timestep = step.isnap
-            istart = timestep if istart is None else istart
-            iend = timestep
             print('Treating snapshot', timestep)
 
             rcmb = step.geom.rcmb
@@ -760,17 +760,6 @@ def main_plates(sdat):
 
                 misc.saveplot(fig, 'sx', timestep)
 
-        # determine names of files
-        ptn = misc.out_name('{}_{}_{}')
-        stem = ptn.format(fids.fnames[0], istart, iend)
-        idx = 0
-        fmt = '{}.dat'
-        while pathlib.Path(fmt.format(stem, idx)).is_file():
-            fmt = '{}_{}.dat'
-            idx += 1
-        fids.fnames = [fmt.format(ptn.format(fname, istart, iend), idx)
-                       for fname in fids.fnames]
-
 
 def cmd():
     """Implementation of plates subcommand.