Documentation & Typing Part 1

hexrd/core/config/config.py

@@ -19,8 +19,8 @@ class Config(object):
 
     _dirty = False
 
-    def __init__(self, cfg):
-        self._cfg = cfg
+    def __init__(self, cfg: 'Config'):
+        self._cfg = cfg # TODO: This should really be called "_parent"
 
     @property
     def parent(self):

hexrd/core/config/material.py

@@ -4,6 +4,7 @@
 
 from hexrd.core import material
 from hexrd.core.constants import keVToAngstrom
+from hexrd.core.material.crystallography import PlaneData
 from hexrd.core.valunits import valWUnit
 
 from .config import Config
@@ -82,16 +83,13 @@ def exclusion_parameters(self):
         return self._exclusion_parameters
 
     @property
-    def plane_data(self):
+    def plane_data(self) -> PlaneData:
         """crystallographic information"""
-        #
-        # Only generate this once, not on each call.
-        #
         if not hasattr(self, "_plane_data"):
             self._plane_data = self._make_plane_data()
         return self._plane_data
 
-    def _make_plane_data(self):
+    def _make_plane_data(self) -> PlaneData:
         """Return the active material PlaneData class."""
         pd = self.materials[self.active].planeData
         pd.tThWidth = np.radians(self.tthw)
@@ -100,7 +98,7 @@ def _make_plane_data(self):
         return pd
 
     @property
-    def beam_energy(self):
+    def beam_energy(self) -> float:
         return keVToAngstrom(self.plane_data.wavelength)
 
     @beam_energy.setter

hexrd/core/config/root.py

@@ -95,7 +95,7 @@ def fit_grains(self):
         return self._fitgrain_config
 
     @property
-    def instrument(self):
+    def instrument(self) -> Instrument:
         if not hasattr(self, '_instr_config'):
             instr_file = self.get('instrument', None)
             if instr_file is not None:
@@ -104,11 +104,11 @@ def instrument(self):
         return self._instr_config
 
     @instrument.setter
-    def instrument(self, instr_config):
+    def instrument(self, instr_config: Instrument):
         self._instr_config = instr_config
 
     @property
-    def material(self):
+    def material(self) -> MaterialConfig:
         if not hasattr(self, '_material_config'):
             self._material_config = MaterialConfig(self)
 
@@ -120,7 +120,7 @@ def material(self):
         return self._material_config
 
     @material.setter
-    def material(self, material_config):
+    def material(self, material_config: MaterialConfig):
         self._material_config = material_config
 
     @property
@@ -174,10 +174,10 @@ def multiprocessing(self, val):
             )
 
     @property
-    def image_series(self):
+    def image_series(self) -> dict[str, imageseries.omega.OmegaImageSeries]:
         """Return the imageseries dictionary."""
         if not hasattr(self, '_image_dict'):
-            self._image_dict = dict()
+            self._image_dict: dict[str, imageseries.omega.OmegaImageSeries] = {}
             fmt = self.get('image_series:format')
             imsdata = self.get('image_series:data')
             for ispec in imsdata: