Merge pull request #84 from dls-controls/notifier

Notifier and Serializable refactor

malcolm/controllers/clientcontroller.py

@@ -45,7 +45,7 @@ def _regenerate_block(self, d):
         for k, v in d.items():
             if k == "typeid":
                 continue
-            child = Serializable.from_dict(k, v)
+            child = Serializable.deserialize(k, v)
             children.append(child)
             if isinstance(child, Method):
                 # calling method forwards to server

malcolm/core/__init__.py

@@ -1,4 +1,4 @@
-# Need to import these so that the register hooks are called
+# Need to import these so that the register_subclass hooks are called
 from malcolm.core.stringmeta import StringMeta  # noqa
 from malcolm.core.stringarraymeta import StringArrayMeta # noqa
 from malcolm.core.numbermeta import NumberMeta  # noqa

malcolm/core/attribute.py

@@ -1,10 +1,11 @@
 from collections import OrderedDict
 
+from malcolm.core.notifier import Notifier
 from malcolm.core.serializable import Serializable
 
 
-@Serializable.register("epics:nt/NTAttribute:1.0")
-class Attribute(Serializable):
+@Serializable.register_subclass("epics:nt/NTAttribute:1.0")
+class Attribute(Notifier):
     """Represents a value with type information that may be backed elsewhere"""
 
     def __init__(self, name, meta):
@@ -44,7 +45,7 @@ def from_dict(cls, name, d):
             name (str): Attribute instance name
             d (dict): Output of self.to_dict()
         """
-        meta = Serializable.from_dict("meta", d["meta"])
+        meta = Serializable.deserialize("meta", d["meta"])
         attribute = cls(name, meta)
         attribute.value = d["value"]
         return attribute

malcolm/core/block.py

@@ -1,5 +1,6 @@
 from collections import OrderedDict
 
+from malcolm.core.notifier import Notifier
 from malcolm.core.serializable import Serializable
 from malcolm.core.request import Request
 from malcolm.core.response import Response
@@ -32,8 +33,8 @@ def __exit__(self, type, value, traceback):
         self.lock.acquire()
         return False
 
-@Serializable.register("malcolm:core/Block:1.0")
-class Block(Serializable):
+@Serializable.register_subclass("malcolm:core/Block:1.0")
+class Block(Notifier):
     """Object consisting of a number of Attributes and Methods"""
 
     def __init__(self, name):
@@ -94,7 +95,7 @@ def update(self, change):
             # sub-structure does not exist - create and add
             if len(change[0]) > 1:
                 raise ValueError("Missing substructure at %s" % name)
-            child = Serializable.from_dict(name, change[1])
+            child = Serializable.deserialize(name, change[1])
             d = self._where_child_stored(child)
             assert d is not None, \
                 "Change %s deserialized to unknown object %s" % (change, child)

malcolm/core/blockmeta.py

@@ -1,6 +1,6 @@
 from malcolm.core.meta import Meta
 from malcolm.core.serializable import Serializable
 
-@Serializable.register("malcolm:core/BlockMeta:1.0")
+@Serializable.register_subclass("malcolm:core/BlockMeta:1.0")
 class BlockMeta(Meta):
     pass

malcolm/core/booleanarraymeta.py

@@ -2,7 +2,7 @@
 from malcolm.core.serializable import Serializable
 
 
-@Serializable.register("malcolm:core/BooleanArrayMeta:1.0")
+@Serializable.register_subclass("malcolm:core/BooleanArrayMeta:1.0")
 class BooleanArrayMeta(ScalarMeta):
     """Meta object containing information for a boolean array"""
 

malcolm/core/booleanmeta.py

@@ -2,7 +2,7 @@
 from malcolm.core.serializable import Serializable
 
 
-@Serializable.register("malcolm:core/BooleanMeta:1.0")
+@Serializable.register_subclass("malcolm:core/BooleanMeta:1.0")
 class BooleanMeta(ScalarMeta):
     """Meta object containing information for a boolean"""
 

malcolm/core/choicearraymeta.py

@@ -4,7 +4,7 @@
 from malcolm.core.serializable import Serializable
 
 
-@Serializable.register("malcolm:core/ChoiceArrayMeta:1.0")
+@Serializable.register_subclass("malcolm:core/ChoiceArrayMeta:1.0")
 class ChoiceArrayMeta(ScalarMeta):
     """Meta object containing information for a choice array"""
 

malcolm/core/choicemeta.py

@@ -4,7 +4,7 @@
 from malcolm.core.serializable import Serializable
 
 
-@Serializable.register("malcolm:core/ChoiceMeta:1.0")
+@Serializable.register_subclass("malcolm:core/ChoiceMeta:1.0")
 class ChoiceMeta(ScalarMeta):
     """Meta object containing information for a enum"""
 

malcolm/core/clientcomms.py

@@ -11,7 +11,7 @@ class ClientComms(Loggable, Spawnable):
     SERVER_BLOCKS_ID=0
 
     def __init__(self, name, process):
-        super(ClientComms, self).__init__(logger_name=name)
+        self.set_logger_name(name)
         self.process = process
         self.q = self.process.create_queue()
         self._current_id = 1

malcolm/core/controller.py

@@ -19,8 +19,7 @@ def __init__(self, process, block):
             process (Process): The process this should run under
             block (Block): Block instance to add Methods and Attributes to
         """
