FIX: Use pathlib instead of os for managing filesystem paths.

Author: baagaard-usgs

pylith/meshio/DataWriter.py

@@ -8,7 +8,7 @@
 # See https://mit-license.org/ and LICENSE.md and for license information. 
 # =================================================================================================
 
-import os
+import pathlib
 
 from pylith.utils.PetscComponent import PetscComponent
 
@@ -29,23 +29,21 @@ def preinitialize(self):
         self._createModuleObj()
 
     @staticmethod
-    def mkfilename(outputDir, simName, label, suffix):
+    def makeFilename(outputDir, simName, label, suffix):
         """Create filename from output directory, simulation name, label, and filename suffix.
         """
-        filename = os.path.join(outputDir, "{}-{}.{}".format(simName, label, suffix))
-        return filename
+        return pathlib.Path(outputDir) / f"{simName}-{label}.{suffix}"
 
-    def mkpath(self, filename):
+    def makePath(self, filename):
         """Create path for output file.
         """
         from pylith.mpi.Communicator import mpi_is_root
         isRoot = mpi_is_root()
         if isRoot:
             self._info.log("Creating path for output file '{}'".format(filename))
-        relpath = os.path.dirname(filename)
-
-        if relpath and not os.path.exists(relpath) and isRoot:
-            os.makedirs(relpath)
+        relpath = pathlib.Path(filename).parent.resolve()
+        if isRoot:
+            relpath.mkdir(exist_ok=True, parents=True)
 
     def verifyConfiguration(self):
         """Verify compatibility of configuration.

pylith/meshio/DataWriterHDF5.py

@@ -46,9 +46,9 @@ def setFilename(self, outputDir, simName, label):
         """Set filename from default options and inventory. If filename is given in inventory, use it,
         otherwise create filename from default options.
         """
-        filename = self.filename or DataWriter.mkfilename(outputDir, simName, label, "h5")
-        self.mkpath(filename)
-        ModuleDataWriterHDF5.filename(self, filename)
+        filename = self.filename or DataWriter.makeFilename(outputDir, simName, label, "h5")
+        self.makePath(filename)
+        ModuleDataWriterHDF5.filename(self, str(filename))
 
     def _createModuleObj(self):
         """Create handle to C++ object."""

pylith/meshio/DataWriterHDF5Ext.py

@@ -44,9 +44,9 @@ def setFilename(self, outputDir, simName, label):
         """Set filename from default options and inventory. If filename is given in inventory, use it,
         otherwise create filename from default options.
         """
-        filename = self.filename or DataWriter.mkfilename(outputDir, simName, label, "h5")
-        self.mkpath(filename)
-        ModuleDataWriterHDF5Ext.filename(self, filename)
+        filename = self.filename or DataWriter.makeFilename(outputDir, simName, label, "h5")
+        self.makePath(filename)
+        ModuleDataWriterHDF5Ext.filename(self, str(filename))
 
     def close(self):
         """Close writer.

pylith/meshio/DataWriterVTK.py

@@ -62,9 +62,9 @@ def setFilename(self, outputDir, simName, label):
         """Set filename from default options and inventory. If filename is given in inventory, use it,
         otherwise create filename from default options.
         """
-        filename = self.filename or DataWriter.mkfilename(outputDir, simName, label, "vtk")
-        self.mkpath(filename)
-        ModuleDataWriterVTK.filename(self, filename)
+        filename = self.filename or DataWriter.makeFilename(outputDir, simName, label, "vtk")
+        self.makePath(filename)
+        ModuleDataWriterVTK.filename(self, str(filename))
 
     def _configure(self):
         """Configure object.

pylith/problems/ProgressMonitor.py

@@ -44,15 +44,12 @@ def preinitialize(self, defaults):
     def _createPath(self):
         """Create path for filename if it doesn't exist.
         """
-        import os
+        import pathlib
         import pylith.mpi.mpi as mpi
 
-        relpath = os.path.dirname(self.filename)
-        if relpath and not os.path.exists(relpath):
-            # Only create directory on master
-            isMaster = 0 == mpi.rank()
-            if isMaster:
-                os.makedirs(relpath)
+        relpath = pathlib.Path(self.filename).parent.resolve()
+        if 0 == mpi.rank(mpi.petsc_comm_world()):
+            relpath.mkdir(exist_ok=True, parents=True)
 
     def _createModuleObj(self):
         """Create handle to corresponding C++ object.

pylith/utils/DumpParameters.py

@@ -122,9 +122,8 @@ def _createPath(self, filename):
         """
         import pathlib
 
-        parentDir = pathlib.Path(filename).parent
-        if parentDir:
-            parentDir.mkdir(exist_ok=True)
+        parentDir = pathlib.Path(filename).parent.resolve()
+        parentDir.mkdir(exist_ok=True, parents=True)
 
 
 # End of file

tests/pytests/meshio/TestDataWriter.py

@@ -19,10 +19,10 @@ class TestDataWriter(TestAbstractComponent):
     """
     _class = DataWriter
 
-    def test_mkfilename(self):
+    def test_makeFilename(self):
         writer = DataWriter()
-        filename = writer.mkfilename(outputDir="abc", simName="defg", label="hijkl", suffix="hx3")
-        self.assertEqual("abc/defg-hijkl.hx3", filename)
+        filename = writer.makeFilename(outputDir="abc", simName="defg", label="hijkl", suffix="hx3")
+        self.assertEqual("abc/defg-hijkl.hx3", str(filename))
 
 
 def load_tests(loader, tests, pattern):