adds new visit methods

Author: David Erb

src/dls_utilpack/visit.py

@@ -1,6 +1,8 @@
 import logging
 import os
+import re
 from datetime import datetime
+from pathlib import Path
 
 
 class VisitNotFound(Exception):
@@ -30,3 +32,37 @@ def get_visit_year(beamline, visit):
     logger.info(f"visit directory determined to be {visit_directory}")
 
     return year
+
+
+# ----------------------------------------------------------------------------------------
+def get_xchem_subdirectory(visit):
+
+    # This is the pattern all visits must have.
+    pattern = r"^([a-z][a-z][0-9][0-9][0-9][0-9][0-9])[-]([0-9]+)$"
+
+    match = re.search(pattern, visit)
+
+    if not match:
+        raise RuntimeError(
+            f'the visit name "{visit}" does not conform to the visit naming convention'
+        )
+
+    part1 = match.group(1)
+    part2 = match.group(2)
+
+    subdirectory = f"{part1}/{part1}-{part2}"
+
+    return subdirectory
+
+
+# ----------------------------------------------------------------------------------------
+def get_xchem_directory(parent, visit):
+
+    subdirectory = get_xchem_subdirectory(visit)
+
+    full_path = Path(parent) / subdirectory
+
+    if not full_path.is_dir():
+        raise RuntimeError(f"the visit directory {str(full_path)} does not exist")
+
+    return str(full_path)

tests/test_visit.py

@@ -0,0 +1,56 @@
+import logging
+from pathlib import Path
+
+import pytest
+
+from dls_utilpack.visit import get_xchem_directory, get_xchem_subdirectory
+
+# Base class for the tester.
+from tests.base_tester import BaseTester
+
+logger = logging.getLogger(__name__)
+
+
+# ----------------------------------------------------------------------------------------
+class TestVisit(BaseTester):
+    def test(self, constants, logging_setup, output_directory):
+        """ """
+
+        self.main(constants, output_directory)
+
+    # ----------------------------------------------------------------------------------------
+    async def _main_coroutine(
+        self,
+        constants,
+        output_directory,
+    ):
+        """ """
+
+        # Check valid visits.
+        assert get_xchem_subdirectory("aa12345-1") == "aa12345/aa12345-1"
+        assert get_xchem_subdirectory("aa12345-1234") == "aa12345/aa12345-1234"
+
+        # Check invalid visit formats.
+        with pytest.raises(RuntimeError) as excinfo:
+            get_xchem_subdirectory("aa12345")
+        assert "convention" in str(excinfo.value)
+
+        with pytest.raises(RuntimeError) as excinfo:
+            get_xchem_subdirectory("a12345-1")
+        assert "convention" in str(excinfo.value)
+
+        with pytest.raises(RuntimeError) as excinfo:
+            get_xchem_subdirectory("[aa12345-1]")
+        assert "convention" in str(excinfo.value)
+
+        # Check good directory.
+        parent = Path(output_directory) / "processing/lab36"
+        full_path = parent / "aa12345/aa12345-1"
+        full_path.mkdir(parents=True, exist_ok=True)
+
+        assert get_xchem_directory(str(parent), "aa12345-1") == str(full_path)
+
+        # Check invalid directory.
+        with pytest.raises(RuntimeError) as excinfo:
+            get_xchem_directory("something", "aa12345-1")
+        assert "does not exist" in str(excinfo.value)