better name, subclassing for easy extension to load

python/damask/__init__.py

@@ -10,20 +10,21 @@ with open(_Path(__file__).parent/_Path('VERSION')) as _f:
 # make classes directly accessible as damask.Class
 from ._environment import Environment as _ # noqa
 environment = _()
-from ._table       import Table            # noqa
+from ._table           import Table            # noqa
-from ._vtk         import VTK              # noqa
+from ._vtk             import VTK              # noqa
-from ._colormap    import Colormap         # noqa
+from ._colormap        import Colormap         # noqa
-from ._rotation    import Rotation         # noqa
+from ._rotation        import Rotation         # noqa
-from ._lattice     import Symmetry, Lattice# noqa
+from ._lattice         import Symmetry, Lattice# noqa
-from ._orientation import Orientation      # noqa
+from ._orientation     import Orientation      # noqa
-from ._result      import Result           # noqa
+from ._result          import Result           # noqa
-from ._geom        import Geom             # noqa
+from ._geom            import Geom             # noqa
-from ._material    import Material         # noqa
+from ._config          import Config           # noqa
-from .             import solver           # noqa
+from ._configmaterial  import ConfigMaterial   # noqa
-from .             import util             # noqa
+from .                 import solver           # noqa
-from .             import seeds            # noqa
+from .                 import util             # noqa
-from .             import grid_filters     # noqa
+from .                 import seeds            # noqa
-from .             import mechanics        # noqa
+from .                 import grid_filters     # noqa
+from .                 import mechanics        # noqa
 
 
 

python/damask/_config.py

@@ -0,0 +1,66 @@
+from io import StringIO
+import abc
+
+import yaml
+import numpy as np
+
+class NiceDumper(yaml.SafeDumper):
+    """Make YAML readable for humans."""
+
+    def write_line_break(self, data=None):
+        super().write_line_break(data)
+
+        if len(self.indents) == 1:
+            super().write_line_break()
+
+    def increase_indent(self, flow=False, indentless=False):
+        return super().increase_indent(flow, False)
+
+
+class Config(dict):
+    """YAML-based configuration."""
+
+    def __repr__(self):
+        """Show as in file."""
+        output = StringIO()
+        self.save(output)
+        output.seek(0)
+        return ''.join(output.readlines())
+
+    @classmethod
+    def load(cls,fname):
+        """Load from yaml file."""
+        try:
+            fhandle = open(fname)
+        except TypeError:
+            fhandle = fname
+        return cls(yaml.safe_load(fhandle))
+
+    def save(self,fname='material.yaml'):
+        """
+        Save to yaml file.
+
+        Parameters
+        ----------
+        fname : file, str, or pathlib.Path
+            Filename or file for reading.
+
+        """
+        try:
+            fhandle = open(fname,'w')
+        except TypeError:
+            fhandle = fname
+        fhandle.write(yaml.dump(dict(self),width=256,default_flow_style=None,Dumper=NiceDumper))
+
+
+    @property
+    @abc.abstractmethod
+    def is_complete(self):
+        """Check for completeness."""
+        pass
+
+    @property
+    @abc.abstractmethod
+    def is_valid(self):
+        """Check for valid file layout."""
+        pass

python/damask/_configmaterial.py

@@ -1,61 +1,14 @@
-from io import StringIO
 import copy
 
-import yaml
 import numpy as np
 
+from . import Config
 from . import Lattice
 from . import Rotation
 
-class NiceDumper(yaml.SafeDumper):
+class ConfigMaterial(Config):
-    """Make YAML readable for humans."""
-
-    def write_line_break(self, data=None):
-        super().write_line_break(data)
-
-        if len(self.indents) == 1:
-            super().write_line_break()
-
-    def increase_indent(self, flow=False, indentless=False):
-        return super().increase_indent(flow, False)
-
-
-class Material(dict):
     """Material configuration."""
 
