Move HidraProjectFileMode into separate file refs #219

pyrs/core/powder_pattern.py

@@ -1,8 +1,9 @@
 from pyrs.core import reduction_manager
 from pyrs.utilities import checkdatatypes
 from pyrs.core import mask_util
+from pyrs.projectfile import HidraProjectFileMode
 from pyrs.utilities import calibration_file_io
-from pyrs.utilities.rs_project_file import HidraProjectFile, HidraProjectFileMode
+from pyrs.utilities.rs_project_file import HidraProjectFile
 from matplotlib import pyplot as plt
 
 

pyrs/core/pyrscore.py

@@ -3,8 +3,8 @@
 from pyrs.core import instrument_geometry
 from pyrs.utilities import file_util
 from pyrs.peaks import PeakFitEngineFactory, SupportedPeakProfiles, SupportedBackgroundTypes
-from pyrs.projectfile import HidraConstants
-from pyrs.utilities.rs_project_file import HidraProjectFile, HidraProjectFileMode
+from pyrs.projectfile import HidraConstants, HidraProjectFileMode
+from pyrs.utilities.rs_project_file import HidraProjectFile
 from pyrs.core import strain_stress_calculator
 from pyrs.core import reduction_manager
 from pyrs.core import polefigurecalculator

pyrs/core/reduction_manager.py

@@ -7,10 +7,10 @@
 from pyrs.core import mask_util
 from pyrs.core import reduce_hb2b_mtd
 from pyrs.core import reduce_hb2b_pyrs
-from pyrs.projectfile import HidraConstants
+from pyrs.projectfile import HidraConstants, HidraProjectFileMode
 from pyrs.utilities import calibration_file_io
 from pyrs.utilities import checkdatatypes
-from pyrs.utilities.rs_project_file import HidraProjectFile, HidraProjectFileMode
+from pyrs.utilities.rs_project_file import HidraProjectFile
 
 
 class HB2BReductionManager(object):

pyrs/projectfile/__init__.py

@@ -1,4 +1,6 @@
 # flake8: noqa
+# pylint: disable=undefined-variable
 from .constants import HidraConstants
+from .file_mode import HidraProjectFileMode
 
-__all__ = ['HidraConstants']
+__all__ = constants.__all__ + file_mode.__all__

pyrs/projectfile/constants.py

@@ -1,3 +1,6 @@
+__all__ = ['HidraConstants']
+
+
 class HidraConstants(object):
     """
     Constants used for Hidra project file, workspace and related dictionary

pyrs/projectfile/file_mode.py

@@ -0,0 +1,37 @@
+# This is rs_scan_io.DiffractionFile's 2.0 version
+from enum import Enum
+
+__all__ = ['HidraProjectFileMode']
+
+
+class HidraProjectFileMode(Enum):
+    '''
+    Enumeration for file access mode
+
+    These values match the strings of :py:obj:`h5py.File`
+    '''
+    READONLY = 'r'   # read-only
+    READWRITE = 'a'  # read and write
+    OVERWRITE = 'w'  # new file
+
+    def __str__(self):
+        return self.value
+
+    @staticmethod
+    def getMode(mode):
+        '''Private function to convert anything into :py:obj:`HidraProjectFileMode`'''
+        if mode in HidraProjectFileMode:
+            return mode  # already a member of the enum
+        else:
+            # all other checks are for strings
+            # the first checks are against nominal values
+            # the last check is against the enum names
+            mode = str(mode).lower()
+            if mode in ['a', 'rw']:
+                return HidraProjectFileMode.READWRITE
+            elif mode == 'r':
+                return HidraProjectFileMode.READONLY
+            elif mode == 'w':
+                return HidraProjectFileMode.OVERWRITE
+            else:
+                return HidraProjectFileMode[mode.upper()]

pyrs/utilities/rs_project_file.py

@@ -8,31 +8,9 @@
 from pyrs.core.instrument_geometry import AnglerCameraDetectorGeometry, HidraSetup
 from pyrs.peaks import PeakCollection
 from pyrs.dataobjects import SampleLogs
-from pyrs.projectfile import HidraConstants
+from pyrs.projectfile import HidraConstants, HidraProjectFileMode
 
-__all__ = ['HidraProjectFileMode', 'DiffractionUnit', 'HidraProjectFile']
-
-
-class HidraProjectFileMode(Enum):
-    '''
-    Enumeration for file access mode
-
-    These values match the strings of :py:obj:`h5py.File`
-    '''
-    READONLY = 'r'   # read-only
-    READWRITE = 'a'  # read and write
-    OVERWRITE = 'w'  # new file
-
-    def __str__(self):
-        return self.value
-
-    @staticmethod
-    def getMode(mode):
-        '''Private function to convert anything into :py:obj:`HidraProjectFileMode`'''
-        if mode in HidraProjectFileMode:
-            return mode
-        else:
-            return HidraProjectFileMode[str(mode)]
+__all__ = ['DiffractionUnit', 'HidraProjectFile']
 
 
 class DiffractionUnit(Enum):

scripts/preparetest/convert_hb2b_peaks.py

@@ -9,7 +9,7 @@
 """
 import numpy
 from pyrs.utilities import rs_scan_io
-from pyrs.utilities.rs_project_file import HidraProjectFile, HidraProjectFileMode
+from pyrs.utilities.rs_project_file import HidraProjectFile
 
 
 def main():