-        logger_name = "%s.controller" % block.name
-        super(Controller, self).__init__(logger_name)
+        self.set_logger_name("%s.controller" % block.name)
 
         self.writeable_methods = OrderedDict()
         self.process = process

malcolm/core/loggable.py

@@ -4,43 +4,39 @@
 class Loggable(object):
     """Utility class that provides a named logger for a class instance"""
 
-    def __init__(self, logger_name):
-        """
-        Args:
-            logger_name (str): Name of the logger to appear in log messages
-        """
-        super(Loggable, self).__init__()
-        # The name that we will pass to the logger
-        self._logger_name = None
-        # The logger object itself
-        self._logger = None
-        self.set_logger_name(logger_name)
+    # The actual logging logger that produces our log messages
+    _logger = None
+
+    def _call_log_method(self, function, msg, *arg, **kwargs):
+        if self._logger is None:
+            raise ValueError("Attempt to log to a Loggable without first calling set_logger_name()")
+        log_method = getattr(self._logger, function)
+        log_method(msg, *arg, **kwargs)
 
     def set_logger_name(self, logger_name):
         """Change the name of the logger that log_* should call
 
         Args:
             logger_name (str): Name of the logger to appear in log messages
         """
-        self._logger_name = logger_name
-        self._logger = logging.getLogger(self._logger_name)
+        self._logger = logging.getLogger(logger_name)
 
     def log_debug(self, msg, *args, **kwargs):
         """Call :meth:`logging.Logger.debug`"""
-        self._logger.debug(msg, *args, **kwargs)
+        self._call_log_method("debug", msg, *args, **kwargs)
 
     def log_info(self, msg, *args, **kwargs):
         """Call :meth:`logging.Logger.info`"""
-        self._logger.info(msg, *args, **kwargs)
+        self._call_log_method("info", msg, *args, **kwargs)
 
     def log_warning(self, msg, *args, **kwargs):
         """Call :meth:`logging.Logger.warning`"""
-        self._logger.warning(msg, *args, **kwargs)
+        self._call_log_method("warning", msg, *args, **kwargs)
 
     def log_error(self, msg, *args, **kwargs):
         """Call :meth:`logging.Logger.error`"""
-        self._logger.error(msg, *args, **kwargs)
+        self._call_log_method("error", msg, *args, **kwargs)
 
     def log_exception(self, msg, *args, **kwargs):
         """Call :meth:`logging.Logger.exception`"""
-        self._logger.exception(msg, *args, **kwargs)
+        self._call_log_method("exception", msg, *args, **kwargs)

malcolm/core/mapmeta.py

@@ -1,13 +1,14 @@
 from collections import OrderedDict
 
+from malcolm.core.notifier import Notifier
 from malcolm.core.serializable import Serializable
 
 OPTIONAL = object()
 REQUIRED = object()
 
 
