Make setting the inst_pkgs path more convenient (#627)

Author: teutoburg

scopesim/__init__.py

@@ -61,7 +61,7 @@
 
 # import specific classes from the modules to included in the global namespace
 
-from .utils import bug_report
+from .utils import bug_report, set_inst_pkgs_path, link_irdb
 from .optics.optical_train import OpticalTrain
 from .commands.user_commands import UserCommands
 from .commands.scopesimple import Simulation

scopesim/commands/user_commands.py

@@ -497,7 +497,10 @@ def patch_fake_symlinks(path: Path):
     # The path does not exist.
     parent = path.parent
     pathup = patch_fake_symlinks(parent)
-    assert pathup != parent, ValueError("Cannot find path")
+
+    if pathup == parent:
+        raise FileNotFoundError(f"Cannot find path '{path.name}'")
+
     return patch_fake_symlinks(pathup / path.name)
 
 
@@ -515,13 +518,21 @@ def add_packages_to_rc_search(local_path, package_list):
         A list of the package names to add
 
     """
-    plocal_path = patch_fake_symlinks(Path(local_path))
+    try:
+        plocal_path = patch_fake_symlinks(Path(local_path))
+    except FileNotFoundError:
+        # retry with mocks
+        plocal_path = patch_fake_symlinks(Path("./scopesim/tests/mocks"))
+
     for pkg in package_list:
         pkg_dir = plocal_path / pkg
         if not pkg_dir.exists():
-            # todo: keep here, but add test for this by downloading test_package
-            # raise ValueError("Package could not be found: {}".format(pkg_dir))
-            logger.warning("Package could not be found: %s", pkg_dir)
+            # For sub-packages (e.g. ELT, Armazones) it might be ok to not find
+            # them, but if we're at the top level, this should not go silent.
+            if len(package_list) == 1:
+                raise ValueError(f"Package could not be found: {pkg_dir}")
+            else:
+                logger.warning("Package could not be found: %s", pkg_dir)
 
         rc.__search_path__.append_first(pkg_dir)
 

scopesim/tests/test_utils_functions.py

@@ -255,7 +255,6 @@ def test_seq_includes_last_when_it_should_not(self, start, stop, step):
         assert arr[-1] != stop
         assert stop not in arr
 
-
     @pytest.mark.parametrize("start,stop,step",
                              [(0, 10, 1),
                               (10, 0, -1),
@@ -264,3 +263,9 @@ def test_seq_includes_last_when_it_should_not(self, start, stop, step):
     def test_seq_has_correct_step_size(self, start, stop, step):
         arr = utils.seq(start, stop, step)
         assert arr[1:] - arr[:-1] == approx(step)
+
+
+@pytest.mark.usefixtures("protect_currsys")
+def test_setting_instpkgspath():
+    utils.link_irdb("bogus")
+    assert rc.__config__["!SIM.file.local_packages_path"] == "bogus"

scopesim/tests/tests_commands/test_UserCommands.py

@@ -113,6 +113,16 @@ def test_see_if_theres_an_entry_on_the_server_log_file(self):
         _ = UserCommands(use_instrument="test_package")
 
 
+@pytest.mark.usefixtures("protect_currsys")
+class TestIffyPkgPaths:
+    def test_finds_basic_instrument(self):
+        UserCommands(use_instrument="basic_instrument")
+
+    def test_throws_for_bogus_inst(self):
+        with pytest.raises(ValueError):
+            UserCommands(use_instrument="bogus_instrument")
+
+
 def test_patch_fake_symlinks(tmp_path):
     """Setup a temporary directory with files and links."""
     # tmp_path is a fixture

scopesim/utils.py

@@ -273,7 +273,7 @@ def find_file(filename, path=None, silent=False):
 
     # TODO: Not sure what to do here
     if from_currsys("!SIM.file.error_on_missing_file"):
-       raise ValueError(msg)
+        raise ValueError(msg)
 
     return None
 
@@ -699,14 +699,20 @@ def wrapper(*args, **kwargs):
 
 
 def update_logging(capture_warnings=True):
-    """Reload logging configuration from ``rc.__logging_config__``."""
+    """Reload logging configuration from ``rc.__logging_config__``.
+
+    .. versionadded:: 0.8.0
+    """
     # Need to access NestedMapping's internal dict here...
     dictConfig(rc.__logging_config__)
     logging.captureWarnings(capture_warnings)
 
 
 def log_to_file(enable=True):
-    """Enable or disable logging to file (convenience function)."""
+    """Enable or disable logging to file (convenience function).
+
+    .. versionadded:: 0.8.0
+    """
     if enable:
         handlers = ["console", "file"]
     else:
@@ -721,11 +727,30 @@ def set_console_log_level(level="INFO"):
 
     This controls what is actually printed to the console by ScopeSim.
     Accepted values are: DEBUG, INFO (default), WARNING, ERROR and CRITICAL.
+
+    .. versionadded:: 0.8.0
     """
     rc.__logging_config__["handlers"]["console"]["level"] = level
     update_logging()
 
 
+def set_inst_pkgs_path(pkg_path: Path | str) -> None:
+    """Set the local path for !SIM.file.local_packages_path (shortcut).
+
+    .. versionadded:: PLACEHOLDER_NEXT_RELEASE_VERSION
+    """
+    rc.__config__["!SIM.file.local_packages_path"] = str(pkg_path)
+
+
+def link_irdb(irdb_path: Path | str | None = None) -> None:
+    """Set ``inst_pkgs`` to local clone of IRDB (convenience shortcut).
+
+    .. versionadded:: PLACEHOLDER_NEXT_RELEASE_VERSION
+    """
+    irdb_path = irdb_path or rc.__pkg_dir__.parent.parent / "irdb"
+    set_inst_pkgs_path(irdb_path)
+
+
 def seq(start, stop, step=1):
     """Replacement for numpy.arange modelled after R's seq function.