@@ -24,7 +24,7 @@ def main():
 
     # Create a Hidra project
     target_project_file_name = 'tests/testdata/Hydra_16-1_cor_log.h5'
-    target_file = HidraProjectFile(target_project_file_name, HidraProjectFileMode.OVERWRITE)
+    target_file = HidraProjectFile(target_project_file_name, 'w')
 
     # Create sub runs
     target_file.write_sub_runs(sorted(diff_data_dict.keys()))

scripts/preparetest/convert_strain_stress_data.py

@@ -2,7 +2,8 @@
 # System (library) test for classes and methods that will be used to calculate strain and stress
 import os
 import sys
-from pyrs.utilities.rs_project_file import HidraProjectFile, HidraProjectFileMode
+from pyrs.projectfile import HidraProjectFileMode
+from pyrs.utilities.rs_project_file import HidraProjectFile
 
 
 def contain_strain_stress_main():

scripts/pyrs_calibration.py

@@ -1,7 +1,8 @@
 import numpy
 import time
+from pyrs.projectfile import HidraProjectFileMode
 from pyrs.utilities import calibration_file_io
-from pyrs.utilities.rs_project_file import HidraProjectFile, HidraProjectFileMode
+from pyrs.utilities.rs_project_file import HidraProjectFile
 from pyrs.calibration import peakfit_calibration
 
 # DEFAULT VALUES FOR DATA PROCESSING

tests/data/convert_xray_data.py

@@ -7,10 +7,9 @@
 
 Note: most of the methods to parse HZB data are copied from script pyrscalibration.py
 """
-from pyrs.projectfile import HidraConstants
-from pyrs.utilities.rs_project_file import HidraProjectFile, HidraProjectFileMode
+from pyrs.projectfile import HidraConstants, HidraProjectFileMode
+from pyrs.utilities.rs_project_file import HidraProjectFile
 from pyrs.core.instrument_geometry import HidraSetup
-import numpy
 from skimage import io
 from PIL import Image
 import numpy as np
@@ -96,8 +95,8 @@ def main():
 
     # add sample log data & sub runs
     # for log_name in ['sub-run', '2Theta']
-    project_file.append_experiment_log(HidraConstants.SUB_RUNS, numpy.array([1]))
-    project_file.append_experiment_log(HidraConstants.TWO_THETA, numpy.array([35.]))
+    project_file.append_experiment_log(HidraConstants.SUB_RUNS, np.array([1]))
+    project_file.append_experiment_log(HidraConstants.TWO_THETA, np.array([35.]))
 
     # add instrument information
     instrument_setup = generate_xray_instrument()

tests/integration/test_calibration_class.py

@@ -5,8 +5,9 @@
 import time
 import os
 import json
+from pyrs.projectfile import HidraProjectFileMode
 from pyrs.utilities import calibration_file_io
-from pyrs.utilities.rs_project_file import HidraProjectFile, HidraProjectFileMode
+from pyrs.utilities.rs_project_file import HidraProjectFile
 try:
     from pyrs.calibration import peakfit_calibration
 except ImportError as e:

tests/integration/test_project_file_rw.py

@@ -1,5 +1,5 @@
 from pyrs.core import workspaces
-from pyrs.utilities.rs_project_file import HidraProjectFile, HidraProjectFileMode
+from pyrs.utilities.rs_project_file import HidraProjectFile
 from pyrs.core.instrument_geometry import HidraSetup
 import os
 import pytest
@@ -15,15 +15,15 @@ def test_rw_raw():
     raw_project_name = os.path.join(os.getcwd(), 'data/HZB_Raw_Project.h5')
 
     # Read to workspace
-    source_project = HidraProjectFile(raw_project_name, HidraProjectFileMode.READONLY)
+    source_project = HidraProjectFile(raw_project_name, 'r')
 
     # To the workspace
     source_workspace = workspaces.HidraWorkspace('Source HZB')
     source_workspace.load_hidra_project(source_project, load_raw_counts=True,
                                         load_reduced_diffraction=False)
 
     # Export
-    target_project = HidraProjectFile('HZB_HiDra_Test.h5', HidraProjectFileMode.OVERWRITE)
+    target_project = HidraProjectFile('HZB_HiDra_Test.h5', 'w')
     # Experiment data
     source_workspace.save_experimental_data(target_project, sub_runs=range(1, 41))
 

tests/integration/test_reduction.py

@@ -1,4 +1,4 @@
-from pyrs.utilities.rs_project_file import HidraProjectFile, HidraProjectFileMode
+from pyrs.utilities.rs_project_file import HidraProjectFile
 from pyrs.utilities import calibration_file_io
 from pyrs.core import workspaces
 import pytest
@@ -27,7 +27,7 @@ def test_calibration_json():
     assert status == 3
 
     # Import project file
-    project_file = HidraProjectFile(project_file_name, HidraProjectFileMode.READONLY)
+    project_file = HidraProjectFile(project_file_name, 'r')
 
     # Reduce
     test_workspace = workspaces.HidraWorkspace('test calibration')

tests/unit/test_hidra_project_file.py

@@ -1,8 +1,8 @@
 """
 Test for reading and writing components to HiDRA project file
 """
-from pyrs.projectfile import HidraConstants
-from pyrs.utilities.rs_project_file import HidraProjectFile, HidraProjectFileMode
+from pyrs.projectfile import HidraConstants, HidraProjectFileMode
+from pyrs.utilities.rs_project_file import HidraProjectFile
 import os
 import numpy as np
 import datetime