Merge pull request #239 from European-XFEL/api-deps

Fix API dependencies

Author: JamesWrigley

damnit/__init__.py

@@ -1,5 +1,5 @@
 """Prototype for extracting and showing metadata (AMORE project)"""
 
-__version__ = '0.1'
+__version__ = '0.1.1'
 
 from .api import Damnit, RunVariables, VariableData

damnit/backend/supervisord.py

@@ -8,13 +8,27 @@
 import configparser
 from pathlib import Path
 
-from ..util import wait_until
 from .db import db_path, DamnitDB
 
 
 log = logging.getLogger(__name__)
 
 
+def wait_until(condition, timeout=1):
+    """
+    Re-evaluate `condition()` until it either returns true or we've waited
+    longer than `timeout`.
+    """
+    slept_for = 0
+    sleep_interval = 0.2
+
+    while slept_for < timeout and not condition():
+        time.sleep(sleep_interval)
+        slept_for += sleep_interval
+
+    if slept_for >= timeout:
+        raise TimeoutError("Condition timed out")
+
 def get_supervisord_address(default_port=2322):
     """
     Find an available hostname and port for supervisord to bind to.

damnit/util.py

@@ -14,22 +14,6 @@ class StatusbarStylesheet(Enum):
     ERROR = "QStatusBar {background: red; color: white; font-weight: bold;}"
 
 
-def wait_until(condition, timeout=1):
-    """
-    Re-evaluate `condition()` until it either returns true or we've waited
-    longer than `timeout`.
-    """
-    slept_for = 0
-    sleep_interval = 0.2
-
-    while slept_for < timeout and not condition():
-        time.sleep(sleep_interval)
-        slept_for += sleep_interval
-
-    if slept_for >= timeout:
-        raise TimeoutError("Condition timed out")
-
-
 def timestamp2str(timestamp):
     if timestamp is None or pd.isna(timestamp):
         return None

tests/test_api.py

@@ -1,3 +1,5 @@
+import subprocess
+from pathlib import Path
 from textwrap import dedent
 
 import pytest
@@ -109,3 +111,11 @@ def dataset(run):
 
     # Datasets have a internal _damnit attribute that should be removed
     assert len(dataset.attrs) == 0
+
+def test_api_dependencies(virtualenv):
+    package_path = Path(__file__).parent.parent
+    virtualenv.install_package(package_path, installer="pip install")
+
+    # Test that we can import the module successfully and don't accidentally
+    # depend on other things.
+    subprocess.run([str(virtualenv.python), "-c", "import damnit"]).check_returncode()

tests/test_backend.py

@@ -16,7 +16,7 @@
 import xarray as xr
 import extra_data as ed
 
-from damnit.util import wait_until
+from damnit.backend.supervisord import wait_until
 from damnit.context import (
     ContextFileErrors, ContextFile, PNGData, Results, RunData, get_proposal_path
 )