[patch] Use ImportAlarm from pyiron_snippets

.ci_support/environment-docs.yml

@@ -16,6 +16,7 @@ dependencies:
 - pint =0.23
 - psutil =5.9.8
 - pyfileindex =0.0.24
+- pyiron_snippets =0.1.0
 - pympipool =0.8.3
 - pysqa =0.1.20
 - pytables =3.9.2

.ci_support/environment-old.yml

@@ -12,6 +12,7 @@ dependencies:
 - pint =0.18
 - psutil =5.8.0
 - pyfileindex =0.0.16
+- pyiron_snippets =0.1.0
 - pympipool =0.8.0
 - pysqa =0.1.12
 - pytables =3.6.1

.ci_support/environment.yml

@@ -16,6 +16,7 @@ dependencies:
 - pint =0.23
 - psutil =5.9.8
 - pyfileindex =0.0.24
+- pyiron_snippets =0.1.0
 - pympipool =0.8.3
 - pysqa =0.1.20
 - pytables =3.9.2

.github/workflows/unittests.yml

@@ -6,7 +6,6 @@ on:
   push:
     branches: [ main ]
   pull_request:
-    branches: [ main ]
 
 jobs:
   build:

pyiron_base/__init__.py

@@ -13,7 +13,6 @@
 from pyiron_base.storage.inputlist import InputList
 from pyiron_base.storage.parameters import GenericParameters
 from pyiron_base.utils.deprecate import Deprecator, deprecate, deprecate_soon
-from pyiron_base.utils.error import ImportAlarm
 from pyiron_base.jobs.job.extension.executable import Executable
 from pyiron_base.project.external import Notebook, load, dump
 from pyiron_base.jobs.dynamic import warn_dynamic_job_classes
@@ -46,6 +45,9 @@
 
 from pyiron_base.jobs.job.toolkit import Toolkit, BaseTools
 
+# Expose snippets references in base API for backwards compatibility
+from pyiron_snippets.import_alarm import ImportAlarm
+
 # Internal init
 from ._version import get_versions
 from pyiron_base.utils.jedi import fix_ipython_autocomplete

pyiron_base/database/manager.py

@@ -7,7 +7,7 @@
 
 from urllib.parse import quote_plus
 from pyiron_base.state.logger import logger
-from pyiron_base.interfaces.singleton import Singleton
+from pyiron_snippets.singleton import Singleton
 from pyiron_base.state.settings import settings as s
 import os
 

pyiron_base/jobs/job/jobtype.py

@@ -10,7 +10,7 @@
 import os
 from pyiron_base.jobs.job.util import _get_safe_job_name
 from pyiron_base.storage.hdfio import ProjectHDFio
-from pyiron_base.interfaces.singleton import Singleton
+from pyiron_snippets.singleton import Singleton
 from pyiron_base.interfaces.factory import PyironFactory
 from pyiron_base.jobs.job.extension.jobstatus import job_status_finished_lst
 from typing import Union

pyiron_base/state/__init__.py

@@ -19,7 +19,7 @@
 from pyiron_base.state.publications import publications as _publications
 from pyiron_base.state.queue_adapter import queue_adapters as _queue_adapters
 from pyiron_base.state.settings import settings as _settings
-from pyiron_base.interfaces.singleton import Singleton
+from pyiron_snippets.singleton import Singleton
 from typing import Dict, Union
 
 __author__ = "Liam Huber"

pyiron_base/state/publications.py

@@ -10,7 +10,7 @@
 """
 
 import pandas
-from pyiron_base.interfaces.singleton import Singleton
+from pyiron_snippets.singleton import Singleton
 from typing import Dict, Union, List
 from typing_extensions import Literal
 

pyiron_base/state/queue_adapter.py

@@ -8,7 +8,7 @@
 multiple adapters.
 """
 
-from pyiron_base.interfaces.singleton import Singleton
+from pyiron_snippets.singleton import Singleton
 from pysqa import QueueAdapter as PySQAAdpter
 import os
 from pyiron_base.state.settings import settings

pyiron_base/state/settings.py

@@ -40,7 +40,7 @@
 from pyiron_base.state.publications import publications
 from pyiron_base.utils.strtobool import strtobool
 from pathlib import Path
-from pyiron_base.interfaces.singleton import Singleton
+from pyiron_snippets.singleton import Singleton
 from typing import Union, Dict, List
 from copy import deepcopy
 

pyiron_base/storage/filedata.py

@@ -11,7 +11,7 @@
 import pandas
 
 from pyiron_base.storage.hdfio import FileHDFio, ProjectHDFio
