leaf-framework 0.11.0__tar.gz → 0.11.1__tar.gz

{leaf_framework-0.11.0 → leaf_framework-0.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: leaf-framework
-Version: 0.11.0
+Version: 0.11.1
 Summary: Lightweight Adapter Framework (LEAF)
 License: Apache-2.0
 License-File: LICENSE

{leaf_framework-0.11.0 → leaf_framework-0.11.1}/leaf/adapters/control_spec.py

@@ -140,7 +140,9 @@ def _field_value(value: object) -> int | float | str:
     return json.dumps(value)
 
 
-def result_record(data: str, source: str, error: Exception | None = None) -> dict[str, object]:
+def result_record(
+    data: str, source: str, error: Exception | None = None, instance_tags: dict[str, str] | None = None
+) -> dict[str, object]:
     """
     A control message as the LeafPoint LEAF publishes on <control topic>/result, so that what was
     sent to the equipment is stored with the measurements.
@@ -159,6 +161,10 @@ def result_record(data: str, source: str, error: Exception | None = None) -> dic
     tags: dict[str, str] = {}
     for key, value in _part(point, "tags").items():
         tags[key] = str(value)
+    # The instance's organisation and department, where the message didn't set them
+    if instance_tags is not None:
+        for key, value in instance_tags.items():
+            _ = tags.setdefault(key, value)
     fields: dict[str, int | float | str] = {}
     for key, value in _part(point, "fields").items():
         fields[key] = _field_value(value)

{leaf_framework-0.11.0 → leaf_framework-0.11.1}/leaf/adapters/equipment_adapter.py

@@ -293,7 +293,8 @@ class EquipmentAdapter(ABC):
         """Publish what happened to a control message on <control topic>/result, so it is stored with the data."""
         # Never let the record break the command it describes
         try:
-            _ = self._output.transmit(f"{topic}/result", result_record(data, source, error))
+            record = result_record(data, source, error, self._metadata_manager.instance_tags())
+            _ = self._output.transmit(f"{topic}/result", record)
         except Exception as e:
             self._logger.warning(f"Could not publish the control record for {topic}: {e}")
 

{leaf_framework-0.11.0 → leaf_framework-0.11.1}/leaf/modules/input_modules/ble_watcher.py

@@ -21,7 +21,6 @@ logger = get_logger(__name__, log_file="input_module.log")
 FIRST_RECONNECT_DELAY = 1
 RECONNECT_RATE = 2
 MAX_RECONNECT_DELAY = 60
-MAX_RECONNECT_COUNT = 12
 
 
 class BLEEventWatcher(EventWatcher):

{leaf_framework-0.11.0 → leaf_framework-0.11.1}/leaf/modules/input_modules/mqtt_external_event_watcher.py

@@ -241,22 +241,3 @@ class MQTTExternalEventWatcher(ExternalEventWatcher):
             bool: True if the client is connected, False otherwise.
         """
         return self.client.is_connected()
-
-    def _handle_return_code(self, return_code: int) -> ClientUnreachableError | None:
-        """
-        Handle MQTT return codes.
-
-        Args:
-            return_code (int): The return code to handle.
-
-        Returns:
-            Optional[ClientUnreachableError]: An error if one occurred, None otherwise.
-        """
-        if return_code == mqtt.MQTT_ERR_SUCCESS:
-            return None
-        message = {
-            mqtt.MQTT_ERR_NO_CONN: "Can't connect to broker",
-            mqtt.MQTT_ERR_QUEUE_SIZE: "Message queue size limit reached",
-        }.get(return_code, f"Unknown error with return code {return_code}")
-
-        return ClientUnreachableError(message, output_module=self, severity=SeverityLevel.INFO)

{leaf_framework-0.11.0 → leaf_framework-0.11.1}/leaf/modules/phase_modules/measure.py

@@ -43,6 +43,7 @@ class MeasurePhase(PhaseModule):
 
         super().__init__(term_builder, metadata_manager=metadata_manager, error_holder=error_holder)
         self._maximum_message_size: int = maximum_message_size
+        self._tag_mismatches: set[tuple[str, str]] = set()
         # Guards against a second measurement running concurrently with one still
         # draining (e.g. a generator-based interpreter that streams for a long time,
         # or forever). Without this, an overlapping event (e.g. FileWatcher's
@@ -231,6 +232,7 @@ class MeasurePhase(PhaseModule):
             list[tuple]: A list of (action, result) tuples.
         """
         if isinstance(result, dict):
+            self._add_instance_tags(cast(object, result))
             measurement = self._resolve_measurement(result)
             action = self._term_builder(experiment_id=experiment_id, measurement=measurement)
             return [(action, result)]
@@ -239,6 +241,7 @@ class MeasurePhase(PhaseModule):
         point_json = point_json_of(payload)
         if point_json is not None:
             result = point_json
+            self._add_instance_tags(cast(object, result))
             measurement = self._resolve_measurement(result)
             action = self._term_builder(experiment_id=experiment_id, measurement=measurement)
             return [(action, result)]
@@ -254,6 +257,7 @@ class MeasurePhase(PhaseModule):
 
             groups: dict[str, list] = {}
             for item in converted:
+                self._add_instance_tags(cast(object, item))
                 if isinstance(item, dict):
                     key = self._resolve_measurement(item)
                 else:
@@ -270,6 +274,24 @@ class MeasurePhase(PhaseModule):
         self._handle_exception(excp)
         return []
 
+    def _add_instance_tags(self, item: object) -> None:
+        """Tag a point with its instance's organisation and department, unless the adapter already did."""
+        if self._metadata_manager is None or not isinstance(item, dict) or "fields" not in item:
+            return
+        tags = cast(dict[str, object], item).setdefault("tags", {})
+        if not isinstance(tags, dict):
+            return
+        for key, value in self._metadata_manager.instance_tags().items():
+            current = cast(dict[str, object], tags).get(key)
+            if current is None:
+                tags[key] = value
+            elif str(current) != value and (key, str(current)) not in self._tag_mismatches:
+                # Kept as the adapter set it; warned once so every measurement doesn't repeat it
+                self._tag_mismatches.add((key, str(current)))
+                logger.warning(
+                    f"Tag {key}={current!r} differs from the configured {key} {value!r}; keeping {current!r}"
+                )
+
     def _resolve_measurement(self, item: dict) -> str:
         """
         Resolve the measurement label used for the topic's last segment.

{leaf_framework-0.11.0 → leaf_framework-0.11.1}/leaf/register/metadata.py

@@ -1,6 +1,6 @@
 import json
 import os
-from typing import Any
+from typing import Any, cast
 
 import yaml  # type: ignore
 
@@ -60,6 +60,15 @@ class MetadataManager:
             return self._instance_data
         return self._instance_data.get(key)
 
+    def instance_tags(self) -> dict[str, str]:
+        """The organisation and department tags every point of this instance carries."""
+        tags: dict[str, str] = {}
+        for key in ("organisation", "department"):
+            value = cast(object, self._instance_data.get(key))  # pyright: ignore[reportUnknownMemberType]
+            if value:
+                tags[key] = str(value)
+        return tags
+
     def get_instance_id(self) -> str:
         """Convenience accessor for 'instance_id' in equipment."""
         return self._instance_data.get("instance_id", "")

{leaf_framework-0.11.0 → leaf_framework-0.11.1}/leaf/registry/discovery.py

@@ -16,8 +16,7 @@ from leaf.utility.logger.logger_utils import get_logger
 root_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "..")
 adapter_dir = os.path.join(root_dir, "adapters")
 core_adapter_dir = os.path.join(adapter_dir, "core_adapters")
-functional_adapter_dir = os.path.join(adapter_dir, "functional_adapters")
-default_equipment_locations = [core_adapter_dir, functional_adapter_dir]
+default_equipment_locations = [core_adapter_dir]
 
 output_module_dir = os.path.join(root_dir, "modules", "output_modules")
 input_module_dir = os.path.join(root_dir, "modules", "input_modules")

{leaf_framework-0.11.0 → leaf_framework-0.11.1}/leaf/registry/registry.py

@@ -56,13 +56,6 @@ def get_external_input(code: str) -> type[ExternalEventWatcher]:
     return cls
 
 
-def all_registered(plugin_type: PluginType) -> dict[str, type[Any]]:
-    """
-    Return all registered classes of a given plugin type.
-    """
-    return dict(_registry[plugin_type])
-
-
 def discover_from_config(config: dict[str, Any], external_path: str = None) -> None:
     """
     Discover and register only the plugins referenced in the given configuration.

{leaf_framework-0.11.0 → leaf_framework-0.11.1}/leaf/start.py

@@ -111,7 +111,7 @@ def parse_args(args: list[str] | None = None) -> argparse.Namespace:
         "--port",
         type=int,
         default=4242,
-        help="Port to run the NiceGUI interface on. Default is 8080.",
+        help="Port to run the NiceGUI interface on. Default is 4242.",
     )
 
     parser.add_argument(

{leaf_framework-0.11.0 → leaf_framework-0.11.1}/leaf/ui/constants.py

@@ -1,16 +1,11 @@
 """Constants for LEAF UI."""
 
 # Server constants
-DEFAULT_PORT = 8080
+DEFAULT_PORT = 4242
 MARKETPLACE_URL = "https://gitlab.com/leaf-framework/leaf-marketplace/-/raw/main/public/adapter.yaml"
 MAX_LOG_LINES = 1000
-CONFIGURATION_FILENAME = "configuration.yaml"
 
 # UI Constants
 CARD_WIDTH_CLASS = "w-64"
-HEADER_CLASSES = "leaf-header"
 CARD_CLASSES = "leaf-card"
 TAB_CLASSES = "leaf-tab"
-
-# Color constants
-STATUS_COLORS = {"online": "status-online", "offline": "status-offline", "warning": "status-warning"}

{leaf_framework-0.11.0 → leaf_framework-0.11.1}/leaf/ui/interface.py

@@ -38,12 +38,6 @@ def get_startup_error() -> str | None:
     return _startup_error
 
 
-def clear_startup_error() -> None:
-    """Clear the startup error."""
-    global _startup_error
-    _startup_error = None
-
-
 def start_nicegui(port: int = DEFAULT_PORT, config_path: Path | None = None, auto_open_browser: bool = True) -> None:
     """
     Start the LEAF NiceGUI web interface.

{leaf_framework-0.11.0 → leaf_framework-0.11.1}/leaf/ui/tabs/adapters.py

@@ -9,7 +9,7 @@ from nicegui import ui
 
 from leaf.registry.discovery import get_all_adapter_codes
 from leaf.ui.constants import CARD_CLASSES, CARD_WIDTH_CLASS, MARKETPLACE_URL
-from leaf.ui.utils import adapter_install_disabled, install_adapter, uninstall_adapter
+from leaf.ui.utils import adapter_install_disabled, check_repository_url, install_adapter, uninstall_adapter
 from leaf.utility.logger.logger_utils import get_logger
 
 logger = get_logger(__name__, log_file="input_module.log")
@@ -182,8 +182,8 @@ def _token_dialog(adapter: Mapping[str, object]) -> None:
     with ui.dialog() as dialog, ui.card().classes("w-96"):
         _ = ui.label(f"{name} is available on request").classes("text-h6")
         _ = ui.label("Enter the username and token you received, e.g. a GitLab deploy token.").classes("text-body")
-        username = ui.input("Username")
-        token = ui.input("Token", password=True, password_toggle_button=True)
+        username = ui.input("Username").classes("w-full")
+        token = ui.input("Token", password=True, password_toggle_button=True).classes("w-full")
         request = adapter.get("request_access")
         if request:
             _ = ui.link("Request access", str(request), new_tab=True)
@@ -198,6 +198,43 @@ def _token_dialog(adapter: Mapping[str, object]) -> None:
     _ = dialog.open()
 
 
+def _install_from_url_button() -> None:
+    """Installs an adapter that is not in the marketplace, unless adapter installs are disabled."""
+    if adapter_install_disabled():
+        return
+    _ = ui.button("Install from git URL", icon="link", on_click=_url_dialog).classes("btn-secondary mb-4")
+
+
+def _url_dialog() -> None:
+    """Asks for the git URL of an adapter, plus a username and token if its repository is private."""
+    with ui.dialog() as dialog, ui.card().classes("w-96"):
+        _ = ui.label("Install from a git URL").classes("text-h6")
+        _ = ui.label("Only install adapters from sources you trust: they run on this machine.").classes("text-body")
+        url = ui.input("Git URL", placeholder="https://gitlab.com/group/leaf-adapter.git").classes("w-full")
+        username = ui.input("Username (private repositories only)").classes("w-full")
+        token = ui.input("Token (private repositories only)", password=True, password_toggle_button=True).classes(
+            "w-full"
+        )
+
+        async def install() -> None:
+            repository = str(url.value).strip()
+            credentials = None
+            if username.value or token.value:
+                credentials = (str(username.value), str(token.value))
+            problem = check_repository_url(repository, credentials is not None)
+            if problem:
+                ui.notify(problem, type="negative", position="top")
+                return
+            _ = dialog.close()
+            name = repository.rstrip("/").rsplit("/", 1)[-1].removesuffix(".git")
+            await install_adapter({"name": name, "repo_url": repository}, credentials)
+
+        with ui.row().classes("w-full justify-end"):
+            _ = ui.button("Cancel", on_click=dialog.close).classes("btn-tertiary")
+            _ = ui.button("Install", icon="download", on_click=install).classes("btn-secondary")
+    _ = dialog.open()
+
+
 def _uninstall_button(adapter: Mapping[str, object]) -> None:
     """The installed adapter card's Uninstall button, unless adapter installs are disabled."""
     if adapter_install_disabled():
@@ -296,6 +333,7 @@ def build_adapters_content(container: ui.column) -> None:
             ui.icon("store", size="1.5rem").classes("text-icon")
             ui.label("Adapter Marketplace").classes("text-xl font-semibold text-subheading ml-2")
         _install_disabled_note()
+        _install_from_url_button()
 
         # Container for marketplace adapters
         marketplace_container = ui.column().classes("w-full")

{leaf_framework-0.11.0 → leaf_framework-0.11.1}/leaf/ui/utils.py

@@ -88,6 +88,18 @@ def with_credentials(repository: str, username: str, token: str) -> str:
     return urlunsplit(parts._replace(netloc=f"{quote(username, safe='')}:{quote(token, safe='')}@{host}"))
 
 
+def check_repository_url(url: str, with_token: bool) -> str | None:
+    """Why an adapter can't be installed from url (typed in the UI), or None when it can."""
+    parts = urlsplit(url)
+    if parts.scheme not in ("http", "https") or not parts.hostname:
+        return "Enter an http(s) URL, e.g. https://gitlab.com/group/leaf-adapter.git"
+    if parts.username or parts.password:
+        return "Put the username and token in their own fields, not in the URL"
+    if with_token and parts.scheme != "https":
+        return "A token is only sent over https"
+    return None
+
+
 async def install_adapter(adapter: dict[Any, Any], credentials: tuple[str, str] | None = None) -> None:
     """
     Install a LEAF adapter from a Git repository.

{leaf_framework-0.11.0 → leaf_framework-0.11.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "leaf-framework"
-version = "0.11.0"
+version = "0.11.1"
 description = "Lightweight Adapter Framework (LEAF)"
 authors = [
     "Matthew Crowther <nmc215@ncl.ac.uk>",

leaf_framework-0.11.0/leaf/measurement_handler/handler.py

@@ -1,11 +0,0 @@
-"""
-Unused for now.
-"""
-
-
-class MeasurementHandler:
-    def __init__(self):
-        pass
-
-    def add_measurement(self, term, value):
-        pass

leaf_framework-0.11.0/leaf/modules/input_modules/db_watcher.py

@@ -1,15 +0,0 @@
-from leaf.modules.input_modules.event_watcher import EventWatcher
-from leaf.register.metadata import MetadataManager
-from leaf.utility.logger.logger_utils import get_logger
-
-logger = get_logger(__name__, log_file="input_module.log")
-
-
-class DBWatcher(EventWatcher):
-    def __init__(self, metadata_manager: MetadataManager, callbacks=None, error_holder=None):
-        raise NotImplementedError()
-        term_map = {}
-        super().__init__(term_map, metadata_manager, callbacks=callbacks, error_holder=error_holder)
-
-    def start(self):
-        raise NotImplementedError()