-@Serializable.register("malcolm:core/MapMeta:1.0")
-class MapMeta(Serializable):
+@Serializable.register_subclass("malcolm:core/MapMeta:1.0")
+class MapMeta(Notifier):
     """An object containing a set of ScalarMeta objects"""
 
     def __init__(self, name, description):
@@ -84,7 +85,7 @@ def from_dict(cls, name, d):
         """
         map_meta = cls(name, d["description"])
         for ename, element in d["elements"].items():
-            attribute_meta = Serializable.from_dict(ename, element)
+            attribute_meta = Serializable.deserialize(ename, element)
             map_meta.add_element(attribute_meta, ename in d["required"])
         map_meta.tags = d["tags"]
         return map_meta

malcolm/core/meta.py

@@ -1,9 +1,9 @@
 from collections import OrderedDict
 
-from malcolm.core.serializable import Serializable
+from malcolm.core.notifier import Notifier
 
 
-class Meta(Serializable):
+class Meta(Notifier):
     """Meta base class"""
 
     def __init__(self, name, description, *args):

malcolm/core/method.py

@@ -2,13 +2,14 @@
 from inspect import getdoc
 
 from malcolm.core.serializable import Serializable
+from malcolm.core.notifier import Notifier
 from malcolm.core.mapmeta import MapMeta, OPTIONAL, REQUIRED
 from malcolm.core.response import Response
 from malcolm.core.map import Map
 
 
-@Serializable.register("malcolm:core/Method:1.0")
-class Method(Serializable):
+@Serializable.register_subclass("malcolm:core/Method:1.0")
+class Method(Notifier):
     """Exposes a function with metadata for arguments and return values"""
 
     def __init__(self, name, description):

malcolm/core/notifier.py

@@ -0,0 +1,29 @@
+from malcolm.core.loggable import Loggable
+from malcolm.core.serializable import Serializable
+
+class Notifier(Loggable, Serializable):
+    def __init__(self, name):
+        self.name = name
+        self.set_logger_name(name)
+        self.parent = None
+
+    def set_parent(self, parent):
+        """Sets the parent for changes to be propagated to"""
+        self.set_logger_name("%s.%s" % (parent.name, self.name))
+        self.parent = parent
+
+    def on_changed(self, change, notify=True):
+        """Propagate change to parent, adding self.name to paths.
+
+        Args:
+            change: [[path], value] pair for changed values
+        """
+        if self.parent is None:
+            return
+        path = change[0]
+        path.insert(0, self.name)
+        self.parent.on_changed(change, notify)
+
+    def set_endpoint(self, name, value, notify=True):
+        setattr(self, name, value)
+        self.on_changed([[name], value], notify)

malcolm/core/numberarraymeta.py

@@ -7,7 +7,7 @@
 from malcolm.compat import base_string
 
 
-@Serializable.register("malcolm:core/NumberArrayMeta:1.0")
+@Serializable.register_subclass("malcolm:core/NumberArrayMeta:1.0")
 class NumberArrayMeta(ScalarMeta):
     """Meta object containing information for an array of numerical values"""
 

malcolm/core/numbermeta.py

@@ -7,7 +7,7 @@
 from malcolm.compat import base_string
 
 
-@Serializable.register("malcolm:core/NumberMeta:1.0")
+@Serializable.register_subclass("malcolm:core/NumberMeta:1.0")
 class NumberMeta(ScalarMeta):
     """Meta object containing information for a numerical value"""
 

malcolm/core/pointgeneratormeta.py

@@ -3,7 +3,7 @@
 from scanpointgenerator import CompoundGenerator
 
 
-@Serializable.register("malcolm:core/PointGeneratorMeta:1.0")
+@Serializable.register_subclass("malcolm:core/PointGeneratorMeta:1.0")
 class PointGeneratorMeta(ScalarMeta):
 
     def __init__(self, name, description):

malcolm/core/process.py

@@ -29,7 +29,7 @@ class Process(Loggable):
     """Hosts a number of Blocks, distributing requests between them"""
 
     def __init__(self, name, sync_factory):
-        super(Process, self).__init__(logger_name=name)
+        self.set_logger_name(name)
         self.name = name
         self.sync_factory = sync_factory
         self.q = self.create_queue()