Remove files and binfiles_set from StagyyData API

Author: amorison

docs/sources/apiref/stagyydata.rst

@@ -2,6 +2,4 @@ stagyydata
 =============
 
 .. automodule:: stagpy.stagyydata
-   :members:
-   :private-members:
-   :exclude-members: _bind, _as_view_item, _read_refstate, _pass
+   :members: _Scales, _Refstate, _Steps, _Snaps, _StepsView, StagyyData

stagpy/_step.py

@@ -289,7 +289,7 @@ def geom(self):
         None if not available for this time step.
         """
         if self._header is UNDETERMINED:
-            binfiles = self.step.sdat.binfiles_set(self.step.isnap)
+            binfiles = self.step.sdat._binfiles_set(self.step.isnap)
             if binfiles:
                 self._header = stagyyparsers.fields(binfiles.pop(),
                                                     only_header=True)

stagpy/stagyydata.py

@@ -15,7 +15,7 @@
 
 
 def _as_view_item(obj):
-    """Return None or a suitable iterable to build a _StepView."""
+    """Return None or a suitable iterable to build a _StepsView."""
     try:
         iter(obj)
         return obj
@@ -327,7 +327,7 @@ def __getitem__(self, isnap):
             istep = self._isteps.get(
                 isnap, None if self._all_isteps_known else UNDETERMINED)
         if istep is UNDETERMINED:
-            binfiles = self.sdat.binfiles_set(isnap)
+            binfiles = self.sdat._binfiles_set(isnap)
             if binfiles:
                 istep = stagyyparsers.fields(binfiles.pop(), only_istep=True)
             else:
@@ -357,7 +357,7 @@ def __len__(self):
                 rgx = re.compile(
                     '^{}_([a-zA-Z]+)([0-9]{{5}})$'.format(out_stem))
                 fstems = set(fstem for fstem in phyvars.FIELD_FILES)
-                for fname in self.sdat.files:
+                for fname in self.sdat._files:
                     match = rgx.match(fname.name)
                     if match is not None and match.group(1) in fstems:
                         self._last = max(int(match.group(2)), self._last)
@@ -536,6 +536,7 @@ def __init__(self, path=None):
             steps (:class:`_Steps`): collection of time steps.
             snaps (:class:`_Snaps`): collection of snapshots.
             scales (:class:`_Scales`): dimensionful scaling factors.
+            refstate (:class:`_Refstate`): reference state profiles.
         """
         if path is None:
             path = conf.core.path
@@ -657,7 +658,7 @@ def rtimes(self):
         return self._rprof_and_times[1]
 
     @property
-    def files(self):
+    def _files(self):
         """Set of found binary files output by StagYY."""
         if self._rundir['ls'] is UNDETERMINED:
             out_stem = pathlib.Path(self.par['ioin']['output_file_stem'] + '_')
@@ -778,7 +779,7 @@ def filename(self, fname, timestep=None, suffix='', force_legacy=False):
             fpath = self.path / fpath
         return fpath
 
-    def binfiles_set(self, isnap):
+    def _binfiles_set(self, isnap):
         """Set of existing binary files at a given snap.
 
         Args:
@@ -789,4 +790,4 @@ def binfiles_set(self, isnap):
         """
         possible_files = set(self.filename(fstem, isnap, force_legacy=True)
                              for fstem in phyvars.FIELD_FILES)
-        return possible_files & self.files
+        return possible_files & self._files