-    def __repr__(self):
-        """Show as in file."""
-        output = StringIO()
-        self.save(output)
-        output.seek(0)
-        return ''.join(output.readlines())
-
-    @staticmethod
-    def load(fname):
-        """Load from yaml file."""
-        try:
-            fhandle = open(fname)
-        except TypeError:
-            fhandle = fname
-        return Material(yaml.safe_load(fhandle))
-
-    def save(self,fname='material.yaml'):
-        """
-        Save to yaml file.
-
-        Parameters
-        ----------
-        fname : file, str, or pathlib.Path
-            Filename or file for reading.
-
-        """
-        try:
-            fhandle = open(fname,'w')
-        except TypeError:
-            fhandle = fname
-        fhandle.write(yaml.dump(dict(self),width=256,default_flow_style=None,Dumper=NiceDumper))
-
-
     @property
     def is_complete(self):
         """Check for completeness."""

python/tests/test_MaterialConfig.py

@@ -2,60 +2,60 @@ import os
 
 import pytest
 
-from damask import Material
+from damask import ConfigMaterial
 
 @pytest.fixture
 def reference_dir(reference_dir_base):
     """Directory containing reference results."""
-    return reference_dir_base/'Material'
+    return reference_dir_base/'ConfigMaterial'
 
 
 class TestMaterial:
     
     @pytest.mark.parametrize('fname',[None,'test.yaml'])
     def test_load_save(self,reference_dir,tmp_path,fname):
-        reference = Material.load(reference_dir/'material.yaml')
+        reference = ConfigMaterial.load(reference_dir/'material.yaml')
         os.chdir(tmp_path)
         if fname is None:
             reference.save()
-            new = Material.load('material.yaml')
+            new = ConfigMaterial.load('material.yaml')
         else:
             reference.save(fname)
-            new = Material.load(fname)
+            new = ConfigMaterial.load(fname)
         assert reference == new
 
     def test_valid_complete(self,reference_dir):
-        material_config = Material.load(reference_dir/'material.yaml')
+        material_config = ConfigMaterial.load(reference_dir/'material.yaml')
         assert material_config.is_valid and material_config.is_complete
 
     def test_invalid_lattice(self,reference_dir):
-        material_config = Material.load(reference_dir/'material.yaml')
+        material_config = ConfigMaterial.load(reference_dir/'material.yaml')
         material_config['phase']['Aluminum']['lattice']='fxc'
         assert not material_config.is_valid
     
     def test_invalid_orientation(self,reference_dir):
-        material_config = Material.load(reference_dir/'material.yaml')
+        material_config = ConfigMaterial.load(reference_dir/'material.yaml')
         material_config['microstructure'][0]['constituents'][0]['orientation']=[0,0,0,0]
         assert not material_config.is_valid
     
     def test_invalid_fraction(self,reference_dir):
-        material_config = Material.load(reference_dir/'material.yaml')
+        material_config = ConfigMaterial.load(reference_dir/'material.yaml')
         material_config['microstructure'][0]['constituents'][0]['fraction']=.9
         assert not material_config.is_valid
     
 
     @pytest.mark.parametrize('item',['homogenization','phase','microstructure'])
     def test_incomplete_missing(self,reference_dir,item):
-        material_config = Material.load(reference_dir/'material.yaml')
+        material_config = ConfigMaterial.load(reference_dir/'material.yaml')
         del material_config[item]
         assert not material_config.is_complete
     
     def test_incomplete_wrong_phase(self,reference_dir):
-        material_config = Material.load(reference_dir/'material.yaml')
+        material_config = ConfigMaterial.load(reference_dir/'material.yaml')
         new = material_config.microstructure_rename_phase({'Steel':'FeNbC'})
         assert not new.is_complete
     
     def test_incomplete_wrong_homogenization(self,reference_dir):
-        material_config = Material.load(reference_dir/'material.yaml')
+        material_config = ConfigMaterial.load(reference_dir/'material.yaml')
         new = material_config.microstructure_rename_homogenization({'Taylor':'isostrain'})
         assert not new.is_complete