-from pyiron_base.utils.error import ImportAlarm
+from pyiron_snippets.import_alarm import ImportAlarm
 
 __author__ = "Niklas Siemer"
 __copyright__ = (

pyiron_base/utils/error.py

@@ -7,11 +7,9 @@
 In order to be accessible from anywhere in pyiron, they *must* remain free of any imports from pyiron!
 """
 
-import functools
 from itertools import count
 import time
 from typing import Callable, TypeVar, Type, Tuple, Optional, Union
-import warnings
 
 from pyiron_base.state.logger import logger
 
@@ -27,84 +25,6 @@
 __date__ = "Sep 1, 2017"
 
 
-class ImportAlarm:
-    """
-    In many places we have try/except loops around imports. This class is meant to accompany that code so that users
-    get an early warning when they instantiate a job that won't work when run.
-
-    Example:
-
-    >>> try:
-    ...     from mystery_package import Enigma, Puzzle, Conundrum
-    ...     import_alarm = ImportAlarm()
-    >>> except ImportError:
-    >>>     import_alarm = ImportAlarm(
-    ...         "MysteryJob relies on mystery_package, but this was unavailable. Please ensure your python environment "
-    ...         "has access to mystery_package, e.g. with `conda install -c conda-forge mystery_package`"
-    ...     )
-    ...
-    >>> class MysteryJob(GenericJob):
-    ...     @import_alarm
-    ...     def __init__(self, project, job_name)
-    ...         super().__init__()
-    ...         self.riddles = [Enigma(), Puzzle(), Conundrum()]
-
-    This class is also a context manager that can be used as a short-cut, like this:
-
-    >>> with ImportAlarm("MysteryJob relies on mystery_package, but this was unavailable.") as import_alarm:
-    ...     import mystery_package
-
-    If you do not use `import_alarm` as a decorator, but only to get a consistent warning message, call
-    :meth:`.warn_if_failed()` after the with statement.
-
-    >>> import_alarm.warn_if_failed()
-    """
-
-    def __init__(self, message=None):
-        """
-        Initialize message value.
-
-        Args:
-            message (str): What to say alongside your ImportError when the decorated function is called. (Default is
-                None, which says nothing and raises no error.)
-        """
-        self.message = message
-
-    def __call__(self, func):
-        return self.wrapper(func)
-
-    def wrapper(self, function):
-        @functools.wraps(function)
-        def decorator(*args, **kwargs):
-            self.warn_if_failed()
-            return function(*args, **kwargs)
-
-        return decorator
-
-    def warn_if_failed(self):
-        """
-        Print warning message if import has failed.  In case you are not using `ImportAlarm` as a decorator you can call
-        this method manually to trigger the warning.
-        """
-        if self.message is not None:
-            warnings.warn(self.message, category=ImportWarning)
-
-    def __enter__(self):
-        return self
-
-    def __exit__(self, exc_type, exc_value, traceback):
-        if exc_type is None and exc_value is None and traceback is None:
-            # import successful, so silence our warning
-            self.message = None
-            return
-        if issubclass(exc_type, ImportError):
-            # import broken; retain message, but suppress error
-            return True
-        else:
-            # unrelated error during import, re-raise
-            return False
-
-
 T = TypeVar("T")
 
 

pyproject.toml

@@ -35,6 +35,7 @@ dependencies = [
     "pint==0.23",
     "psutil==5.9.8",
     "pyfileindex==0.0.24",
+    "pyiron_snippets==0.1.0",
     "pympipool==0.8.3",
     "pysqa==0.1.20",
     "sqlalchemy==2.0.30",

tests/generic/test_util.py

@@ -6,7 +6,6 @@
 import warnings
 from pyiron_base.utils.instance import static_isinstance
 from pyiron_base.utils.deprecate import deprecate, deprecate_soon
-from pyiron_base.utils.error import ImportAlarm
 from pyiron_base._tests import PyironTestCase
 
 
@@ -145,71 +144,5 @@ def food(bar=None, baz=None):
         self.assertEqual(len(w), 2, "Not all warnings preserved.")
 
 
-class TestImportAlarm(PyironTestCase):
-    def setUp(self):
-        super().setUp()
-        self.import_alarm = ImportAlarm()
-
-        @self.import_alarm
-        def add_one(x):
-            return x + 1
-
-        with ImportAlarm("Broken import") as alarm_broken:
-            import ASDF
-
-        @alarm_broken
-        def add_two(x):
-            return x + 2
-
-        with ImportAlarm("Working import") as alarm_working:
-            import sys
-
-        @alarm_working
-        def add_three(x):
-            return x + 3
-
-        self.add_one = add_one
-        self.add_two = add_two
-        self.add_three = add_three
-
-    def test_no_warning(self):
-        with warnings.catch_warnings(record=True) as w:
-            self.add_one(0)
-        self.assertEqual(
-            len(w), 0, "Expected no warnings, but got {} warnings.".format(len(w))
-        )
-
-    def test_has_warning(self):
-        self.import_alarm.message = "Now add_one should throw an ImportWarning"
-
-        with warnings.catch_warnings(record=True) as w:
-            self.add_one(1)
-        self.assertEqual(
-            len(w), 1, "Expected one warning, but got {} warnings.".format(len(w))
-        )
-
-    def test_context(self):
-        """
-        Usage via context manager should give same results and not suppress other errors.
-        """
-
-        with warnings.catch_warnings(record=True) as w:
-            self.add_two(0)
-        self.assertEqual(
-            len(w), 1, "Expected one warning, but got {} warnings.".format(len(w))
-        )
-
-        with warnings.catch_warnings(record=True) as w:
-            self.add_three(0)
-        self.assertEqual(
-            len(w), 0, "Expected one warning, but got {} warnings.".format(len(w))
-        )
-
-        with self.assertRaises(
-            ZeroDivisionError, msg="Context manager should swallow unrelated exceptions"
-        ), ImportAlarm("Unrelated"):
-            print(1 / 0)
-
-
 if __name__ == "__main__":
     unittest.main()